Module org.elasticsearch.compute

Package org.elasticsearch.compute.operator

Class AbstractPageMappingOperator

java.lang.Object

org.elasticsearch.compute.operator.AbstractPageMappingOperator

All Implemented Interfaces:

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

Direct Known Subclasses:

ColumnExtractOperator, DistinctByOperator, EvalOperator, FilterOperator, ProjectOperator, RrfScoreEvalOperator, ScoreOperator, StringExtractOperator

public abstract class AbstractPageMappingOperator
extends Object
implements Operator

Abstract superclass for operators that accept a single page, modify it, and then return it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractPageMappingOperator.Status

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

Operator.OperatorFactory

Field Summary

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

MIN_TARGET_PAGE_SIZE, NOT_BLOCKED, TARGET_PAGE_SIZE

Constructor Summary

Constructors

Constructor	Description
AbstractPageMappingOperator()

Method Summary

Modifier and Type	Method	Description
final void	addInput(Page page)	adds an input page to the operator.
boolean	canProduceMoreDataWithoutExtraInput()	Returns true if the operator can produce more output pages without requiring additional input pages.
void	close()	notifies the operator that it won't be used anymore (i.e.
final void	finish()	notifies the operator that it won't receive any more input pages
final Page	getOutput()	returns non-null if output page available.
final boolean	isFinished()	whether the operator has finished processing all input pages and made the corresponding output pages available
final boolean	needsInput()	whether the given operator can accept more input pages
protected abstract Page	process(Page page)
final AbstractPageMappingOperator.Status	status()	The status of the operator.
protected AbstractPageMappingOperator.Status	status(long processNanos, int pagesProcessed, long rowsReceived, long rowsEmitted)
abstract String	toString()

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

isBlocked

Constructor Details

AbstractPageMappingOperator

public AbstractPageMappingOperator()

Method Details

process

protected abstract Page process(Page page)

toString

public abstract String toString()

Overrides:

toString in class Object

needsInput

public final boolean needsInput()

Description copied from interface: Operator

whether the given operator can accept more input pages

Specified by:

needsInput in interface Operator

addInput

public final void addInput(Page page)

Description copied from interface: Operator

adds an input page to the operator. only called when needsInput() == true and isFinished() == false

Specified by:

addInput in interface Operator

finish

public final void finish()

Description copied from interface: Operator

notifies the operator that it won't receive any more input pages

Specified by:

finish in interface Operator

isFinished

public final boolean isFinished()

Description copied from interface: Operator

whether the operator has finished processing all input pages and made the corresponding output pages available

Specified by:

isFinished in interface Operator

canProduceMoreDataWithoutExtraInput

public boolean canProduceMoreDataWithoutExtraInput()

Description copied from interface: Operator

Returns true if the operator can produce more output pages without requiring additional input pages. This is useful for operators that buffer data or have internal state that can produce multiple output pages.

Operators that do not buffer data should return false - they cannot produce pages out of thin air. Examples of operators that may return true:

• Operators with internal buffers (e.g., AsyncOperator with pending results)
• Operators processing a single input page into multiple output pages
• Aggregation operators that buffer partial results

Specified by:

canProduceMoreDataWithoutExtraInput in interface Operator

Returns:

true if the operator has buffered data that can produce output, false otherwise

getOutput

public final Page getOutput()

Description copied from interface: Operator

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

Specified by:

getOutput in interface Operator

status

public final AbstractPageMappingOperator.Status status()

Description copied from interface: Operator

The status of the operator.

Specified by:

status in interface Operator

status

protected AbstractPageMappingOperator.Status status(long processNanos,
 int pagesProcessed,
 long rowsReceived,
 long rowsEmitted)

close

public 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

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Operator

Specified by:

close in interface org.elasticsearch.core.Releasable