Package org.apache.lucene.sandbox.facet

package org.apache.lucene.sandbox.facet
Sandbox faceting - Collectors that compute facets.

See org.apache.lucene.sandbox.facet.utils for simple API for most common use cases.

Lower level API is based on following concepts:

  • Facet Ordinals/Ids: Each doc may have different facets and therefore, different facet ordinals. For example a book can have Author, Publish Date, Page Count etc. as facets. The specific value for each of these Facets for a book can be mapped to an ordinal. Facet ordinals may be common across different book documents.
  • Facet Cutter: Can interpret Facets of a specific type for a doc type and output all the Facet Ordinals for the type for the doc.
  • Facet Recorders: record data per ordinal. Some recorders may compute aggregations and record per ordinal data aggregated across an index.

See SandboxFacetsExample for examples.

WARNING: This API is experimental and might change in incompatible ways in the next release.