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, HistogramValuesSourceBuilder, TermsValuesSourceBuilder

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

A ValuesSource builder for CompositeAggregationBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.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 java.lang.String	name

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
org.elasticsearch.search.aggregations.bucket.composite.CompositeValuesSourceConfig	build(SearchContext context)
protected abstract void	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(java.lang.Object o)
java.lang.String	field()	Gets the field to use for this source
AB	field(java.lang.String field)	Sets the field to use for this source
java.lang.String	format()	Gets the format to use for the output of the aggregation.
AB	format(java.lang.String format)	Sets the format to use for the output of the aggregation.
int	hashCode()
protected abstract org.elasticsearch.search.aggregations.bucket.composite.CompositeValuesSourceConfig	innerBuild(SearchContext context, ValuesSourceConfig<?> config)	Creates a CompositeValuesSourceConfig for this source.
protected abstract boolean	innerEquals(AB builder)
protected abstract int	innerHashCode()
protected abstract void	innerWriteTo(StreamOutput out)
java.lang.Object	missing()	Deprecated.
AB	missing(java.lang.Object missing)	Deprecated. Use missingBucket(boolean) instead.
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.
java.lang.String	name()
SortOrder	order()	Gets the SortOrder to use to sort values produced this source
AB	order(java.lang.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
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ValueType	valueType()	Gets the ValueType for the value produced by this source
AB	valueType(ValueType valueType)	Sets the ValueType for the value produced by this source
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.common.xcontent.ToXContentFragment

isFragment

Field Detail

name

protected final java.lang.String name

Method Detail

writeTo

public final void writeTo(StreamOutput out)
                   throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

innerWriteTo

protected abstract void innerWriteTo(StreamOutput out)
                              throws java.io.IOException

Throws:

java.io.IOException

doXContentBody

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

Throws:

java.io.IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

innerHashCode

protected abstract int innerHashCode()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

innerEquals

protected abstract boolean innerEquals(AB builder)

name

public java.lang.String name()

field

public AB field(java.lang.String field)

Sets the field to use for this source

field

public java.lang.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

valueType

public AB valueType(ValueType valueType)

Sets the ValueType for the value produced by this source

valueType

public ValueType valueType()

Gets the ValueType for the value produced by this source

missing

@Deprecated
public AB missing(java.lang.Object missing)

Deprecated.

Use missingBucket(boolean) instead.

Sets the value to use when the source finds a missing value in a document.

missing

@Deprecated
public java.lang.Object missing()

Deprecated.

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.

order

public AB order(java.lang.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(java.lang.String format)

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

format

public java.lang.String format()

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

innerBuild

protected abstract org.elasticsearch.search.aggregations.bucket.composite.CompositeValuesSourceConfig innerBuild(SearchContext context,
                                                                                                                 ValuesSourceConfig<?> config)
                                                                                                          throws java.io.IOException

Creates a CompositeValuesSourceConfig for this source.

Parameters:

context - The search context for this source.

config - The ValuesSourceConfig for this source.

Throws:

java.io.IOException

build

public final org.elasticsearch.search.aggregations.bucket.composite.CompositeValuesSourceConfig build(SearchContext context)
                                                                                               throws java.io.IOException

Throws:

java.io.IOException