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

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `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 name of the facet field this faceting request is defined on

    - #### getSort

          FacetSortOrder getSort()

      Returns:
        the sort order of the returned `Facet`s 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

Copyright © 2006-2017 Red Hat, Inc. All Rights Reserved