Module org.elasticsearch.compute

Package org.elasticsearch.compute.lucene.query

Class LuceneOperator

java.lang.Object

org.elasticsearch.compute.operator.SourceOperator

org.elasticsearch.compute.lucene.query.LuceneOperator

All Implemented Interfaces:

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

Direct Known Subclasses:

LuceneCountOperator, LuceneSourceOperator, LuceneTopNSourceOperator

public abstract class LuceneOperator
extends SourceOperator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LuceneOperator.Factory
static class	LuceneOperator.Status

Nested classes/interfaces inherited from class org.elasticsearch.compute.operator.SourceOperator

SourceOperator.ShardLoad, SourceOperator.SourceOperatorFactory

Nested classes/interfaces inherited from interface org.elasticsearch.compute.operator.Operator

Operator.OperatorFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected final BlockFactory	blockFactory
protected LuceneSlice	currentSlice
static final int	NO_LIMIT
protected final IndexedByShardId<? extends org.elasticsearch.core.RefCounted>	refCounteds
static final int	SMALL_INDEX_BOUNDARY	DataPartitioning.AUTO resolves to LuceneSliceQueue.PartitioningStrategy.SHARD for indices with fewer than this many documents.

Fields inherited from interface org.elasticsearch.compute.operator.Operator

MIN_TARGET_PAGE_SIZE, NOT_BLOCKED, TARGET_PAGE_SIZE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LuceneOperator(IndexedByShardId<? extends org.elasticsearch.core.RefCounted> refCounteds, BlockFactory blockFactory, int maxPageSize, LuceneSliceQueue sliceQueue)

Method Summary

Modifier and Type	Method	Description
protected void	additionalClose()
final void	close()	notifies the operator that it won't be used anymore (i.e.
protected abstract void	describe(StringBuilder sb)
protected abstract Page	getCheckedOutput()
final Page	getOutput()	returns non-null if output page available.
protected LuceneSliceQueue	getSliceQueue()
IsBlockedResult	isBlocked()	An operator can be blocked on some action (e.g.
protected List<SourceOperator.ShardLoad>	shardLoadDelta(long now)	Returns a snapshot of shard load accumulated since the previous invocation.
Operator.Status	status()	The status of the operator.
String	toString()

Methods inherited from class org.elasticsearch.compute.operator.SourceOperator

addInput, canProduceMoreDataWithoutExtraInput, needsInput

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.compute.operator.Operator

finish, isFinished

Field Details

NO_LIMIT

public static final int NO_LIMIT

See Also:

• Constant Field Values

SMALL_INDEX_BOUNDARY

public static final int SMALL_INDEX_BOUNDARY

DataPartitioning.AUTO resolves to LuceneSliceQueue.PartitioningStrategy.SHARD for indices with fewer than this many documents.

See Also:

• Constant Field Values

refCounteds

protected final IndexedByShardId<? extends org.elasticsearch.core.RefCounted> refCounteds

blockFactory

protected final BlockFactory blockFactory

currentSlice

protected LuceneSlice currentSlice

Constructor Details

LuceneOperator

protected LuceneOperator(IndexedByShardId<? extends org.elasticsearch.core.RefCounted> refCounteds,
 BlockFactory blockFactory,
 int maxPageSize,
 LuceneSliceQueue sliceQueue)

Method Details

getOutput

public final Page getOutput()

Description copied from interface: Operator

returns non-null if output page available. Only called when isFinished() == false

getCheckedOutput

protected abstract Page getCheckedOutput()
                                  throws IOException

Throws:

IOException

close

public final void close()

Description copied from interface: Operator

notifies the operator that it won't be used anymore (i.e. none of the other methods called), and its resources can be cleaned up

additionalClose

protected void additionalClose()

getSliceQueue

protected LuceneSliceQueue getSliceQueue()

shardLoadDelta

protected List<SourceOperator.ShardLoad> shardLoadDelta(long now)

Description copied from class: SourceOperator

Returns a snapshot of shard load accumulated since the previous invocation.

This method is meant to be overridden by SourceOperator implementations that can attribute produced pages to shards or indices.

The snapshot represents a delta: implementations must reset their internal counters after the snapshot is taken so that each invocation reports only the load observed since the last call.

Source operators that do not operate on shards or indices can ignore this mechanism and rely on the default implementation, which returns an empty list.

Overrides:

shardLoadDelta in class SourceOperator

Returns:

list of per-shard load since the last call

isBlocked

public IsBlockedResult isBlocked()

Description copied from interface: Operator

An operator can be blocked on some action (e.g. waiting for some resources to become available). If so, it returns a future that completes when the operator becomes unblocked. If the operator is not blocked, this method returns Operator.NOT_BLOCKED which is an already completed future.

toString

public String toString()

Overrides:

toString in class Object

describe

protected abstract void describe(StringBuilder sb)

status

public Operator.Status status()

Description copied from interface: Operator

The status of the operator.