Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.bucket.prefix

Class InternalIpPrefix.Bucket

java.lang.Object

org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket

org.elasticsearch.search.aggregations.bucket.prefix.InternalIpPrefix.Bucket

All Implemented Interfaces:

Writeable, MultiBucketsAggregation.Bucket, IpPrefix.Bucket, HasAggregations, KeyComparable<InternalIpPrefix.Bucket>, ToXContent

Enclosing class:

InternalIpPrefix

public static class InternalIpPrefix.Bucket
extends InternalMultiBucketAggregation.InternalBucket
implements IpPrefix.Bucket, KeyComparable<InternalIpPrefix.Bucket>

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 inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Bucket(StreamInput in, DocValueFormat format, boolean keyed)	Read from a stream.
Bucket(DocValueFormat format, org.apache.lucene.util.BytesRef key, boolean keyed, boolean isIpv6, int prefixLength, boolean appendPrefixLength, long docCount, InternalAggregations aggregations)

Method Summary

Modifier and Type	Method	Description
boolean	appendPrefixLength()
int	compareKey(InternalIpPrefix.Bucket other)	Compare this MultiBucketsAggregation.Buckets key with another bucket.
boolean	equals(Object o)
InternalAggregations	getAggregations()
long	getDocCount()
DocValueFormat	getFormat()
org.apache.lucene.util.BytesRef	getKey()
String	getKeyAsString()
int	getPrefixLength()
int	hashCode()
boolean	isIpv6()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
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.xcontent.ToXContent

isFragment

Constructor Details

Bucket

public Bucket(DocValueFormat format,
 org.apache.lucene.util.BytesRef key,
 boolean keyed,
 boolean isIpv6,
 int prefixLength,
 boolean appendPrefixLength,
 long docCount,
 InternalAggregations aggregations)

Bucket

public Bucket(StreamInput in,
 DocValueFormat format,
 boolean keyed)
       throws IOException

Read from a stream.

Throws:

IOException

Method Details

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

getFormat

public DocValueFormat getFormat()

getKey

public org.apache.lucene.util.BytesRef getKey()

Specified by:

getKey in interface MultiBucketsAggregation.Bucket

Returns:

The key associated with the bucket

getKeyAsString

public String getKeyAsString()

Specified by:

getKeyAsString in interface MultiBucketsAggregation.Bucket

Returns:

The key associated with the bucket as a string

isIpv6

public boolean isIpv6()

getPrefixLength

public int getPrefixLength()

appendPrefixLength

public boolean appendPrefixLength()

getDocCount

public long getDocCount()

Specified by:

getDocCount in interface MultiBucketsAggregation.Bucket

Returns:

The number of documents that fall within this bucket

getAggregations

public InternalAggregations getAggregations()

Specified by:

getAggregations in interface HasAggregations

Specified by:

getAggregations in interface MultiBucketsAggregation.Bucket

Returns:

The sub-aggregations of this bucket

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareKey

public int compareKey(InternalIpPrefix.Bucket other)

Description copied from interface: KeyComparable

Compare this MultiBucketsAggregation.Buckets key with another bucket.

Specified by:

compareKey in interface KeyComparable<InternalIpPrefix.Bucket>

Parameters:

other - the bucket that contains the key to compare to.

Returns:

a negative integer, zero, or a positive integer as this buckets key is less than, equal to, or greater than the other buckets key.

See Also:

• Comparable.compareTo(Object)