Package org.apache.lucene.facet.taxonomy
package org.apache.lucene.facet.taxonomy
Taxonomy of Categories.
Facets are defined using a hierarchy of categories, known as a Taxonomy. For example, the taxonomy of a book store application might have the following structure:
- Author
- Mark Twain
- J. K. Rowling
- Date
- 2010
- March
- April
- 2009
The Taxonomy translates category-paths into integer identifiers (often termed
ordinals) and vice versa. The category Author/Mark Twain
adds two nodes to
the taxonomy: Author
and Author/Mark Twain
, each is assigned a
different ordinal. The taxonomy maintains the invariant that a node always has an ordinal that is
< all its children.
-
ClassDescriptionAdd an instance of this to your
Document
to add a facet label associated with an arbitrary byte[].Deprecated.Only here for back-compat support.Deprecated.Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9Holds the cached ordinals in two parallelint[]
arrays.Deprecated.Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9Holds a sequence of string components, specifying the hierarchical name of a category.Computes facets counts, assuming the default encoding into DocValues was used.Add an instance of this to yourDocument
to add a facet label associated with a float.Deprecated.Visibility of this class will be reduced to pkg-private in a future version.Add an instance of this to yourDocument
to add a facet label associated with an int.Deprecated.Visibility of this class will be reduced to pkg-private in a future version.LRUHashMap<K,V> LRUHashMap is an extension of Java's HashMap, which has a bounded size(); When it reaches that size, each time a new element is added, the least recently used (LRU) entry is removed.AFilterLeafReader
for updating facets ordinal references, based on an ordinal map.Deprecated.Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9Returns ordinals for documents in one segment.Returns 3 arrays for traversing the taxonomy:parents
:parents[i]
denotes the parent of category ordinali
.Prints how many ords are under each dimension.Manages near-real-time reopen of both an IndexSearcher and a TaxonomyReader.Holds a matched pair ofIndexSearcher
andTaxonomyReader
Deprecated.Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9.Utility class to easily retrieve previously indexed facet labels, allowing you to skip also adding stored fields for these values, reducing your index size.Deprecated.Visibility of this class will be reduced to pkg-private in a future version.Aggregates sum of int values previously indexed withFloatAssociationFacetField
, assuming the default encoding.Aggregates sum of int values previously indexed withIntAssociationFacetField
, assuming the default encoding.Aggregates sum of values fromDoubleValues.doubleValue()
, for each facet label.Utility methods for merging index and taxonomy directories.TaxonomyReader is the read-only interface with which the faceted-search library uses the taxonomy during search time.An iterator over a category's children.TaxonomyWriter is the interface which the faceted-search library uses to dynamically build the taxonomy at indexing time.