Package org.elasticsearch.search.aggregations.matrix

Class ArrayValuesSourceAggregationBuilder<AB extends ArrayValuesSourceAggregationBuilder<AB>>

java.lang.Object
org.elasticsearch.search.aggregations.AggregationBuilder
org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB>
org.elasticsearch.search.aggregations.matrix.ArrayValuesSourceAggregationBuilder<AB>
All Implemented Interfaces:
org.elasticsearch.common.io.stream.NamedWriteable, org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.index.query.Rewriteable<org.elasticsearch.search.aggregations.AggregationBuilder>, org.elasticsearch.search.aggregations.BaseAggregationBuilder, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentFragment
Direct Known Subclasses:
ArrayValuesSourceAggregationBuilder.LeafOnly
public abstract class ArrayValuesSourceAggregationBuilder<AB extends ArrayValuesSourceAggregationBuilder<AB>> extends org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB>

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    ArrayValuesSourceAggregationBuilder.LeafOnly<AB extends ArrayValuesSourceAggregationBuilder<AB>>
     

    Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

    org.elasticsearch.search.aggregations.AggregationBuilder.BucketCardinality, org.elasticsearch.search.aggregations.AggregationBuilder.CommonFields

    Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    org.elasticsearch.common.io.stream.Writeable.Reader<V extends Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends Object>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.elasticsearch.xcontent.ParseField
    MULTIVALUE_MODE_FIELD
     

    Fields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

    metadata

    Fields inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

    DEFAULT_PREALLOCATION, factoriesBuilder, name

    Fields inherited from interface org.elasticsearch.index.query.Rewriteable

    MAX_REWRITE_ROUNDS

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    ArrayValuesSourceAggregationBuilder(String name)
     
    protected
    ArrayValuesSourceAggregationBuilder(org.elasticsearch.common.io.stream.StreamInput in)
     
    protected
    ArrayValuesSourceAggregationBuilder(ArrayValuesSourceAggregationBuilder<AB> clone, org.elasticsearch.search.aggregations.AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final ArrayValuesSourceAggregatorFactory
    doBuild(org.elasticsearch.search.aggregations.support.AggregationContext context, org.elasticsearch.search.aggregations.AggregatorFactory parent, org.elasticsearch.search.aggregations.AggregatorFactories.Builder subFactoriesBuilder)
     
    protected final void
    doWriteTo(org.elasticsearch.common.io.stream.StreamOutput out)
     
    protected abstract org.elasticsearch.xcontent.XContentBuilder
    doXContentBody(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     
    boolean
    equals(Object obj)
     
    List<String>
    fields()
    Gets the field to use for this aggregation.
    AB
    fields(List<String> fields)
    Sets the field to use for this aggregation.
    String
    format()
    Gets the format to use for the output of the aggregation.
    AB
    format(String format)
    Sets the format to use for the output of the aggregation.
    int
    hashCode()
     
    protected abstract ArrayValuesSourceAggregatorFactory
    innerBuild(org.elasticsearch.search.aggregations.support.AggregationContext context, Map<String,org.elasticsearch.search.aggregations.support.ValuesSourceConfig> configs, org.elasticsearch.search.aggregations.AggregatorFactory parent, org.elasticsearch.search.aggregations.AggregatorFactories.Builder subFactoriesBuilder)
     
    protected abstract void
    innerWriteTo(org.elasticsearch.common.io.stream.StreamOutput out)
    Write subclass' state to the stream
    final org.elasticsearch.xcontent.XContentBuilder
    internalXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     
    Map<String,Object>
    missingMap()
    Gets the value to use when the aggregation finds a missing value in a document
    AB
    missingMap(Map<String,Object> missingMap)
    Sets the value to use when the aggregation finds a missing value in a document
    protected Map<String,org.elasticsearch.search.aggregations.support.ValuesSourceConfig>
    resolveConfig(org.elasticsearch.search.aggregations.support.AggregationContext context)
     

    Methods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

    build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeTo

    Methods inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

    bucketCardinality, buildPipelineTree, bytesToPreallocate, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getSubAggregations, rewrite, shallowCopy, toString

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.elasticsearch.search.aggregations.BaseAggregationBuilder

    getType

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

    isFragment

  • Field Details

    • MULTIVALUE_MODE_FIELD

      public static final org.elasticsearch.xcontent.ParseField MULTIVALUE_MODE_FIELD

  • Constructor Details

    • ArrayValuesSourceAggregationBuilder

      protected ArrayValuesSourceAggregationBuilder(String name)

    • ArrayValuesSourceAggregationBuilder

      protected ArrayValuesSourceAggregationBuilder(ArrayValuesSourceAggregationBuilder<AB> clone, org.elasticsearch.search.aggregations.AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

    • ArrayValuesSourceAggregationBuilder

      protected ArrayValuesSourceAggregationBuilder(org.elasticsearch.common.io.stream.StreamInput in) throws IOException
      Throws:
      IOException

  • Method Details

    • doWriteTo

      protected final void doWriteTo(org.elasticsearch.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      doWriteTo in class org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB extends ArrayValuesSourceAggregationBuilder<AB>>
      Throws:
      IOException

    • innerWriteTo

      protected abstract void innerWriteTo(org.elasticsearch.common.io.stream.StreamOutput out) throws IOException
      Write subclass' state to the stream
      Throws:
      IOException

    • fields

      public AB fields(List<String> fields)
      Sets the field to use for this aggregation.

    • fields

      public List<String> fields()
      Gets the field to use for this aggregation.

    • format

      public AB format(String format)
      Sets the format to use for the output of the aggregation.

    • format

      public String format()
      Gets the format to use for the output of the aggregation.

    • missingMap

      public AB missingMap(Map<String,Object> missingMap)
      Sets the value to use when the aggregation finds a missing value in a document

    • missingMap

      public Map<String,Object> missingMap()
      Gets the value to use when the aggregation finds a missing value in a document

    • doBuild

      protected final ArrayValuesSourceAggregatorFactory doBuild(org.elasticsearch.search.aggregations.support.AggregationContext context, org.elasticsearch.search.aggregations.AggregatorFactory parent, org.elasticsearch.search.aggregations.AggregatorFactories.Builder subFactoriesBuilder) throws IOException
      Specified by:
      doBuild in class org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB extends ArrayValuesSourceAggregationBuilder<AB>>
      Throws:
      IOException

    • resolveConfig

      protected Map<String,org.elasticsearch.search.aggregations.support.ValuesSourceConfig> resolveConfig(org.elasticsearch.search.aggregations.support.AggregationContext context)

    • innerBuild

      protected abstract ArrayValuesSourceAggregatorFactory innerBuild(org.elasticsearch.search.aggregations.support.AggregationContext context, Map<String,org.elasticsearch.search.aggregations.support.ValuesSourceConfig> configs, org.elasticsearch.search.aggregations.AggregatorFactory parent, org.elasticsearch.search.aggregations.AggregatorFactories.Builder subFactoriesBuilder) throws IOException
      Throws:
      IOException

    • internalXContent

      public final org.elasticsearch.xcontent.XContentBuilder internalXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      internalXContent in class org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB extends ArrayValuesSourceAggregationBuilder<AB>>
      Throws:
      IOException

    • doXContentBody

      protected 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 org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB extends ArrayValuesSourceAggregationBuilder<AB>>

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB extends ArrayValuesSourceAggregationBuilder<AB>>