com.attivio.sdk.search.facet

Class FacetBucket

java.lang.Object

com.attivio.sdk.search.facet.FacetBucket

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

QueryFacetBucket, RangeFacetBucket, SchemaFieldBucket, TermFacetBucket

public abstract class FacetBucket
extends Object
implements Cloneable, Serializable

A bucket in a FacetResponse.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected long	count The count

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FacetBucket()
protected	FacetBucket(long count)

Method Summary

Modifier and Type	Method and Description
FacetBucket	clone()
abstract int	compareValue(FacetBucket other) Compare the value of this bucket to other bucket.
boolean	equals(Object other)
long	getCount() Get the count for this bucket.
abstract String	getDisplayValue() Get a string value that is suitable as a display value for this bucket.
abstract Query	getQueryFilter(FacetResponse facet) Get the Query to use for drilling down on this bucket.
abstract Comparable<?>	getSortValue() Get the value suitable for ordering/hashing buckets.
int	hashCode()
void	setCount(long count) Set the count for this bucket.

Methods inherited from class java.lang.Object

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

Field Detail

count

protected long count

The count

Constructor Detail

FacetBucket

protected FacetBucket()

FacetBucket

protected FacetBucket(long count)

Method Detail

getDisplayValue

public abstract 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.

getQueryFilter

public abstract Query getQueryFilter(FacetResponse facet)

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

getSortValue

public abstract Comparable<?> getSortValue()

Get the value suitable for ordering/hashing buckets.

compareValue

public abstract int compareValue(FacetBucket other)

Compare the value of this bucket to other bucket.

NOTE: comparison ignores case in general.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

clone

public FacetBucket clone()

Overrides:

clone in class Object