Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.bucket.composite

Class CompositeValuesSourceBuilder<AB extends CompositeValuesSourceBuilder<AB>>

java.lang.Object

org.elasticsearch.search.aggregations.bucket.composite.CompositeValuesSourceBuilder<AB>

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

Direct Known Subclasses:

DateHistogramValuesSourceBuilder, GeoTileGridValuesSourceBuilder, HistogramValuesSourceBuilder, TermsValuesSourceBuilder

public abstract class CompositeValuesSourceBuilder<AB extends CompositeValuesSourceBuilder<AB>>
extends Object
implements Writeable, ToXContentFragment

A ValuesSource builder for CompositeAggregationBuilder

Nested Class Summary

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
protected final String	name

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
final CompositeValuesSourceConfig	build(AggregationContext context)
protected abstract void	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(Object o)
String	field()	Gets the field to use for this source
AB	field(String field)	Sets the field to use for this source
String	format()	Gets the format to use for the output of the aggregation.
AB	format(String format)	Sets the format to use for the output of the aggregation.
protected abstract ValuesSourceType	getDefaultValuesSourceType()
int	hashCode()
protected abstract CompositeValuesSourceConfig	innerBuild(ValuesSourceRegistry registry, ValuesSourceConfig config)	Actually build the values source and its associated configuration.
protected abstract void	innerWriteTo(StreamOutput out)
boolean	missingBucket()	False if documents with missing values are ignored, otherwise missing values are represented by an explicit `null` value.
AB	missingBucket(boolean missingBucket)	If true an explicit null bucket will represent documents with missing values.
MissingOrder	missingOrder()	The MissingOrder policy used for ordering missing values.
AB	missingOrder(String missingOrder)	Sets the MissingOrder policy to use for ordering missing values.
AB	missingOrder(MissingOrder missingOrder)	Sets the MissingOrder policy to use for ordering missing values.
String	name()
SortOrder	order()	Gets the SortOrder to use to sort values produced this source
AB	order(String order)	Sets the SortOrder to use to sort values produced this source
AB	order(SortOrder order)	Sets the SortOrder to use to sort values produced this source
Script	script()	Gets the script to use for this source
AB	script(Script script)	Sets the script to use for this source
protected ZoneId	timeZone()	The time zone for this value source.
final XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ValueType	userValuetypeHint()	Gets the ValueType for the value produced by this source
AB	userValuetypeHint(ValueType valueType)	Sets the ValueType for the value produced by this source
final void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

name

protected final String name

Method Details

writeTo

public final void writeTo(StreamOutput out)
                   throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

innerWriteTo

protected abstract void innerWriteTo(StreamOutput out)
                              throws IOException

Throws:

IOException

doXContentBody

protected abstract void doXContentBody(XContentBuilder builder,
 ToXContent.Params params)
                                throws IOException

Throws:

IOException

toXContent

public final XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                                 throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

name

public String name()

field

public AB field(String field)

Sets the field to use for this source

field

public String field()

Gets the field to use for this source

script

public AB script(Script script)

Sets the script to use for this source

script

public Script script()

Gets the script to use for this source

userValuetypeHint

public AB userValuetypeHint(ValueType valueType)

Sets the ValueType for the value produced by this source

userValuetypeHint

public ValueType userValuetypeHint()

Gets the ValueType for the value produced by this source

missingBucket

public AB missingBucket(boolean missingBucket)

If true an explicit null bucket will represent documents with missing values.

missingBucket

public boolean missingBucket()

False if documents with missing values are ignored, otherwise missing values are represented by an explicit `null` value.

missingOrder

public AB missingOrder(String missingOrder)

Sets the MissingOrder policy to use for ordering missing values.

Parameters:

missingOrder - One of "first", "last" or "default".

missingOrder

public AB missingOrder(MissingOrder missingOrder)

Sets the MissingOrder policy to use for ordering missing values.

missingOrder

public MissingOrder missingOrder()

The MissingOrder policy used for ordering missing values.

order

public AB order(String order)

Sets the SortOrder to use to sort values produced this source

order

public AB order(SortOrder order)

Sets the SortOrder to use to sort values produced this source

order

public SortOrder order()

Gets the SortOrder to use to sort values produced this source

format

public AB format(String format)

Sets the format to use for the output of the aggregation.

format

public String format()

Gets the format to use for the output of the aggregation.

innerBuild

protected abstract CompositeValuesSourceConfig innerBuild(ValuesSourceRegistry registry,
 ValuesSourceConfig config)
                                                   throws IOException

Actually build the values source and its associated configuration.

Throws:

IOException

getDefaultValuesSourceType

protected abstract ValuesSourceType getDefaultValuesSourceType()

build

public final CompositeValuesSourceConfig build(AggregationContext context)
                                        throws IOException

Throws:

IOException

timeZone

protected ZoneId timeZone()

The time zone for this value source. Default implementation returns null because most value source types don't support time zone.