org.hibernate.search.query.facet

Interface FacetingRequest

public interface FacetingRequest

Faceting request interface.

Author:

Hardy Ferentschik

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_FACET_COUNT The default maximum number of facets when getMaxNumberOfFacets() is negative.

Method Summary

Modifier and Type	Method and Description
String	getFacetingName()
String	getFieldName()
int	getMaxNumberOfFacets()
FacetSortOrder	getSort()
boolean	hasZeroCountsIncluded()

Field Detail

DEFAULT_MAX_FACET_COUNT

static final int DEFAULT_MAX_FACET_COUNT

The default maximum number of facets when getMaxNumberOfFacets() is negative.

See Also:

Constant Field Values

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 name of the facet field 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