org.hibernate.search.query.facet
Interface FacetingRequest

All Known Implementing Classes:

DiscreteFacetRequest, FacetingRequestImpl, RangeFacetRequest

public interface FacetingRequest

Faceting request interface.

Author:

Hardy Ferentschik

Method Summary

String	getFacetingName()
String	getFieldName()
int	getMaxNumberOfFacets()
FacetSortOrder	getSort()
boolean	hasZeroCountsIncluded()

Method Detail

getFacetingName

String getFacetingName()

Returns:

the name of this faceting request. The faceting name can be an arbitrary string.

getFieldName

String getFieldName()

Returns:

the Document field name on which this faceting request is defined on

getSort

FacetSortOrder getSort()

Returns:

the sort order of the returned Facets for this request

getMaxNumberOfFacets

int getMaxNumberOfFacets()

Returns:

the maximum number of facets returned for this request

hasZeroCountsIncluded

boolean hasZeroCountsIncluded()

Returns:

true if facets with a count of 0 should be included in the returned facet list