org.jahia.services.search

Class SearchCriteria.BaseFacetDefinition

java.lang.Object

org.jahia.services.search.SearchCriteria.BaseFacetDefinition

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FieldFacetDefinition

Enclosing class:

SearchCriteria

public static class SearchCriteria.BaseFacetDefinition
extends Object
implements Serializable

Base class for all facet definitions; encapsulates any common facet definition attributes like sort order of aggregated results. Note, please, if you are creating a sub-class for this class and adding fields, be sure to override hashCode() and equals(Object) methods.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BaseFacetDefinition(String id, int maxFacetResults) Create a facet definition instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	getField(String dataField) Retrieves the value of the specified data field.
String	getId()
int	getMaxFacetResults()
int	hashCode()
void	setField(String dataField, Object value) Sets the value of the data field to the specified one.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseFacetDefinition

public BaseFacetDefinition(String id,
                           int maxFacetResults)

Create a facet definition instance.

Parameters:

id - an unique identifier for this facet definition. This helps differentiate facet definitions that are of the same type but are operating on different data objects

maxFacetResults - the maximum number of facet results (different facet values) the facet should return

Method Detail

getId

public String getId()

Returns:

the unique identifier for this facet definition

getMaxFacetResults

public int getMaxFacetResults()

Returns:

the maximum number of facet results (different facet values) the facet should return

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getField

public Object getField(String dataField)

Retrieves the value of the specified data field.

Parameters:

dataField - the data field name to retrieve value for

Returns:

the value of the requested data field

setField

public void setField(String dataField,
                     Object value)

Sets the value of the data field to the specified one.

Parameters:

dataField - the data field name

value - the value