Module org.elasticsearch.compute

Package org.elasticsearch.compute.lucene.query

Class LuceneQueryExpressionEvaluator

java.lang.Object

org.elasticsearch.compute.lucene.query.LuceneQueryEvaluator<BooleanBlock.Builder>

org.elasticsearch.compute.lucene.query.LuceneQueryExpressionEvaluator

All Implemented Interfaces:

Closeable, AutoCloseable, ExpressionEvaluator, org.elasticsearch.core.Releasable

public class LuceneQueryExpressionEvaluator
extends LuceneQueryEvaluator<BooleanBlock.Builder>
implements ExpressionEvaluator

ExpressionEvaluator to run a Lucene Query during the compute engine's normal execution, yielding matches/does not match into a BooleanVector.

See Also:

• LuceneQueryScoreEvaluator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	LuceneQueryExpressionEvaluator.Factory

Nested classes/interfaces inherited from class org.elasticsearch.compute.lucene.query.LuceneQueryEvaluator

LuceneQueryEvaluator.ShardConfig

Field Summary

Fields inherited from class org.elasticsearch.compute.lucene.query.LuceneQueryEvaluator

shards

Method Summary

Modifier and Type	Method	Description
protected void	appendMatch(BooleanBlock.Builder builder, org.apache.lucene.search.Scorable scorer)	Appends a matching result to a builder created by @link createVectorBuilder}
protected void	appendNoMatch(BooleanBlock.Builder builder)	Appends a non matching result to a builder created by @link createVectorBuilder}
long	baseRamBytesUsed()	Heap used by the evaluator excluding any memory that's separately tracked like the BreakingBytesRefBuilder used for string concat.
protected BooleanBlock.Builder	createBlockBuilder(BlockFactory blockFactory, int size)	Creates the corresponding vector builder to store the results of evaluating the query
protected Block	createNoMatchBlock(BlockFactory blockFactory, int size)	Creates a vector where all positions correspond to elements that don't match the query
Block	eval(Page page)	Evaluate the expression.
protected org.apache.lucene.search.ScoreMode	scoreMode()	Returns the score mode to use on searches

Methods inherited from class org.elasticsearch.compute.lucene.query.LuceneQueryEvaluator

close, executeQuery

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.core.Releasable

close

Method Details

eval

public Block eval(Page page)

Description copied from interface: ExpressionEvaluator

Evaluate the expression.

Specified by:

eval in interface ExpressionEvaluator

Returns:

the returned Block has its own reference and the caller is responsible for releasing it.

scoreMode

protected org.apache.lucene.search.ScoreMode scoreMode()

Description copied from class: LuceneQueryEvaluator

Returns the score mode to use on searches

Specified by:

scoreMode in class LuceneQueryEvaluator<BooleanBlock.Builder>

createNoMatchBlock

protected Block createNoMatchBlock(BlockFactory blockFactory,
 int size)

Description copied from class: LuceneQueryEvaluator

Creates a vector where all positions correspond to elements that don't match the query

Specified by:

createNoMatchBlock in class LuceneQueryEvaluator<BooleanBlock.Builder>

createBlockBuilder

protected BooleanBlock.Builder createBlockBuilder(BlockFactory blockFactory,
 int size)

Description copied from class: LuceneQueryEvaluator

Creates the corresponding vector builder to store the results of evaluating the query

Specified by:

createBlockBuilder in class LuceneQueryEvaluator<BooleanBlock.Builder>

appendNoMatch

protected void appendNoMatch(BooleanBlock.Builder builder)

Description copied from class: LuceneQueryEvaluator

Appends a non matching result to a builder created by @link createVectorBuilder}

Specified by:

appendNoMatch in class LuceneQueryEvaluator<BooleanBlock.Builder>

appendMatch

protected void appendMatch(BooleanBlock.Builder builder,
 org.apache.lucene.search.Scorable scorer)
                    throws IOException

Description copied from class: LuceneQueryEvaluator

Appends a matching result to a builder created by @link createVectorBuilder}

Specified by:

appendMatch in class LuceneQueryEvaluator<BooleanBlock.Builder>

Throws:

IOException

baseRamBytesUsed

public long baseRamBytesUsed()

Description copied from interface: ExpressionEvaluator

Heap used by the evaluator excluding any memory that's separately tracked like the BreakingBytesRefBuilder used for string concat.

Specified by:

baseRamBytesUsed in interface ExpressionEvaluator