Class ArrayValuesSourceParser<VS extends org.elasticsearch.search.aggregations.support.ValuesSource>
java.lang.Object
org.elasticsearch.search.aggregations.support.ArrayValuesSourceParser<VS>
- All Implemented Interfaces:
org.elasticsearch.search.aggregations.Aggregator.Parser
- Direct Known Subclasses:
ArrayValuesSourceParser.BytesValuesSourceParser
,ArrayValuesSourceParser.GeoPointValuesSourceParser
,ArrayValuesSourceParser.NumericValuesSourceParser
public abstract class ArrayValuesSourceParser<VS extends org.elasticsearch.search.aggregations.support.ValuesSource>
extends java.lang.Object
implements org.elasticsearch.search.aggregations.Aggregator.Parser
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ArrayValuesSourceParser.BytesValuesSourceParser
static class
ArrayValuesSourceParser.GeoPointValuesSourceParser
static class
ArrayValuesSourceParser.NumericValuesSourceParser
-
Method Summary
Modifier and Type Method Description protected abstract ArrayValuesSourceAggregationBuilder<?>
createFactory(java.lang.String aggregationName, org.elasticsearch.search.aggregations.support.ValuesSourceType valuesSourceType, org.elasticsearch.search.aggregations.support.ValueType targetValueType, java.util.Map<org.elasticsearch.common.ParseField,java.lang.Object> otherOptions)
Creates aValuesSourceAggregationBuilder
from the information gathered by the subclass.ArrayValuesSourceAggregationBuilder<?>
parse(java.lang.String aggregationName, org.elasticsearch.common.xcontent.XContentParser parser)
protected abstract boolean
token(java.lang.String aggregationName, java.lang.String currentFieldName, org.elasticsearch.common.xcontent.XContentParser.Token token, org.elasticsearch.common.xcontent.XContentParser parser, java.util.Map<org.elasticsearch.common.ParseField,java.lang.Object> otherOptions)
Allows subclasses ofArrayValuesSourceParser
to parse extra parameters and store them in aMap
which will later be passed tocreateFactory(String, ValuesSourceType, ValueType, Map)
.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Method Details
-
parse
public final ArrayValuesSourceAggregationBuilder<?> parse(java.lang.String aggregationName, org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException- Specified by:
parse
in interfaceorg.elasticsearch.search.aggregations.Aggregator.Parser
- Throws:
java.io.IOException
-
createFactory
protected abstract ArrayValuesSourceAggregationBuilder<?> createFactory(java.lang.String aggregationName, org.elasticsearch.search.aggregations.support.ValuesSourceType valuesSourceType, org.elasticsearch.search.aggregations.support.ValueType targetValueType, java.util.Map<org.elasticsearch.common.ParseField,java.lang.Object> otherOptions)Creates aValuesSourceAggregationBuilder
from the information gathered by the subclass. Options parsed inArrayValuesSourceParser
itself will be added to the factory after it has been returned by this method.- Parameters:
aggregationName
- the name of the aggregationvaluesSourceType
- the type of theValuesSource
targetValueType
- the target type of the final value output by the aggregationotherOptions
- aMap
containing the extra options parsed by thetoken(String, String, XContentParser.Token, XContentParser, Map)
method- Returns:
- the created factory
-
token
protected abstract boolean token(java.lang.String aggregationName, java.lang.String currentFieldName, org.elasticsearch.common.xcontent.XContentParser.Token token, org.elasticsearch.common.xcontent.XContentParser parser, java.util.Map<org.elasticsearch.common.ParseField,java.lang.Object> otherOptions) throws java.io.IOExceptionAllows subclasses ofArrayValuesSourceParser
to parse extra parameters and store them in aMap
which will later be passed tocreateFactory(String, ValuesSourceType, ValueType, Map)
.- Parameters:
aggregationName
- the name of the aggregationcurrentFieldName
- the name of the current field being parsedtoken
- the current token for the parserparser
- the parserotherOptions
- aMap
of options to be populated by successive calls to this method which will then be passed to thecreateFactory(String, ValuesSourceType, ValueType, Map)
method- Returns:
true
if the current token was correctly parsed,false
otherwise- Throws:
java.io.IOException
- if an error occurs whilst parsing
-