Package org.elasticsearch.search.aggregations

Class InternalAggregation

java.lang.Object
org.elasticsearch.search.aggregations.InternalAggregation
All Implemented Interfaces:
NamedWriteable, Writeable, Aggregation, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentFragment
Direct Known Subclasses:
InternalGeoBounds, InternalGeoCentroid, InternalMultiBucketAggregation, InternalMultiValueAggregation, InternalNumericMetricsAggregation, InternalScriptedMetric, InternalSingleBucketAggregation, InternalTopHits
public abstract class InternalAggregation extends Object implements Aggregation, NamedWriteable
An internal implementation of Aggregation. Serves as a base class for all aggregation implementations.

  • Field Details

  • Constructor Details

    • InternalAggregation

      protected InternalAggregation(String name, Map<String,Object> metadata)
      Constructs an aggregation result with a given name.
      Parameters:
      name - The name of the aggregation.

    • InternalAggregation

      protected InternalAggregation(StreamInput in) throws IOException
      Read from a stream.
      Throws:
      IOException

  • Method Details

    • writeTo

      public final void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • doWriteTo

      protected abstract void doWriteTo(StreamOutput out) throws IOException
      Throws:
      IOException

    • getName

      public String getName()
      Specified by:
      getName in interface Aggregation
      Returns:
      The name of this aggregation.

    • copyWithRewritenBuckets

      public InternalAggregation copyWithRewritenBuckets(Function<InternalAggregations,InternalAggregations> rewriter)
      Rewrite the sub-aggregations in the buckets in this aggregation. Returns a copy of this InternalAggregation with the rewritten buckets, or, if there aren't any modifications to the buckets then this method will return this aggregation. Either way, it doesn't modify this aggregation.

      Implementers of this should call the rewriter once per bucket with its InternalAggregations. The rewriter should return null if it doen't have any rewriting to do or it should return a new InternalAggregations to make changs.

      The default implementation throws an exception because most aggregations don't have buckets in them. It should be overridden by aggregations that contain buckets. Implementers should respect the description above.

    • forEachBucket

      public void forEachBucket(Consumer<InternalAggregations> consumer)
      Run a Consumer over all buckets in this aggregation.

    • reducePipelines

      public InternalAggregation reducePipelines(InternalAggregation reducedAggs, AggregationReduceContext reduceContext, PipelineAggregator.PipelineTree pipelinesForThisAgg)
      Creates the output from all pipeline aggs that this aggregation is associated with. Should only be called after all aggregations have been fully reduced

    • reduce

      public abstract InternalAggregation reduce(List<InternalAggregation> aggregations, AggregationReduceContext reduceContext)
      Reduces the given aggregations to a single one and returns it. In most cases, the assumption will be the all given aggregations are of the same type (the same type as this aggregation). For best efficiency, when implementing, try reusing an existing instance (typically the first in the given list) to save on redundant object construction.
      See Also:

    • finalizeSampling

      public InternalAggregation finalizeSampling(SamplingContext samplingContext)
      Called by the parent sampling context. Should only ever be called once as some aggregations scale their internal values
      Parameters:
      samplingContext - the current sampling context
      Returns:
      new aggregation with the sampling context applied, could be the same aggregation instance if nothing needs to be done

    • mustReduceOnSingleInternalAgg

      protected abstract boolean mustReduceOnSingleInternalAgg()
      Signal the framework if the reduce(List, AggregationReduceContext) phase needs to be called when there is only one InternalAggregation.

    • isMapped

      public boolean isMapped()
      Return true if this aggregation is mapped, and can lead a reduction. If this agg returns false, it should return itself if asked to lead a reduction

    • getProperty

      public Object getProperty(String path)
      Get the value of specified path in the aggregation.
      Parameters:
      path - the path to the property in the aggregation tree
      Returns:
      the value of the property

    • getProperty

      public abstract Object getProperty(List<String> path)

    • readSize

      protected static int readSize(StreamInput in) throws IOException
      Read a size under the assumption that a value of 0 means unlimited.
      Throws:
      IOException

    • writeSize

      protected static void writeSize(int size, StreamOutput out) throws IOException
      Write a size under the assumption that a value of 0 means unlimited.
      Throws:
      IOException

    • getMetadata

      public Map<String,Object> getMetadata()
      Description copied from interface: Aggregation
      Get the optional byte array metadata that was set on the aggregation
      Specified by:
      getMetadata in interface Aggregation

    • getType

      public String getType()
      Specified by:
      getType in interface Aggregation
      Returns:
      a string representing the type of the aggregation. This type is added to the aggregation name in the response, so that it can later be used by clients to determine type of the aggregation and parse it into the proper object.

    • toXContent

      public final org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException

    • doXContentBody

      public abstract org.elasticsearch.xcontent.XContentBuilder doXContentBody(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Throws:
      IOException

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • sortValue

      public SortValue sortValue(String key)
      Get value to use when sorting by this aggregation.

    • sortValue

      public SortValue sortValue(AggregationPath.PathElement head, Iterator<AggregationPath.PathElement> tail)
      Get value to use when sorting by a descendant of this aggregation.