com.attivio.sdk.search.facet

Class RangeFacetBucket

java.lang.Object

com.attivio.sdk.search.facet.FacetBucket

com.attivio.sdk.search.facet.RangeFacetBucket

All Implemented Interfaces:

Serializable, Cloneable

public class RangeFacetBucket
extends FacetBucket

A bucket for a range of values.

NOTE: A range bucket's primary sort value is the upper bounds of the range. The secondary sort value is the range's lower bounds.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.attivio.sdk.search.facet.FacetBucket

count

Constructor Summary

Constructors

Constructor and Description
RangeFacetBucket(Date min, Date max, long count) Constructor.
RangeFacetBucket(FacetRange range, long count) Constructor.
RangeFacetBucket(FacetRange range, long count, int ordinal) Constructor.
RangeFacetBucket(Number min, Number max, long count) Constructor.
RangeFacetBucket(String label, Date min, Date max, long count) Constructor.
RangeFacetBucket(String label, Number min, Number max, long count) Constructor.

Method Summary

Modifier and Type	Method and Description
int	compareValue(FacetBucket other) Compare the value of this bucket to other bucket.
boolean	equals(Object other)
String	getDisplayValue() Get a string value that is suitable as a display value for this bucket.
String	getLabel() Get the label for this bucket.
Object	getMaxValue() Get the maximum value for this range (exclusive).
Object	getMinValue() Get the minimum value for this range (inclusive).
int	getOrdinal() Get the ordinal or this bucket.
Query	getQueryFilter(FacetResponse facet) Get the Query to use for drilling down on this bucket.
FacetRange	getRange() Get the range for this bucket.
Comparable<?>	getSortValue() Get the value suitable for ordering/hashing buckets.
int	hashCode()
void	setLabel(String value) Set the label for this bucket.
void	setOrdinal(int value) Set the ordinal or this bucket.
void	setRange(FacetRange value) Set the range for this bucket.
String	toString()

Methods inherited from class com.attivio.sdk.search.facet.FacetBucket

clone, getCount, setCount

Methods inherited from class java.lang.Object

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

Constructor Detail

RangeFacetBucket

public RangeFacetBucket(Number min,
                        Number max,
                        long count)

Constructor.

RangeFacetBucket

public RangeFacetBucket(String label,
                        Number min,
                        Number max,
                        long count)

Constructor.

RangeFacetBucket

public RangeFacetBucket(Date min,
                        Date max,
                        long count)

Constructor.

RangeFacetBucket

public RangeFacetBucket(String label,
                        Date min,
                        Date max,
                        long count)

Constructor.

RangeFacetBucket

public RangeFacetBucket(FacetRange range,
                        long count)

Constructor.

RangeFacetBucket

public RangeFacetBucket(FacetRange range,
                        long count,
                        int ordinal)

Constructor.

Method Detail

getRange

public FacetRange getRange()

Get the range for this bucket.

setRange

public void setRange(FacetRange value)

Set the range for this bucket.

getLabel

public String getLabel()

Get the label for this bucket.

setLabel

public void setLabel(String value)

Set the label for this bucket.

getMinValue

public Object getMinValue()

Get the minimum value for this range (inclusive).

getMaxValue

public Object getMaxValue()

Get the maximum value for this range (exclusive).

getOrdinal

public int getOrdinal()

Get the ordinal or this bucket.

The ordinal value corresponds to the order this filter for this bucket was added to the RangeFacetRequest.

setOrdinal

public void setOrdinal(int value)

Set the ordinal or this bucket.

The ordinal value corresponds to the order this filter for this bucket was added to the RangeFacetRequest.

getDisplayValue

public String getDisplayValue()

Description copied from class: FacetBucket

Get a string value that is suitable as a display value for this bucket.

Specified by:

getDisplayValue in class FacetBucket

getQueryFilter

public Query getQueryFilter(FacetResponse facet)

Get the Query to use for drilling down on this bucket.

Specified by:

getQueryFilter in class FacetBucket

getSortValue

public Comparable<?> getSortValue()

Get the value suitable for ordering/hashing buckets.

Specified by:

getSortValue in class FacetBucket

compareValue

public int compareValue(FacetBucket other)

Compare the value of this bucket to other bucket.

NOTE: comparison ignores case in general.

Specified by:

compareValue in class FacetBucket

hashCode

public int hashCode()

Overrides:

hashCode in class FacetBucket

equals

public boolean equals(Object other)

Overrides:

equals in class FacetBucket

toString

public String toString()

Overrides:

toString in class Object