Package org.opensearch.search.aggregations.bucket.range

Class RangeAggregator.Range

java.lang.Object

org.opensearch.search.aggregations.bucket.range.RangeAggregator.Range

All Implemented Interfaces:

Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentObject

Direct Known Subclasses:

GeoDistanceAggregationBuilder.Range

Enclosing class:

RangeAggregator

public static class RangeAggregator.Range
extends Object
implements Writeable, org.opensearch.common.xcontent.ToXContentObject

Range for the range aggregator

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected final double	from
static final org.opensearch.common.ParseField	FROM_FIELD
protected final String	fromAsStr
protected final String	key
static final org.opensearch.common.ParseField	KEY_FIELD
static final org.opensearch.common.xcontent.ConstructingObjectParser<RangeAggregator.Range,Void>	PARSER
protected final double	to
static final org.opensearch.common.ParseField	TO_FIELD
protected final String	toAsStr

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Range(String key, Double from, Double to)
Range(String key, Double from, String fromAsStr, Double to, String toAsStr)	Build the range.
Range(String key, String from, String to)
Range(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
double	getFrom()
String	getFromAsString()
String	getKey()
double	getTo()
String	getToAsString()
int	hashCode()
String	toString()
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.common.xcontent.ToXContentObject

isFragment

Field Details

KEY_FIELD

public static final org.opensearch.common.ParseField KEY_FIELD

FROM_FIELD

public static final org.opensearch.common.ParseField FROM_FIELD

TO_FIELD

public static final org.opensearch.common.ParseField TO_FIELD

key

protected final String key

from

protected final double from

fromAsStr

protected final String fromAsStr

to

protected final double to

toAsStr

protected final String toAsStr

PARSER

public static final org.opensearch.common.xcontent.ConstructingObjectParser<RangeAggregator.Range,Void> PARSER

Constructor Details

Range

public Range(String key,
 Double from,
 String fromAsStr,
 Double to,
 String toAsStr)

Build the range. Generally callers should prefer Range(String, Double, Double) or Range(String, String, String). If you must call this know that consumers prefer from and to parameters if they are non-null and finite. Otherwise they parse from fromrStr and toStr.

Range

public Range(String key,
 Double from,
 Double to)

Range

public Range(String key,
 String from,
 String to)

Range

public Range(StreamInput in)
      throws IOException

Read from a stream.

Throws:

IOException

Method Details

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

getFrom

public double getFrom()

getTo

public double getTo()

getFromAsString

public String getFromAsString()

getToAsString

public String getToAsString()

getKey

public String getKey()

toString

public String toString()

Overrides:

toString in class Object

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder,
 org.opensearch.common.xcontent.ToXContent.Params params)
                                                          throws IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object