Package com.attivio.sdk.search.facet

Class FacetBucket

java.lang.Object

com.attivio.sdk.search.facet.FacetBucket

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

QueryFacetBucket, RangeFacetBucket, SchemaFieldBucket

public class FacetBucket
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

A bucket in a FacetResponse.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected FacetBuckets	children
protected long	count
protected java.lang.Object	value

Constructor Summary

Constructors

Constructor	Description
FacetBucket()
FacetBucket(Point value, long count)
FacetBucket(FacetRange range, long count)
FacetBucket(Query query, long count)
FacetBucket(java.lang.Boolean value, long count)
FacetBucket(java.lang.Number value, long count)
FacetBucket(java.lang.String value, long count)
FacetBucket(java.util.Date value, long count)

Method Summary

Modifier and Type	Method	Description
void	add(FacetBucket other)	Add the count for other to this bucket.
boolean	booleanValue()	Gets the value as a boolean.
FacetBucket	clone()
protected static java.lang.Object	clone(java.lang.Object value)
java.util.Date	dateValue()	Gets the value as a Date.
java.math.BigDecimal	decimalValue()	Gets the value as a BigDecimal.
double	doubleValue()	Gets the value as a double.
boolean	equals(java.lang.Object other)
protected static boolean	equals(java.lang.Object a, java.lang.Object b)
float	floatValue()	Gets the value as a float.
FacetBuckets	getChildren()	Get the child buckets.
long	getCount()	Get the count for this bucket.
protected java.lang.Long	getDate()
java.lang.String	getDisplayValue()	Get a string value that is suitable as a display value for this bucket.
static java.lang.String	getDisplayValue(java.lang.Object value, java.lang.String defaultValue)	Get a display value for value
protected Query	getFilter()	JSON SUPPORT FOLLOWS
Query	getQueryFilter(FacetResponse facet)	Deprecated. use getQueryFilter(String) instead.
Query	getQueryFilter(java.lang.String field)	Get the Query to use for drilling down on this bucket via field.
FacetRange	getRange()	Get the range for this bucket, or null if this bucket does not represent a range.
java.lang.Comparable<?>	getSortValue()	Deprecated. use getValue() instead.
FacetStatistics	getStatistics()	Get the FacetStatistics for child buckets, or null if not available.
java.lang.Object	getValue()	Get the value for this bucket.
protected java.lang.Object	getValue_json()
int	hashCode()
int	intValue()	Gets the value as an int.
long	longValue()	Gets the value as a long.
Point	pointValue()	Gets the value as a Point.
FacetBucket	setChildren(FacetBuckets value)	Set the child buckets.
void	setCount(long count)	Set the count for this bucket.
protected void	setDate(long value)
void	setValue(double value)
void	setValue(long value)
void	setValue(Point value)	Set a Point value.
void	setValue(FacetRange value)	Set the range for this bucket.
void	setValue(Query value)	Set a Query value.
void	setValue(java.lang.Boolean value)	Set a Boolean value.
void	setValue(java.lang.Number value)	Set a numeric value.
void	setValue(java.lang.String value)	Set a String value.
void	setValue(java.util.Date value)	Set a Date value.
protected void	setValue_json(java.lang.Object value)
java.lang.String	stringValue()	Gets the value as a string.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

value

protected java.lang.Object value

count

protected long count

children

protected FacetBuckets children

Constructor Detail

FacetBucket

public FacetBucket()

FacetBucket

public FacetBucket(java.lang.String value,
                   long count)

FacetBucket

public FacetBucket(java.lang.Number value,
                   long count)

FacetBucket

public FacetBucket(java.util.Date value,
                   long count)

FacetBucket

public FacetBucket(java.lang.Boolean value,
                   long count)

FacetBucket

public FacetBucket(Point value,
                   long count)

FacetBucket

public FacetBucket(FacetRange range,
                   long count)

FacetBucket

public FacetBucket(Query query,
                   long count)

Method Detail

getValue

public java.lang.Object getValue()

Get the value for this bucket.

getRange

public FacetRange getRange()

Get the range for this bucket, or null if this bucket does not represent a range.

stringValue

public java.lang.String stringValue()

Gets the value as a string.

intValue

public int intValue()

Gets the value as an int.

Throws:

java.lang.IllegalArgumentException - if this value cannot be represented as an int.

longValue

public long longValue()

Gets the value as a long.

Throws:

java.lang.IllegalArgumentException - if this value cannot be represented as a long.

doubleValue

public double doubleValue()

Gets the value as a double.

Throws:

java.lang.IllegalArgumentException - if this value cannot be represented as a double.

floatValue

public float floatValue()

Gets the value as a float.

Throws:

java.lang.IllegalArgumentException - if this value cannot be represented as a float.

dateValue

public java.util.Date dateValue()

Gets the value as a Date.

Throws:

java.lang.IllegalArgumentException - if this value cannot be represented as a Date.

booleanValue

public boolean booleanValue()

Gets the value as a boolean.

Throws:

java.lang.IllegalArgumentException - if this value cannot be represented as a boolean.

pointValue

public Point pointValue()

Gets the value as a Point.

Throws:

java.lang.IllegalArgumentException - if this value cannot be represented as a Point.

decimalValue

public java.math.BigDecimal decimalValue()

Gets the value as a BigDecimal.

Throws:

java.lang.IllegalArgumentException - if this value cannot be represented as a BigDecimal.

setValue

public void setValue(java.lang.String value)

Set a String value.

setValue

public void setValue(java.lang.Number value)

Set a numeric value.

setValue

public void setValue(long value)

setValue

public void setValue(double value)

setValue

public void setValue(java.util.Date value)

Set a Date value.

setValue

public void setValue(java.lang.Boolean value)

Set a Boolean value.

setValue

public void setValue(Point value)

Set a Point value.

setValue

public void setValue(Query value)

Set a Query value.

setValue

public void setValue(FacetRange value)

Set the range for this bucket.

getSortValue

@Deprecated
public java.lang.Comparable<?> getSortValue()

Deprecated.

use getValue() instead.

getDisplayValue

public java.lang.String getDisplayValue()

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

getCount

public long getCount()

Get the count for this bucket.

setCount

public void setCount(long count)

Set the count for this bucket.

add

public void add(FacetBucket other)

Add the count for other to this bucket.

getChildren

public FacetBuckets getChildren()

Get the child buckets.

Returns null if no child buckets exist.

setChildren

public FacetBucket setChildren(FacetBuckets value)

Set the child buckets.

getStatistics

public FacetStatistics getStatistics()

Get the FacetStatistics for child buckets, or null if not available.

getQueryFilter

public Query getQueryFilter(java.lang.String field)

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

getQueryFilter

@Deprecated
public Query getQueryFilter(FacetResponse facet)

Deprecated.

use getQueryFilter(String) instead.

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

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

clone

public FacetBucket clone()

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

protected static java.lang.Object clone(java.lang.Object value)

equals

protected static boolean equals(java.lang.Object a,
                                java.lang.Object b)

getDisplayValue

public static java.lang.String getDisplayValue(java.lang.Object value,
                                               java.lang.String defaultValue)

Get a display value for value

getFilter

protected Query getFilter()

JSON SUPPORT FOLLOWS

getDate

protected java.lang.Long getDate()

setDate

protected void setDate(long value)

getValue_json

protected java.lang.Object getValue_json()

setValue_json

protected void setValue_json(java.lang.Object value)