org.jahia.services.search

Class FieldFacetDefinition

java.lang.Object

org.jahia.services.search.SearchCriteria.BaseFacetDefinition

org.jahia.services.search.FieldFacetDefinition

All Implemented Interfaces:

Serializable

public class FieldFacetDefinition
extends SearchCriteria.BaseFacetDefinition

Definition of a field facet.
Note, please, if you are creating a sub-class for this class and adding fields, be sure to override SearchCriteria.BaseFacetDefinition.hashCode() and SearchCriteria.BaseFacetDefinition.equals(Object) methods.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FieldFacetDefinition(String id, String fieldName, int maxGroups) Create a field facet definition instance.

Method Summary

Modifier and Type	Method and Description
String	getFieldName()

Methods inherited from class org.jahia.services.search.SearchCriteria.BaseFacetDefinition

equals, getField, getId, getMaxFacetResults, hashCode, setField

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldFacetDefinition

public FieldFacetDefinition(String id,
                            String fieldName,
                            int maxGroups)

Create a field facet definition instance.

Parameters:

id - the unique identifier for this facet definition

fieldName - Facet field name

maxGroups - The max number of result groups the facet should return

Method Detail

getFieldName

public String getFieldName()

Returns:

Facet field name