Package org.elasticsearch.search.aggregations.bucket.terms

Class RareTermsAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

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

org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ValuesSource,RareTermsAggregationBuilder>

org.elasticsearch.search.aggregations.bucket.terms.RareTermsAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, BaseAggregationBuilder

public class RareTermsAggregationBuilder
extends ValuesSourceAggregationBuilder<ValuesSource,RareTermsAggregationBuilder>

Nested Class Summary

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

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

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

AggregationBuilder.CommonFields

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
static java.lang.String	NAME

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

factoriesBuilder, name

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RareTermsAggregationBuilder(java.lang.String name, ValueType valueType)
RareTermsAggregationBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(java.lang.Object obj)
double	getPrecision()	Get the current false positive rate for individual cuckoo filters.
java.lang.String	getType()	The name of the type of aggregation built by this builder.
int	hashCode()
IncludeExclude	includeExclude()	Get terms to include and exclude from the aggregation results
RareTermsAggregationBuilder	includeExclude(IncludeExclude includeExclude)	Set terms to include and exclude from the aggregation results
protected ValuesSourceAggregatorFactory<ValuesSource>	innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig<ValuesSource> config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected void	innerWriteTo(StreamOutput out)	Write subclass's state to the stream.
RareTermsAggregationBuilder	maxDocCount(long maxDocCount)	Set the maximum document count terms should have in order to appear in the response.
static AggregationBuilder	parse(java.lang.String aggregationName, XContentParser parser)
protected boolean	serializeTargetValueType(Version version)	Should this builder serialize its targetValueType? Defaults to false.
void	setPrecision(double precision)	Set's the false-positive rate for individual cuckoo filters.
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metaData.

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

defaultValueType, doBuild, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, resolveScriptAny, script, script, timeZone, timeZone, valueType, valueType

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

build, getMetaData, getWriteableName, setMetaData, subAggregation, subAggregation, subAggregations, toXContent, writeTo

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

doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

RareTermsAggregationBuilder

public RareTermsAggregationBuilder(java.lang.String name,
                                   ValueType valueType)

RareTermsAggregationBuilder

public RareTermsAggregationBuilder(StreamInput in)
                            throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

parse

public static AggregationBuilder parse(java.lang.String aggregationName,
                                       XContentParser parser)
                                throws java.io.IOException

Throws:

java.io.IOException

shallowCopy

protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder,
                                         java.util.Map<java.lang.String,java.lang.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

serializeTargetValueType

protected boolean serializeTargetValueType(Version version)

Description copied from class: ValuesSourceAggregationBuilder

Should this builder serialize its targetValueType? Defaults to false. All subclasses that override this to true should use the three argument read constructor rather than the four argument version.

Overrides:

serializeTargetValueType in class ValuesSourceAggregationBuilder<ValuesSource,RareTermsAggregationBuilder>

Parameters:

version - For backwards compatibility, subclasses can change behavior based on the version

innerWriteTo

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

Description copied from class: ValuesSourceAggregationBuilder

Write subclass's state to the stream.

Specified by:

innerWriteTo in class ValuesSourceAggregationBuilder<ValuesSource,RareTermsAggregationBuilder>

Throws:

java.io.IOException

maxDocCount

public RareTermsAggregationBuilder maxDocCount(long maxDocCount)

Set the maximum document count terms should have in order to appear in the response.

includeExclude

public RareTermsAggregationBuilder includeExclude(IncludeExclude includeExclude)

Set terms to include and exclude from the aggregation results

includeExclude

public IncludeExclude includeExclude()

Get terms to include and exclude from the aggregation results

getPrecision

public double getPrecision()

Get the current false positive rate for individual cuckoo filters.

setPrecision

public void setPrecision(double precision)

Set's the false-positive rate for individual cuckoo filters. Does not dictate the overall fpp rate since we use a "scaling" cuckoo filter which adds more filters as required, and the overall error rate grows differently than individual filters This value does, however, affect the overall space usage of the filter. Coarser precisions provide more compact filters. The default is 0.01

innerBuild

protected ValuesSourceAggregatorFactory<ValuesSource> innerBuild(QueryShardContext queryShardContext,
                                                                 ValuesSourceConfig<ValuesSource> config,
                                                                 AggregatorFactory parent,
                                                                 AggregatorFactories.Builder subFactoriesBuilder)
                                                          throws java.io.IOException

Specified by:

innerBuild in class ValuesSourceAggregationBuilder<ValuesSource,RareTermsAggregationBuilder>

Throws:

java.io.IOException

doXContentBody

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

Specified by:

doXContentBody in class ValuesSourceAggregationBuilder<ValuesSource,RareTermsAggregationBuilder>

Throws:

java.io.IOException

hashCode

public int hashCode()

Overrides:

hashCode in class ValuesSourceAggregationBuilder<ValuesSource,RareTermsAggregationBuilder>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class ValuesSourceAggregationBuilder<ValuesSource,RareTermsAggregationBuilder>

getType

public java.lang.String getType()

Description copied from interface: BaseAggregationBuilder

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