Class AbstractPageMappingOperator

java.lang.Object
org.elasticsearch.compute.operator.AbstractPageMappingOperator
All Implemented Interfaces:
Closeable, AutoCloseable, Operator, org.elasticsearch.core.Releasable
Direct Known Subclasses:
ColumnExtractOperator, EvalOperator, FilterOperator, ProjectOperator, RrfScoreEvalOperator, ScoreOperator, StringExtractOperator, TimeSeriesExtractFieldOperator

public abstract class AbstractPageMappingOperator extends Object implements Operator
Abstract superclass for operators that accept a single page, modify it, and then return it.
  • 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
    • 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