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

# Package org.apache.lucene.sandbox.facet.iterators

package org.apache.lucene.sandbox.facet.iterators
Sandbox faceting: facet ordinals.

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

- Related Packages
  Package
  Description
  org.apache.lucene.sandbox.facet
  Sandbox faceting - Collectors that compute facets.
  org.apache.lucene.sandbox.facet.cutters
  Sandbox faceting: facet cutters, see `FacetCutter` for details.
  org.apache.lucene.sandbox.facet.labels
  Sandbox faceting: facet labels, see `OrdToLabel` for details.
  org.apache.lucene.sandbox.facet.recorders
  Sandbox faceting: classes that can record per ordinal data E.g.
  org.apache.lucene.sandbox.facet.utils
  Sandbox faceting: utility classes to make it easier to use the new API for standard use cases.
- Class
  Description
  CandidateSetOrdinalIterator
  `OrdinalIterator` that filters out ordinals from delegate if they are not in the candidate set.
  ComparableSupplier<T extends Comparable<T>>
  Generates `Comparable` for provided ordinal.
  LengthOrdinalIterator
  `OrdinalIterator` passes through all ordinals as is and counts them.
  OrdinalIterator
  Iterate over ordinals.
  TaxonomyChildrenOrdinalIterator
  Facets results selector to get children for selected parent.
  TopnOrdinalIterator<T extends Comparable<T>>
  Class that consumes incoming ordinals, sorts them by provided Comparable, and returns first top N ordinals only.