Module org.elasticsearch.server
Class GeoDistanceAggregationBuilder
java.lang.Object
org.elasticsearch.search.aggregations.AggregationBuilder
org.elasticsearch.search.aggregations.AbstractAggregationBuilder<GeoDistanceAggregationBuilder>
org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>
org.elasticsearch.search.aggregations.bucket.range.GeoDistanceAggregationBuilder
- All Implemented Interfaces:
NamedWriteable,VersionedNamedWriteable,Writeable,Rewriteable<AggregationBuilder>,BaseAggregationBuilder,ToXContent,ToXContentFragment
public class GeoDistanceAggregationBuilder
extends ValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder
ValuesSourceAggregationBuilder.LeafOnly<AB extends ValuesSourceAggregationBuilder<AB>>, ValuesSourceAggregationBuilder.MetricsAggregationBuilder<AB extends ValuesSourceAggregationBuilder<AB>>, ValuesSourceAggregationBuilder.SingleMetricAggregationBuilder<AB extends ValuesSourceAggregationBuilder<AB>>Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFieldsNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsFields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
metadataFields inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
DEFAULT_PREALLOCATION, factoriesBuilder, nameFields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDSFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsModifierConstructorDescriptionGeoDistanceAggregationBuilder(String name, GeoPoint origin) Read from a stream.protectedGeoDistanceAggregationBuilder(GeoDistanceAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) -
Method Summary
Modifier and TypeMethodDescriptionaddRange(double from, double to) Same asaddRange(String, double, double)but the key will be automatically generated based onfromandto.Add a new range to this aggregation.addUnboundedFrom(double from) Same asaddUnboundedFrom(String, double)but the key will be computed automatically.addUnboundedFrom(String key, double from) Add a new range with no upper bound.addUnboundedTo(double to) Same asaddUnboundedTo(String, double)but the key will be computed automatically.addUnboundedTo(String key, double to) Add a new range with no lower bound.A rough count of the number of buckets thatAggregators built by this builder will contain per owning parent bucket.protected ValuesSourceTypeAggregations should use this method to define aValuesSourceTypeof last resort.distanceType(GeoDistance distanceType) protected XContentBuilderdoXContentBody(XContentBuilder builder, ToXContent.Params params) booleanThe minimal version of the recipient this object can be sent to.getType()The name of the type of aggregation built by this builder.inthashCode()protected ValuesSourceAggregatorFactoryinnerBuild(AggregationContext context, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) protected voidinnerWriteTo(StreamOutput out) Write subclass's state to the stream.keyed(boolean keyed) origin()Return theGeoPointthat is used for distance computations.static AggregationBuilderparse(String aggregationName, XContentParser parser) range()static voidprotected AggregationBuildershallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) Create a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilderandmetadata.booleanDoes this aggregation support running with in a sampling context.unit(DistanceUnit unit) Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder
declareFields, declareFields, doBuild, doWriteTo, field, field, format, format, internalXContent, missing, resolveConfig, script, script, serializeTargetValueType, timeZone, timeZone, userValueTypeHint, userValueTypeHintMethods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeToMethods inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
buildPipelineTree, bytesToPreallocate, deepCopy, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getQuery, getSubAggregations, isInSortOrderExecutionRequired, rewrite, supportsParallelCollection, toString, validateSequentiallyOrdered, validateSequentiallyOrderedWithoutGapsMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragmentMethods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable
supportsVersion
-
Field Details
-
NAME
- See Also:
-
REGISTRY_KEY
-
-
Constructor Details
-
GeoDistanceAggregationBuilder
-
GeoDistanceAggregationBuilder
Read from a stream.- Throws:
IOException
-
GeoDistanceAggregationBuilder
protected GeoDistanceAggregationBuilder(GeoDistanceAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata)
-
-
Method Details
-
parse
public static AggregationBuilder parse(String aggregationName, XContentParser parser) throws IOException - Throws:
IOException
-
registerAggregators
-
supportsSampling
public boolean supportsSampling()Description copied from class:AggregationBuilderDoes this aggregation support running with in a sampling context. By default, it's false for all aggregations. If the sub-classed builder supports sampling, be sure of the following that the resulting internal aggregation objects override theInternalAggregation.finalizeSampling(SamplingContext)and scales any values that require scaling.- Overrides:
supportsSamplingin classAggregationBuilder- Returns:
- does this aggregation builder support sampling
-
defaultValueSourceType
Description copied from class:ValuesSourceAggregationBuilderAggregations should use this method to define aValuesSourceTypeof last resort. This will only be used when the resolver can't find a field and the user hasn't provided a value type hint.- Specified by:
defaultValueSourceTypein classValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>- Returns:
- The CoreValuesSourceType we expect this script to yield.
-
shallowCopy
protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) Description copied from class:AggregationBuilderCreate a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilderandmetadata.- Specified by:
shallowCopyin classAggregationBuilder
-
origin
Return theGeoPointthat is used for distance computations. -
innerWriteTo
Description copied from class:ValuesSourceAggregationBuilderWrite subclass's state to the stream.- Specified by:
innerWriteToin classValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>- Throws:
IOException
-
addRange
-
addRange
Add a new range to this aggregation.- Parameters:
key- the key to use for this range in the responsefrom- the lower bound on the distances, inclusiveto- the upper bound on the distances, exclusive
-
addRange
Same asaddRange(String, double, double)but the key will be automatically generated based onfromandto. -
addUnboundedTo
Add a new range with no lower bound.- Parameters:
key- the key to use for this range in the responseto- the upper bound on the distances, exclusive
-
addUnboundedTo
Same asaddUnboundedTo(String, double)but the key will be computed automatically. -
addUnboundedFrom
Add a new range with no upper bound.- Parameters:
key- the key to use for this range in the responsefrom- the lower bound on the distances, inclusive
-
addUnboundedFrom
Same asaddUnboundedFrom(String, double)but the key will be computed automatically. -
range
-
getType
Description copied from interface:BaseAggregationBuilderThe name of the type of aggregation built by this builder. -
unit
-
distanceType
-
keyed
-
bucketCardinality
Description copied from class:AggregationBuilderA rough count of the number of buckets thatAggregators built by this builder will contain per owning parent bucket.- Specified by:
bucketCardinalityin classAggregationBuilder
-
innerBuild
protected ValuesSourceAggregatorFactory innerBuild(AggregationContext context, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) throws IOException - Specified by:
innerBuildin classValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>- Throws:
IOException
-
doXContentBody
protected XContentBuilder doXContentBody(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
doXContentBodyin classValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>- Throws:
IOException
-
hashCode
public int hashCode()- Overrides:
hashCodein classValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>
-
equals
- Overrides:
equalsin classValuesSourceAggregationBuilder<GeoDistanceAggregationBuilder>
-
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteableThe minimal version of the recipient this object can be sent to. SeeVersionedNamedWriteable.supportsVersion(TransportVersion)for the default serialization check.
-