Package org.elasticsearch.search.aggregations.metrics

Class PercentileRanksAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB>

org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<AB>

org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder.LeafOnly<VS,AB>

org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder.MetricsAggregationBuilder<ValuesSource,T>

org.elasticsearch.search.aggregations.metrics.AbstractPercentilesAggregationBuilder<PercentileRanksAggregationBuilder>

org.elasticsearch.search.aggregations.metrics.PercentileRanksAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, Rewriteable<AggregationBuilder>, BaseAggregationBuilder, ToXContent, ToXContentFragment

public class PercentileRanksAggregationBuilder
extends AbstractPercentilesAggregationBuilder<PercentileRanksAggregationBuilder>

Nested Class Summary

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

ValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<AB>>, ValuesSourceAggregationBuilder.MetricsAggregationBuilder<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<AB>>, ValuesSourceAggregationBuilder.SingleMetricAggregationBuilder<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<AB>>

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

AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME
static final ValuesSourceRegistry.RegistryKey<PercentilesAggregatorSupplier>	REGISTRY_KEY

Fields inherited from class org.elasticsearch.search.aggregations.metrics.AbstractPercentilesAggregationBuilder

keyed, KEYED_FIELD, values

Fields inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

config

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

Constructor	Description
PercentileRanksAggregationBuilder(String name, double[] values)
PercentileRanksAggregationBuilder(StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected ValuesSourceType	defaultValueSourceType()	Aggregations should use this method to define a ValuesSourceType of last resort.
protected ValuesSourceRegistry.RegistryKey<?>	getRegistryKey()
String	getType()	The name of the type of aggregation built by this builder.
protected ValuesSourceAggregatorFactory	innerBuild(AggregationContext context, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
static AggregationBuilder	parse(String aggregationName, XContentParser parser)
static void	registerAggregators(ValuesSourceRegistry.Builder builder)
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata.
double[]	values()	Get the values to compute percentiles from.

Methods inherited from class org.elasticsearch.search.aggregations.metrics.AbstractPercentilesAggregationBuilder

compression, compression, createParser, doXContentBody, equals, hashCode, innerWriteTo, keyed, keyed, method, method, metricNames, numberOfSignificantValueDigits, numberOfSignificantValueDigits, percentilesConfig, percentilesConfig

Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder.LeafOnly

bucketCardinality, subAggregations

Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

declareFields, declareFields, doBuild, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, script, script, serializeTargetValueType, timeZone, timeZone, userValueTypeHint, userValueTypeHint

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

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

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

buildPipelineTree, bytesToPreallocate, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getSubAggregations, isInSortOrderExecutionRequired, rewrite, toString, validateSequentiallyOrdered, validateSequentiallyOrderedWithoutGaps

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

REGISTRY_KEY

public static final ValuesSourceRegistry.RegistryKey<PercentilesAggregatorSupplier> REGISTRY_KEY

Constructor Details

PercentileRanksAggregationBuilder

public PercentileRanksAggregationBuilder(String name,
 double[] values)

PercentileRanksAggregationBuilder

public PercentileRanksAggregationBuilder(StreamInput in)
                                  throws IOException

Throws:

IOException

Method Details

parse

public static AggregationBuilder parse(String aggregationName,
 XContentParser parser)
                                throws IOException

Throws:

IOException

registerAggregators

public static void registerAggregators(ValuesSourceRegistry.Builder builder)

shallowCopy

protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

Description copied from class: AggregationBuilder

Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata. Used by AggregationBuilder.rewrite(QueryRewriteContext).

Specified by:

shallowCopy in class AggregationBuilder

defaultValueSourceType

protected ValuesSourceType defaultValueSourceType()

Description copied from class: ValuesSourceAggregationBuilder

Aggregations should use this method to define a ValuesSourceType of 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:

defaultValueSourceType in class ValuesSourceAggregationBuilder<PercentileRanksAggregationBuilder>

Returns:

The CoreValuesSourceType we expect this script to yield.

values

public double[] values()

Get the values to compute percentiles from.

innerBuild

protected ValuesSourceAggregatorFactory innerBuild(AggregationContext context,
 ValuesSourceConfig config,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder)
                                            throws IOException

Specified by:

innerBuild in class ValuesSourceAggregationBuilder<PercentileRanksAggregationBuilder>

Throws:

IOException

getType

public String getType()

Description copied from interface: BaseAggregationBuilder

The name of the type of aggregation built by this builder.

getRegistryKey

protected ValuesSourceRegistry.RegistryKey<?> getRegistryKey()

Specified by:

getRegistryKey in class ValuesSourceAggregationBuilder<PercentileRanksAggregationBuilder>