com.attivio.sdk.search.facet

Class QueryFacetBucket

java.lang.Object

com.attivio.sdk.search.facet.FacetBucket

com.attivio.sdk.search.facet.QueryFacetBucket

All Implemented Interfaces:

Serializable, Cloneable

public class QueryFacetBucket
extends FacetBucket

A FacetBucket that contains a query for drilldown.

See Also:

Serialized Form

Field Summary

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

count

Constructor Summary

Constructors

Constructor and Description
QueryFacetBucket(String label, Query filter, long count) Constructor.
QueryFacetBucket(String label, Query filter, long count, int ordinal) Constructor.

Method Summary

Modifier and Type	Method and Description
QueryFacetBucket	clone()
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.
Query	getFilter() Get the filter for this bucket.
String	getLabel() Get the label for this bucket.
int	getOrdinal() Get the ordinal or this bucket.
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.
int	hashCode()
void	setFilter(Query value) Set the filter for this bucket.
void	setLabel(String label) Set the label for this bucket.
void	setOrdinal(int value) Set the ordinal or this bucket.

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

getCount, setCount

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryFacetBucket

public QueryFacetBucket(String label,
                        Query filter,
                        long count)

Constructor.

QueryFacetBucket

public QueryFacetBucket(String label,
                        Query filter,
                        long count,
                        int ordinal)

Constructor.

Method Detail

getLabel

public String getLabel()

Get the label for this bucket.

setLabel

public void setLabel(String label)

Set the label for this bucket.

getFilter

public Query getFilter()

Get the filter for this bucket.

setFilter

public void setFilter(Query value)

Set the filter for this bucket.

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 FilterBasedFacetRequest.

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 FilterBasedFacetRequest.

getDisplayValue

public String getDisplayValue()

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)

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

clone

public QueryFacetBucket clone()

Overrides:

clone in class FacetBucket