Package org.hibernate.search.query.dsl.impl

Class FacetingRequestImpl

java.lang.Object
org.hibernate.search.query.dsl.impl.FacetingRequestImpl
All Implemented Interfaces:
FacetingRequest
Direct Known Subclasses:
DiscreteFacetRequest, RangeFacetRequest
public abstract class FacetingRequestImpl extends Object implements FacetingRequest
Base class for faceting requests.

  • Constructor Details

    • FacetingRequestImpl

      public FacetingRequestImpl(String name, String fieldName)

  • Method Details

    • getFacetingName

      public String getFacetingName()
      Specified by:
      getFacetingName in interface FacetingRequest
      Returns:
      the name of this faceting request. The faceting name can be an arbitrary string.

    • getFieldName

      public String getFieldName()
      Specified by:
      getFieldName in interface FacetingRequest
      Returns:
      the Document field name on which this faceting request is defined on

    • setSort

      public void setSort(FacetSortOrder sort)

    • getSort

      public FacetSortOrder getSort()
      Specified by:
      getSort in interface FacetingRequest
      Returns:
      the sort order of the returned Facets for this request

    • getMaxNumberOfFacets

      public int getMaxNumberOfFacets()
      Specified by:
      getMaxNumberOfFacets in interface FacetingRequest
      Returns:
      the maximum number of facets returned for this request

    • setMaxNumberOfFacets

      public void setMaxNumberOfFacets(int maxNumberOfFacets)

    • getFieldCacheType

      public abstract Class<?> getFieldCacheType()

    • createFacet

      public abstract Facet createFacet(String value, int count)

    • hasZeroCountsIncluded

      public boolean hasZeroCountsIncluded()
      Specified by:
      hasZeroCountsIncluded in interface FacetingRequest
      Returns:
      true if facets with a count of 0 should be included in the returned facet list

    • setIncludeZeroCounts

      public void setIncludeZeroCounts(boolean includeZeroCounts)

    • toString

      public String toString()
      Overrides:
      toString in class Object