com.attivio.sdk.search.facet

Class SchemaFieldBucket

java.lang.Object

com.attivio.sdk.search.facet.FacetBucket

com.attivio.sdk.search.facet.SchemaFieldBucket

All Implemented Interfaces:

Serializable, Cloneable

public class SchemaFieldBucket
extends FacetBucket

A bucket returned for a SchemaFacetRequest.

See Also:

Serialized Form

Field Summary

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

count

Constructor Summary

Constructors

Constructor and Description
SchemaFieldBucket(String field, long count)
SchemaFieldBucket(String field, long count, long valueCount)

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	getField()
Query	getQueryFilter(FacetResponse facet) Get the Query to use for drilling down on this bucket.
Comparable<?>	getSortValue() Get the value suitable for ordering/hashing buckets.
long	getValueCount() Get the number of unique field values for the field represented by this bucket.
int	hashCode()
void	setField(String value)
void	setValueCount(long count) Get the number of unique field values for the field represented by this bucket.

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

clone, getCount, setCount

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaFieldBucket

public SchemaFieldBucket(String field,
                         long count)

SchemaFieldBucket

public SchemaFieldBucket(String field,
                         long count,
                         long valueCount)

Method Detail

getField

public String getField()

setField

public void setField(String value)

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

getValueCount

public long getValueCount()

Get the number of unique field values for the field represented by this bucket.

setValueCount

public void setValueCount(long count)

Get the number of unique field values for the field represented by this bucket.

getSortValue

public Comparable<?> getSortValue()

Description copied from class: FacetBucket

Get the value suitable for ordering/hashing buckets.

Specified by:

getSortValue in class FacetBucket

compareValue

public int compareValue(FacetBucket other)

Description copied from class: FacetBucket

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