BucketValue (container-search 7.464.41 API)

java.lang.Object
- com.yahoo.search.grouping.request.GroupingNode
- - com.yahoo.search.grouping.request.GroupingExpression
  - - com.yahoo.search.grouping.request.BucketValue

All Implemented Interfaces:

java.lang.Comparable<BucketValue>

Direct Known Subclasses:

DoubleBucket, LongBucket, RawBucket, StringBucket
```
public class BucketValue
extends GroupingExpression
implements java.lang.Comparable<BucketValue>
```
This class represents a bucket in a PredefinedFunction. The generic T is the data type of the range values 'from' and 'to'. The range is inclusive-from and exclusive-to. All supported data types are represented as subclasses of this.

Author:

Simon Thoresen Hult

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`BucketValue(java.lang.String label, java.lang.Integer level, ConstantValue<?> inclusiveFrom, ConstantValue<?> exclusiveTo)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(BucketValue rhs)`
`BucketValue`	`copy()`	Returns a deep copy of this
`boolean`	`equals(java.lang.Object o)`
`ConstantValue<?>`	`getFrom()`	Returns the inclusive-from value of this bucket.
`ConstantValue<?>`	`getTo()`	Returns the exclusive-to value of this bucket.
`int`	`hashCode()`

Methods inherited from class com.yahoo.search.grouping.request.GroupingExpression
asImage, asString, getLevel, getLevelOrNull, resolveLevel, setLabel, visit

Methods inherited from class com.yahoo.search.grouping.request.GroupingNode
getImage, getLabel, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BucketValue
```
protected BucketValue(java.lang.String label,
                      java.lang.Integer level,
                      ConstantValue<?> inclusiveFrom,
                      ConstantValue<?> exclusiveTo)
```
- Method Detail
  - copy
```
public BucketValue copy()
```
    Description copied from class: GroupingExpression
    
    Returns a deep copy of this
    
    Specified by:
    
    copy in class GroupingExpression
  - getFrom
```
public ConstantValue<?> getFrom()
```
    Returns the inclusive-from value of this bucket.
    
    Returns:
    
    The from-value.
  - getTo
```
public ConstantValue<?> getTo()
```
    Returns the exclusive-to value of this bucket.
    
    Returns:
    
    The to-value.
  - compareTo
```
public int compareTo(BucketValue rhs)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<BucketValue>
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object