com.attivio.sdk.search.facet

Class FacetFilter

java.lang.Object

com.attivio.sdk.search.facet.FacetFilter

All Implemented Interfaces:

Serializable, Cloneable

public class FacetFilter
extends Object
implements Cloneable, Serializable

A filter for applying the result of a FacetBucket to a query.

Use FacetResponse.getFacetFilter(FacetBucket) to create a FacetFilter for drilldown.

See Also:

FacetBucket, FacetResponse, Serialized Form

Constructor Summary

Constructors

Constructor and Description
FacetFilter()

Method Summary

Modifier and Type	Method and Description
FacetFilter	clone()
boolean	equals(Object other)
Query	getFilter() Get the filter query.
String	getLabel() Get a descriptive label for this filter.
String	getName() Get the name of the facet that generated this filter.
int	hashCode()
void	setFilter(Query value) Get the filter query.
void	setLabel(String value) Set a descriptive label for this filter.
void	setName(String value) Set the name of the facet that generated this filter.
String	toString()
static FacetFilter	valueOf(Object value) Parse a FacetFilter specified in value.
static FacetFilter	valueOf(String value) Parse a FacetFilter specified in value.

Methods inherited from class java.lang.Object

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

Constructor Detail

FacetFilter

public FacetFilter()

Method Detail

getName

public String getName()

Get the name of the facet that generated this filter.

setName

public void setName(String value)

Set the name of the facet that generated this filter.

getLabel

public String getLabel()

Get a descriptive label for this filter.

This will typically be the display value of the bucket used for filtering.

setLabel

public void setLabel(String value)

Set a descriptive label for this filter.

This will typically be the display value of the bucket used for filtering.

getFilter

public Query getFilter()

Get the filter query.

setFilter

public void setFilter(Query value)

Get the filter query.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

clone

public FacetFilter clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object

valueOf

public static FacetFilter valueOf(Object value)

Parse a FacetFilter specified in value.

valueOf

public static FacetFilter valueOf(String value)

Parse a FacetFilter specified in value.