Package org.elasticsearch.search.aggregations.support

Class ValuesSourceConfig

java.lang.Object

org.elasticsearch.search.aggregations.support.ValuesSourceConfig

public class ValuesSourceConfig
extends java.lang.Object

A configuration that tells aggregations how to retrieve data from the index in order to run a specific aggregation.

Constructor Summary

Constructors

Constructor	Description
ValuesSourceConfig(ValuesSourceType valuesSourceType, MappedFieldType fieldType, boolean unmapped, AggregationScript.LeafFactory script, ValueType scriptValueType, QueryShardContext queryShardContext)

Method Summary

Modifier and Type	Method	Description
FieldContext	fieldContext()
DocValueFormat	format()
java.lang.Object	missing()
static ValuesSourceConfig	resolve(QueryShardContext context, ValueType userValueTypeHint, java.lang.String field, Script script, java.lang.Object missing, java.time.ZoneId timeZone, java.lang.String format, ValuesSourceType defaultValueSourceType, java.lang.String aggregationName)	Given the query context and other information, decide on the input ValuesSource for this aggretation run, and construct a new ValuesSourceConfig based on that ValuesSourceType
static ValuesSourceConfig	resolveFieldOnly(MappedFieldType fieldType, QueryShardContext queryShardContext)	Special case factory method, intended to be used by aggregations which have some specialized logic for figuring out what field they are operating on, for example Parent and Child join aggregations, which use the join relation to find the field they are reading from rather than a user specified field.
static ValuesSourceConfig	resolveUnmapped(ValuesSourceType valuesSourceType, QueryShardContext queryShardContext)	Convenience method for creating unmapped configs
static ValuesSourceConfig	resolveUnregistered(QueryShardContext context, ValueType userValueTypeHint, java.lang.String field, Script script, java.lang.Object missing, java.time.ZoneId timeZone, java.lang.String format, ValuesSourceType defaultValueSourceType)	AKA legacy resolve.
AggregationScript.LeafFactory	script()
ValueType	scriptValueType()
java.time.ZoneId	timezone()
ValuesSource	toValuesSource()	Transform the ValuesSourceType we selected in resolve into the specific ValuesSource instance to use for this shard
boolean	unmapped()
boolean	valid()
ValuesSourceType	valueSourceType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ValuesSourceConfig

public ValuesSourceConfig(ValuesSourceType valuesSourceType, MappedFieldType fieldType, boolean unmapped, AggregationScript.LeafFactory script, ValueType scriptValueType, QueryShardContext queryShardContext)

Method Details

resolve

public static ValuesSourceConfig resolve(QueryShardContext context, ValueType userValueTypeHint, java.lang.String field, Script script, java.lang.Object missing, java.time.ZoneId timeZone, java.lang.String format, ValuesSourceType defaultValueSourceType, java.lang.String aggregationName)

Given the query context and other information, decide on the input ValuesSource for this aggretation run, and construct a new ValuesSourceConfig based on that ValuesSourceType

Parameters:

context - - the query context

userValueTypeHint - - User specified value type; used for missing values and scripts

field - - The field being aggregated over. At least one of field and script must not be null

script - - The script the user specified. At least one of field and script must not be null

missing - - A user specified value to apply when the field is missing. Should be of type userValueTypeHint

timeZone - - Used to generate a format for dates

format - - The format string to apply to this field. Confusingly, this is used for input parsing as well as output formatting See https://github.com/elastic/elasticsearch/issues/47469

defaultValueSourceType - - per-aggregation ValuesSource of last resort.

aggregationName - - Name of the aggregation, generally from the aggregation builder. This is used as a lookup key in the ValuesSourceRegistry

Returns:

- An initialized ValuesSourceConfig that will yield the appropriate ValuesSourceType

resolveUnregistered

public static ValuesSourceConfig resolveUnregistered(QueryShardContext context, ValueType userValueTypeHint, java.lang.String field, Script script, java.lang.Object missing, java.time.ZoneId timeZone, java.lang.String format, ValuesSourceType defaultValueSourceType)

AKA legacy resolve. This method should be called by aggregations not supported by the ValuesSourceRegistry, to use the pre-registry logic to decide on the ValuesSourceType. New aggregations which extend from ValuesSourceAggregationBuilder should not use this method, preferring resolve(org.elasticsearch.index.query.QueryShardContext, org.elasticsearch.search.aggregations.support.ValueType, java.lang.String, org.elasticsearch.script.Script, java.lang.Object, java.time.ZoneId, java.lang.String, org.elasticsearch.search.aggregations.support.ValuesSourceType, java.lang.String) instead.

Parameters:

context - - the query context

userValueTypeHint - - User specified value type; used for missing values and scripts

field - - The field being aggregated over. At least one of field and script must not be null

script - - The script the user specified. At least one of field and script must not be null

missing - - A user specified value to apply when the field is missing. Should be of type userValueTypeHint

timeZone - - Used to generate a format for dates

format - - The format string to apply to this field. Confusingly, this is used for input parsing as well as output formatting See https://github.com/elastic/elasticsearch/issues/47469

defaultValueSourceType - - per-aggregation ValuesSource of last resort.

Returns:

- An initialized ValuesSourceConfig that will yield the appropriate ValuesSourceType

resolveFieldOnly

public static ValuesSourceConfig resolveFieldOnly(MappedFieldType fieldType, QueryShardContext queryShardContext)

Special case factory method, intended to be used by aggregations which have some specialized logic for figuring out what field they are operating on, for example Parent and Child join aggregations, which use the join relation to find the field they are reading from rather than a user specified field.

resolveUnmapped

public static ValuesSourceConfig resolveUnmapped(ValuesSourceType valuesSourceType, QueryShardContext queryShardContext)

Convenience method for creating unmapped configs

valueSourceType

public ValuesSourceType valueSourceType()

fieldContext

public FieldContext fieldContext()

script

public AggregationScript.LeafFactory script()

unmapped

public boolean unmapped()

valid

public boolean valid()

scriptValueType

public ValueType scriptValueType()

missing

public java.lang.Object missing()

timezone

public java.time.ZoneId timezone()

format

public DocValueFormat format()

toValuesSource

@Nullable public ValuesSource toValuesSource()

Transform the ValuesSourceType we selected in resolve into the specific ValuesSource instance to use for this shard

Returns:

- A ValuesSource ready to be read from by an aggregator