org.apache.lucene.facet.facetset (Lucene 10.5.1 facet API)
Description: declaration: package: org.apache.lucene.facet.facetset

# Package org.apache.lucene.facet.facetset

package org.apache.lucene.facet.facetset
Provides FacetSets faceting capabilities which allows users to facet on high dimensional field values. See FacetSets.adoc in the docs folder for more information on usage.

- Related Packages
  Package
  Description
  org.apache.lucene.facet
  Faceted search.
  org.apache.lucene.facet.range
  Provides range faceting capabilities.
  org.apache.lucene.facet.rangeonrange
  Provides range on range faceting capabilities.
  org.apache.lucene.facet.sortedset
  Provides faceting capabilities over facets that were indexed with `SortedSetDocValuesFacetField`.
  org.apache.lucene.facet.taxonomy
  Taxonomy of Categories.
- Class
  Description
  DimRange
  Defines a single range in a `FacetSet` dimension.
  DoubleFacetSet
  A `FacetSet` which encodes double dimension values.
  ExactFacetSetMatcher
  A `FacetSetMatcher` which considers a set as a match only if all dimension values are equal to the given one.
  FacetSet
  Holds a set of facet dimension values.
  FacetSetDecoder
  A functional interface for decoding facet set values into comparable `long` ones.
  FacetSetMatcher
  Matches the encoded `FacetSet` that was indexed in `FacetSetsField`.
  FacetSetsField
  A `BinaryDocValuesField` which encodes a list of `facet sets`.
  FloatFacetSet
  A `FacetSet` which encodes float dimension values.
  IntFacetSet
  A `FacetSet` which encodes integer dimension values.
  LongFacetSet
  A `FacetSet` which encodes long dimension values.
  MatchingFacetSetsCounts
  Returns the counts for each given `FacetSet`
  RangeFacetSetMatcher
  A `FacetSetMatcher` which considers a set as a match if all dimensions fall within the given corresponding range.