Package org.elasticsearch.search.aggregations.support

Class ArrayValuesSourceAggregationBuilder<VS extends org.elasticsearch.search.aggregations.support.ValuesSource,AB extends ArrayValuesSourceAggregationBuilder<VS,AB>>

  • All Implemented Interfaces:
    org.elasticsearch.common.io.stream.NamedWriteable, org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment, org.elasticsearch.search.aggregations.BaseAggregationBuilder
    Direct Known Subclasses:
    ArrayValuesSourceAggregationBuilder.LeafOnly
    public abstract class ArrayValuesSourceAggregationBuilder<VS extends org.elasticsearch.search.aggregations.support.ValuesSource,AB extends ArrayValuesSourceAggregationBuilder<VS,AB>>
extends org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB>

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ArrayValuesSourceAggregationBuilder.LeafOnly<VS extends org.elasticsearch.search.aggregations.support.ValuesSource,AB extends ArrayValuesSourceAggregationBuilder<VS,AB>>  

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

        org.elasticsearch.search.aggregations.AggregationBuilder.CommonFields

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

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

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

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

    • Field Summary

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

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

        metaData

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

        factoriesBuilder, name

      • Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

        EMPTY_PARAMS

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected ArrayValuesSourceAggregationBuilder​(java.lang.String name, org.elasticsearch.search.aggregations.support.ValuesSourceType valuesSourceType, org.elasticsearch.search.aggregations.support.ValueType targetValueType)  
      protected ArrayValuesSourceAggregationBuilder​(org.elasticsearch.common.io.stream.StreamInput in, org.elasticsearch.search.aggregations.support.ValuesSourceType valuesSourceType)  
      protected ArrayValuesSourceAggregationBuilder​(org.elasticsearch.common.io.stream.StreamInput in, org.elasticsearch.search.aggregations.support.ValuesSourceType valuesSourceType, org.elasticsearch.search.aggregations.support.ValueType targetValueType)  
      protected ArrayValuesSourceAggregationBuilder​(ArrayValuesSourceAggregationBuilder<VS,AB> clone, org.elasticsearch.search.aggregations.AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      org.elasticsearch.search.aggregations.support.ValuesSourceConfig<VS> config​(org.elasticsearch.search.internal.SearchContext context, java.lang.String field, org.elasticsearch.script.Script script)  
      protected ArrayValuesSourceAggregatorFactory<VS,?> doBuild​(org.elasticsearch.search.internal.SearchContext context, org.elasticsearch.search.aggregations.AggregatorFactory<?> parent, org.elasticsearch.search.aggregations.AggregatorFactories.Builder subFactoriesBuilder)  
      protected boolean doEquals​(java.lang.Object obj)  
      protected int doHashCode()  
      protected void doWriteTo​(org.elasticsearch.common.io.stream.StreamOutput out)  
      protected abstract org.elasticsearch.common.xcontent.XContentBuilder doXContentBody​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
      java.util.List<java.lang.String> fields()
      Gets the field to use for this aggregation.
      AB fields​(java.util.List<java.lang.String> fields)
      Sets the field to use for this aggregation.
      java.lang.String format()
      Gets the format to use for the output of the aggregation.
      AB format​(java.lang.String format)
      Sets the format to use for the output of the aggregation.
      protected abstract ArrayValuesSourceAggregatorFactory<VS,?> innerBuild​(org.elasticsearch.search.internal.SearchContext context, java.util.Map<java.lang.String,org.elasticsearch.search.aggregations.support.ValuesSourceConfig<VS>> configs, org.elasticsearch.search.aggregations.AggregatorFactory<?> parent, org.elasticsearch.search.aggregations.AggregatorFactories.Builder subFactoriesBuilder)  
      protected abstract boolean innerEquals​(java.lang.Object obj)  
      protected abstract int innerHashCode()  
      protected abstract void innerWriteTo​(org.elasticsearch.common.io.stream.StreamOutput out)
      Write subclass' state to the stream
      org.elasticsearch.common.xcontent.XContentBuilder internalXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
      java.util.Map<java.lang.String,java.lang.Object> missingMap()
      Gets the value to use when the aggregation finds a missing value in a document
      AB missingMap​(java.util.Map<java.lang.String,java.lang.Object> missingMap)
      Sets the value to use when the aggregation finds a missing value in a document
      protected java.util.Map<java.lang.String,org.elasticsearch.search.aggregations.support.ValuesSourceConfig<VS>> resolveConfig​(org.elasticsearch.search.internal.SearchContext context)  
      protected boolean serializeTargetValueType()
      Should this builder serialize its targetValueType? Defaults to false.
      org.elasticsearch.search.aggregations.support.ValueType valueType()
      Gets the ValueType for the value produced by this aggregation
      AB valueType​(org.elasticsearch.search.aggregations.support.ValueType valueType)
      Sets the ValueType for the value produced by this aggregation

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

        build, equals, getMetaData, getWriteableName, hashCode, setMetaData, subAggregation, subAggregation, subAggregations, toXContent, writeTo

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

        doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, shallowCopy, toString

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

        getType

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

        isFragment

    • Field Detail

      • MULTIVALUE_MODE_FIELD

        public static final org.elasticsearch.common.ParseField MULTIVALUE_MODE_FIELD

    • Constructor Detail

      • ArrayValuesSourceAggregationBuilder

        protected ArrayValuesSourceAggregationBuilder​(java.lang.String name,
                                              org.elasticsearch.search.aggregations.support.ValuesSourceType valuesSourceType,
                                              org.elasticsearch.search.aggregations.support.ValueType targetValueType)

      • ArrayValuesSourceAggregationBuilder

        protected ArrayValuesSourceAggregationBuilder​(ArrayValuesSourceAggregationBuilder<VS,AB> clone,
                                              org.elasticsearch.search.aggregations.AggregatorFactories.Builder factoriesBuilder,
                                              java.util.Map<java.lang.String,java.lang.Object> metaData)

      • ArrayValuesSourceAggregationBuilder

        protected ArrayValuesSourceAggregationBuilder​(org.elasticsearch.common.io.stream.StreamInput in,
                                              org.elasticsearch.search.aggregations.support.ValuesSourceType valuesSourceType,
                                              org.elasticsearch.search.aggregations.support.ValueType targetValueType)
                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • ArrayValuesSourceAggregationBuilder

        protected ArrayValuesSourceAggregationBuilder​(org.elasticsearch.common.io.stream.StreamInput in,
                                              org.elasticsearch.search.aggregations.support.ValuesSourceType valuesSourceType)
                                       throws java.io.IOException
        Throws:
        java.io.IOException

    • Method Detail

      • doWriteTo

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

      • innerWriteTo

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

      • fields

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

      • fields

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

      • valueType

        public AB valueType​(org.elasticsearch.search.aggregations.support.ValueType valueType)
        Sets the ValueType for the value produced by this aggregation

      • valueType

        public org.elasticsearch.search.aggregations.support.ValueType valueType()
        Gets the ValueType for the value produced by this aggregation

      • format

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

      • format

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

      • missingMap

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

      • missingMap

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

      • doBuild

        protected final ArrayValuesSourceAggregatorFactory<VS,?> doBuild​(org.elasticsearch.search.internal.SearchContext context,
                                                                 org.elasticsearch.search.aggregations.AggregatorFactory<?> parent,
                                                                 org.elasticsearch.search.aggregations.AggregatorFactories.Builder subFactoriesBuilder)
                                                          throws java.io.IOException
        Specified by:
        doBuild in class org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB extends ArrayValuesSourceAggregationBuilder<VS,AB>>
        Throws:
        java.io.IOException

      • resolveConfig

        protected java.util.Map<java.lang.String,org.elasticsearch.search.aggregations.support.ValuesSourceConfig<VS>> resolveConfig​(org.elasticsearch.search.internal.SearchContext context)

      • innerBuild

        protected abstract ArrayValuesSourceAggregatorFactory<VS,?> innerBuild​(org.elasticsearch.search.internal.SearchContext context,
                                                                       java.util.Map<java.lang.String,org.elasticsearch.search.aggregations.support.ValuesSourceConfig<VS>> configs,
                                                                       org.elasticsearch.search.aggregations.AggregatorFactory<?> parent,
                                                                       org.elasticsearch.search.aggregations.AggregatorFactories.Builder subFactoriesBuilder)
                                                                throws java.io.IOException
        Throws:
        java.io.IOException

      • config

        public org.elasticsearch.search.aggregations.support.ValuesSourceConfig<VS> config​(org.elasticsearch.search.internal.SearchContext context,
                                                                                   java.lang.String field,
                                                                                   org.elasticsearch.script.Script script)

      • serializeTargetValueType

        protected boolean serializeTargetValueType()
        Should this builder serialize its targetValueType? Defaults to false. All subclasses that override this to true should use the three argument read constructor rather than the four argument version.

      • internalXContent

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

      • doXContentBody

        protected abstract org.elasticsearch.common.xcontent.XContentBuilder doXContentBody​(org.elasticsearch.common.xcontent.XContentBuilder builder,
                                                                                    org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                                             throws java.io.IOException
        Throws:
        java.io.IOException

      • innerHashCode

        protected abstract int innerHashCode()

      • doEquals

        protected final boolean doEquals​(java.lang.Object obj)
        Specified by:
        doEquals in class org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB extends ArrayValuesSourceAggregationBuilder<VS,AB>>

      • innerEquals

        protected abstract boolean innerEquals​(java.lang.Object obj)