Package org.hibernate.search.query.facet

Interface Facet

All Known Subinterfaces:
RangeFacet<T>
All Known Implementing Classes:
AbstractFacet, RangeFacetImpl
public interface Facet
A single facet (field value and count).

  • Method Details

    • getFacetingName

      String getFacetingName()
      Returns:
      the faceting name this Facet belongs to. See FacetingRequest.getFacetingName().

    • getFieldName

      String getFieldName()
      Returns:
      the Document field name this facet was created for

    • getValue

      String getValue()
      Returns:
      the value of this facet. In case of a discrete facet it is the actual Document field value. In case of a range query the value is a string representation of the range

    • getCount

      int getCount()
      Returns:
      the faceting count

    • getFacetQuery

      Query getFacetQuery()
      Returns:
      a Lucene Query which can be applied just targeted all documents matching the value of this facet