Package org.hibernate.search.query.engine.spi

Interface FacetManager

public interface FacetManager
Deprecated.
Instead of using Hibernate Search 5 APIs, get a org.hibernate.search.mapper.orm.session.SearchSession using org.hibernate.search.mapper.orm.Search#session(org.hibernate.Session), create a SearchQuery with org.hibernate.search.mapper.orm.session.SearchSession#search(Class), and define your facets (now called aggregations) using SearchQueryOptionsStep.aggregation(AggregationKey, Function). You can then fetch the query result using SearchFetchable.fetch(Integer) and get each aggregation using SearchResult.aggregation(AggregationKey). Refer to the migration guide for more information.
Interface defining methods around faceting.
Author:
Hardy Ferentschik

  • Method Details

    • enableFaceting

      FacetManager enableFaceting(FacetingRequest facetingRequest)
      Deprecated.
      Enable a facet request.
      Parameters:
      facetingRequest - the faceting request
      Returns:
      this to allow method chaining

    • disableFaceting

      void disableFaceting(String facetingName)
      Deprecated.
      Disable a facet with the given name.
      Parameters:
      facetingName - the name of the facet to disable.

    • getFacets

      List<Facet> getFacets(String facetingName)
      Deprecated.
      Returns the Facets for a given facet name
      Parameters:
      facetingName - the facet name for which to return the facet list
      Returns:
      the facet result list which corresponds to the facet request with the given name. The empty list is returned for an unknown facet name.
      See Also: