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

Class InternalRareTerms.Bucket<B extends InternalRareTerms.Bucket<B>>

java.lang.Object

org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket

org.elasticsearch.search.aggregations.bucket.terms.InternalRareTerms.Bucket<B>

All Implemented Interfaces:

Writeable, MultiBucketsAggregation.Bucket, RareTerms.Bucket, HasAggregations, KeyComparable<B>, ToXContent

Direct Known Subclasses:

LongRareTerms.Bucket, StringRareTerms.Bucket, UnmappedRareTerms.Bucket

Enclosing class:

InternalRareTerms<A extends InternalRareTerms<A,B>,B extends InternalRareTerms.Bucket<B>>

public abstract static class InternalRareTerms.Bucket<B extends InternalRareTerms.Bucket<B>>
extends InternalMultiBucketAggregation.InternalBucket
implements RareTerms.Bucket, KeyComparable<B>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InternalRareTerms.Bucket.Reader<B extends InternalRareTerms.Bucket<B>>	Reads a bucket.

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.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected InternalAggregations	aggregations
protected long	docCount
protected final DocValueFormat	format

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Bucket(long docCount, InternalAggregations aggregations, DocValueFormat formatter)
protected	Bucket(StreamInput in, DocValueFormat formatter)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Aggregations	getAggregations()
long	getDocCount()
int	hashCode()
protected abstract XContentBuilder	keyToXContent(XContentBuilder builder)
final XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
protected abstract void	writeTermTo(StreamOutput out)
final void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

getProperty

Methods inherited from class java.lang.Object

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

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

compareKey

Methods inherited from interface org.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation.Bucket

getKey, getKeyAsString

Methods inherited from interface org.elasticsearch.search.aggregations.bucket.terms.RareTerms.Bucket

getKeyAsNumber

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

isFragment

Field Details

docCount

protected long docCount

aggregations

protected InternalAggregations aggregations

format

protected final DocValueFormat format

Constructor Details

Bucket

protected Bucket(long docCount,
 InternalAggregations aggregations,
 DocValueFormat formatter)

Bucket

protected Bucket(StreamInput in,
 DocValueFormat formatter)
          throws IOException

Read from a stream.

Throws:

IOException

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

writeTermTo

protected abstract void writeTermTo(StreamOutput out)
                             throws IOException

Throws:

IOException

getDocCount

public long getDocCount()

Specified by:

getDocCount in interface MultiBucketsAggregation.Bucket

Returns:

The number of documents that fall within this bucket

getAggregations

public Aggregations getAggregations()

Specified by:

getAggregations in interface HasAggregations

Specified by:

getAggregations in interface MultiBucketsAggregation.Bucket

Returns:

The sub-aggregations of this bucket

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

keyToXContent

protected abstract XContentBuilder keyToXContent(XContentBuilder builder)
                                          throws IOException

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object