Package org.elasticsearch.search.aggregations.support

Class ValuesSource

java.lang.Object
org.elasticsearch.search.aggregations.support.ValuesSource
Direct Known Subclasses:
ValuesSource.Bytes, ValuesSource.GeoPoint, ValuesSource.Numeric, ValuesSource.Range
public abstract class ValuesSource
extends java.lang.Object

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  ValuesSource.Bytes  
    static class  ValuesSource.GeoPoint  
    static class  ValuesSource.Numeric  
    static class  ValuesSource.Range  

  • Constructor Summary

    Constructors 
    Constructor Description
    ValuesSource()  

  • Method Summary

    Modifier and Type Method Description
    abstract SortedBinaryDocValues bytesValues​(org.apache.lucene.index.LeafReaderContext context)
    Get the current ValuesSource.Bytes.WithScript.BytesValues.
    abstract DocValueBits docsWithValue​(org.apache.lucene.index.LeafReaderContext context)  
    boolean hasGlobalOrdinals()
    Check if this values source supports using global ordinals
    boolean needsScores()
    Whether this values source needs scores.
    abstract java.util.function.Function<Rounding,​Rounding.Prepared> roundingPreparer​(org.apache.lucene.index.IndexReader reader)
    Build a function prepares rounding values to be called many times.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • bytesValues

      public abstract SortedBinaryDocValues bytesValues​(org.apache.lucene.index.LeafReaderContext context) throws java.io.IOException
      Get the current ValuesSource.Bytes.WithScript.BytesValues.
      Throws:
      java.io.IOException

    • docsWithValue

      public abstract DocValueBits docsWithValue​(org.apache.lucene.index.LeafReaderContext context) throws java.io.IOException
      Throws:
      java.io.IOException

    • needsScores

      public boolean needsScores()
      Whether this values source needs scores.

    • roundingPreparer

      public abstract java.util.function.Function<Rounding,​Rounding.Prepared> roundingPreparer​(org.apache.lucene.index.IndexReader reader) throws java.io.IOException
      Build a function prepares rounding values to be called many times.

      This returns a Function because auto date histogram will need to call it many times over the course of running the aggregation.

      Throws:
      java.io.IOException

    • hasGlobalOrdinals

      public boolean hasGlobalOrdinals()
      Check if this values source supports using global ordinals