Package org.elasticsearch.search.aggregations.bucket.significant

Class UnmappedSignificantTerms

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.InternalMultiBucketAggregation<A,B>

org.elasticsearch.search.aggregations.bucket.significant.InternalSignificantTerms<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket>

org.elasticsearch.search.aggregations.bucket.significant.UnmappedSignificantTerms

All Implemented Interfaces:

java.lang.Iterable<SignificantTerms.Bucket>, NamedWriteable, Writeable, ToXContent, ToXContentFragment, Aggregation, MultiBucketsAggregation, SignificantTerms

public class UnmappedSignificantTerms
extends InternalSignificantTerms<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket>

Result of the running the significant terms aggregation on an unmapped field.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	UnmappedSignificantTerms.Bucket	Concrete type that can't be built because Java needs a concrete type so InternalTerms.Bucket can have a self type but UnmappedTerms doesn't ever need to build it because it never returns any buckets.

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

InternalMultiBucketAggregation.InternalBucket

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

InternalAggregation.ReduceContext

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation

Aggregation.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.bucket.significant.InternalSignificantTerms

BG_COUNT, minDocCount, requiredSize, SCORE

Fields inherited from class org.elasticsearch.search.aggregations.InternalAggregation

metaData, name

Fields inherited from interface org.elasticsearch.search.aggregations.Aggregation

TYPED_KEYS_DELIMITER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
UnmappedSignificantTerms(java.lang.String name, int requiredSize, long minDocCount, java.util.List<PipelineAggregator> pipelineAggregators, java.util.Map<java.lang.String,java.lang.Object> metaData)
UnmappedSignificantTerms(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected UnmappedSignificantTerms	create(long subsetSize, long supersetSize, java.util.List<UnmappedSignificantTerms.Bucket> buckets)
UnmappedSignificantTerms	create(java.util.List<UnmappedSignificantTerms.Bucket> buckets)	Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.
UnmappedSignificantTerms.Bucket	createBucket(InternalAggregations aggregations, UnmappedSignificantTerms.Bucket prototype)	Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.
protected UnmappedSignificantTerms.Bucket[]	createBucketsArray(int size)	Create an array to hold some buckets.
InternalAggregation	doReduce(java.util.List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
SignificantTerms.Bucket	getBucketByKey(java.lang.String term)	Get the bucket for the given term, or null if there is no such bucket.
java.util.List<UnmappedSignificantTerms.Bucket>	getBuckets()
protected SignificanceHeuristic	getSignificanceHeuristic()
protected long	getSubsetSize()
protected long	getSupersetSize()
java.lang.String	getType()
java.lang.String	getWriteableName()	Returns the name of the writeable object
boolean	isMapped()	Return true if this aggregation is mapped, and can lead a reduction.
java.util.Iterator<SignificantTerms.Bucket>	iterator()
protected void	writeTermTypeInfoTo(StreamOutput out)

Methods inherited from class org.elasticsearch.search.aggregations.bucket.significant.InternalSignificantTerms

doEquals, doHashCode, doWriteTo

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

countInnerBucket, countInnerBucket, getProperty

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

equals, getMetaData, getName, getProperty, hashCode, pipelineAggregators, readSize, reduce, toString, toXContent, writeSize, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation

getMetaData, getName

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

toXContent

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

UnmappedSignificantTerms

public UnmappedSignificantTerms(java.lang.String name,
                                int requiredSize,
                                long minDocCount,
                                java.util.List<PipelineAggregator> pipelineAggregators,
                                java.util.Map<java.lang.String,java.lang.Object> metaData)

UnmappedSignificantTerms

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

Read from a stream.

Throws:

java.io.IOException

Method Detail

writeTermTypeInfoTo

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

Specified by:

writeTermTypeInfoTo in class InternalSignificantTerms<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket>

Throws:

java.io.IOException

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

getType

public java.lang.String getType()

Specified by:

getType in interface Aggregation

Overrides:

getType in class InternalAggregation

Returns:

a string representing the type of the aggregation. This type is added to the aggregation name in the response, so that it can later be used by clients to determine type of the aggregation and parse it into the proper object.

create

public UnmappedSignificantTerms create(java.util.List<UnmappedSignificantTerms.Bucket> buckets)

Description copied from class: InternalMultiBucketAggregation

Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.

Specified by:

create in class InternalMultiBucketAggregation<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket>

Parameters:

buckets - the buckets to use in the new Aggregation

Returns:

the new Aggregation

createBucket

public UnmappedSignificantTerms.Bucket createBucket(InternalAggregations aggregations,
                                                    UnmappedSignificantTerms.Bucket prototype)

Description copied from class: InternalMultiBucketAggregation

Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.

Specified by:

createBucket in class InternalMultiBucketAggregation<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket>

Parameters:

aggregations - the aggregations for the new bucket

prototype - the bucket to use as a prototype

Returns:

the new bucket

create

protected UnmappedSignificantTerms create(long subsetSize,
                                          long supersetSize,
                                          java.util.List<UnmappedSignificantTerms.Bucket> buckets)

Specified by:

create in class InternalSignificantTerms<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket>

doReduce

public InternalAggregation doReduce(java.util.List<InternalAggregation> aggregations,
                                    InternalAggregation.ReduceContext reduceContext)

Overrides:

doReduce in class InternalSignificantTerms<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket>

isMapped

public boolean isMapped()

Description copied from class: InternalAggregation

Return true if this aggregation is mapped, and can lead a reduction. If this agg returns false, it should return itself if asked to lead a reduction

Overrides:

isMapped in class InternalAggregation

doXContentBody

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

Specified by:

doXContentBody in class InternalAggregation

Throws:

java.io.IOException

createBucketsArray

protected UnmappedSignificantTerms.Bucket[] createBucketsArray(int size)

Description copied from class: InternalSignificantTerms

Create an array to hold some buckets. Used in collecting the results.

Specified by:

createBucketsArray in class InternalSignificantTerms<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket>

iterator

public java.util.Iterator<SignificantTerms.Bucket> iterator()

getBuckets

public java.util.List<UnmappedSignificantTerms.Bucket> getBuckets()

Specified by:

getBuckets in interface MultiBucketsAggregation

Specified by:

getBuckets in interface SignificantTerms

Specified by:

getBuckets in class InternalSignificantTerms<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket>

Returns:

The buckets of this aggregation.

getBucketByKey

public SignificantTerms.Bucket getBucketByKey(java.lang.String term)

Description copied from interface: SignificantTerms

Get the bucket for the given term, or null if there is no such bucket.

getSignificanceHeuristic

protected SignificanceHeuristic getSignificanceHeuristic()

Specified by:

getSignificanceHeuristic in class InternalSignificantTerms<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket>

getSubsetSize

protected long getSubsetSize()

Specified by:

getSubsetSize in class InternalSignificantTerms<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket>

getSupersetSize

protected long getSupersetSize()

Specified by:

getSupersetSize in class InternalSignificantTerms<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket>