Index (Lucene 9.9.1 facet API)

A B C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

accept(double) - Method in class org.apache.lucene.facet.range.DoubleRange: True if this range accepts the provided value.
accept(long) - Method in class org.apache.lucene.facet.range.LongRange: True if this range accepts the provided value.
add(String, String...) - Method in class org.apache.lucene.facet.DrillDownQuery: Adds one dimension of drill downs; if you pass the same dimension more than once it is OR'd with the previous constraints on that dimension, and all dimensions are AND'd against each other and the base query.
add(String, Query) - Method in class org.apache.lucene.facet.DrillDownQuery: Expert: add a custom drill-down subQuery.
addCategory(FacetLabel) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
addCategory(FacetLabel) - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyWriter: addCategory() adds a category with a given path name to the taxonomy, and returns its ordinal.
addDone() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.DiskOrdinalMap
addDone() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.MemoryOrdinalMap
addDone() - Method in interface org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.OrdinalMap: Call addDone() to say that all addMapping() have been done.
addLabel(FacetLabel, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.LabelToOrdinal: Adds a new label if it is not yet in the table.
addMapping(int, int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.DiskOrdinalMap
addMapping(int, int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.MemoryOrdinalMap
addMapping(int, int) - Method in interface org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.OrdinalMap: Record a mapping.
addTaxonomy(Directory, DirectoryTaxonomyWriter.OrdinalMap) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Takes the categories from the given taxonomy directory, and adds the missing ones to this taxonomy.
advance(int) - Method in class org.apache.lucene.facet.taxonomy.BackCompatSortedNumericDocValues: Deprecated.
advanceExact(int) - Method in class org.apache.lucene.facet.MultiDoubleValues: Advance to exactly doc and return whether doc has a value.
advanceExact(int) - Method in class org.apache.lucene.facet.MultiLongValues: Advance to exactly target and return whether target has a value.
advanceExact(int) - Method in class org.apache.lucene.facet.taxonomy.BackCompatSortedNumericDocValues: Deprecated.
aggregate(float, float) - Method in class org.apache.lucene.facet.taxonomy.AssociationAggregationFunction: Implement aggregation logic for floats
aggregate(int, int) - Method in class org.apache.lucene.facet.taxonomy.AssociationAggregationFunction: Implement aggregation logic for integers
aggregationFunction - Variable in class org.apache.lucene.facet.taxonomy.FloatTaxonomyFacets: Deprecated.

Aggregation function used for combining values.
aggregationFunction - Variable in class org.apache.lucene.facet.taxonomy.IntTaxonomyFacets: Deprecated.

Aggregation function used for combining values.
ALL - Enum constant in enum org.apache.lucene.facet.FacetsConfig.DrillDownTermsIndexing: Index dimension, sub-path and full-path drill down terms.
ALL_PATHS_NO_DIM - Enum constant in enum org.apache.lucene.facet.FacetsConfig.DrillDownTermsIndexing: Index sub-path and full-path drill down terms.
amortizeFacetCounts(FacetResult, FacetsConfig, IndexSearcher) - Method in class org.apache.lucene.facet.RandomSamplingFacetsCollector: Note: if you use a counting Facets implementation, you can amortize the sampled counts by calling this method.
assoc - Variable in class org.apache.lucene.facet.taxonomy.AssociationFacetField: Associated value.
AssociationAggregationFunction - Class in org.apache.lucene.facet.taxonomy: Specify aggregation logic used in TaxonomyFacetIntAssociations and TaxonomyFacetFloatAssociations.
AssociationAggregationFunction() - Constructor for class org.apache.lucene.facet.taxonomy.AssociationAggregationFunction: Sole constructor.
AssociationFacetField - Class in org.apache.lucene.facet.taxonomy: Add an instance of this to your Document to add a facet label associated with an arbitrary byte[].
AssociationFacetField(BytesRef, String, String...) - Constructor for class org.apache.lucene.facet.taxonomy.AssociationFacetField: Creates this from dim and path and an association

B

BackCompatSortedNumericDocValues - Class in org.apache.lucene.facet.taxonomy: Deprecated.
Only here for back-compat support. Should be removed with Lucene 10.
bits - Variable in class org.apache.lucene.facet.FacetsCollector.MatchingDocs: Which documents were seen.
build(Document) - Method in class org.apache.lucene.facet.FacetsConfig: Translates any added FacetFields into normal fields for indexing; only use this version if you did not add any taxonomy-based fields ( FacetField or AssociationFacetField).
build(TaxonomyWriter, Document) - Method in class org.apache.lucene.facet.FacetsConfig: Translates any added FacetFields into normal fields for indexing.
buildFacetsResult(FacetsCollector, FacetsCollector[], String[]) - Method in class org.apache.lucene.facet.DrillSideways: Subclass can override to customize per-dim Facets impl.
bytesRefToFloat(BytesRef) - Static method in class org.apache.lucene.facet.taxonomy.FloatAssociationFacetField: Decodes a previously encoded float.
bytesRefToInt(BytesRef) - Static method in class org.apache.lucene.facet.taxonomy.IntAssociationFacetField: Decodes a previously encoded int.

C

CachedOrdinalsReader - Class in org.apache.lucene.facet.taxonomy: Deprecated.
Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9
CachedOrdinalsReader(OrdinalsReader) - Constructor for class org.apache.lucene.facet.taxonomy.CachedOrdinalsReader: Deprecated.

Sole constructor.
CachedOrdinalsReader.CachedOrds - Class in org.apache.lucene.facet.taxonomy: Deprecated.

Holds the cached ordinals in two parallel int[] arrays.
CachedOrds(OrdinalsReader.OrdinalsSegmentReader, int) - Constructor for class org.apache.lucene.facet.taxonomy.CachedOrdinalsReader.CachedOrds: Deprecated.

Creates a new CachedOrdinalsReader.CachedOrds from the BinaryDocValues.
childCount - Variable in class org.apache.lucene.facet.FacetResult: How many child labels were encountered.
children() - Method in class org.apache.lucene.facet.taxonomy.ParallelTaxonomyArrays: Returns the children array, where children[i] denotes a child of category ordinal i.
childrenLoaded() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyFacets: Deprecated.

Returns true if the (costly, and lazily initialized) children int[] was initialized.
clear() - Method in class org.apache.lucene.facet.taxonomy.writercache.LruTaxonomyWriterCache
clear() - Method in interface org.apache.lucene.facet.taxonomy.writercache.TaxonomyWriterCache: Clears the content of the cache.
clear() - Method in class org.apache.lucene.facet.taxonomy.writercache.UTF8TaxonomyWriterCache: Deprecated.
clone() - Method in class org.apache.lucene.facet.DrillDownQuery
clone() - Method in class org.apache.lucene.facet.taxonomy.LRUHashMap
close() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Frees used resources as well as closes the underlying IndexWriter, which commits whatever changes made to it to the underlying Directory.
close() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader
close() - Method in class org.apache.lucene.facet.taxonomy.writercache.LruTaxonomyWriterCache
close() - Method in interface org.apache.lucene.facet.taxonomy.writercache.TaxonomyWriterCache: Let go of whatever resources the cache is holding.
close() - Method in class org.apache.lucene.facet.taxonomy.writercache.UTF8TaxonomyWriterCache: Deprecated.
closeResources() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: A hook for extending classes to close additional resources that were used.
collect(int) - Method in class org.apache.lucene.facet.FacetsCollector
collectorResult - Variable in class org.apache.lucene.facet.DrillSideways.ConcurrentDrillSidewaysResult: The merged search results
commit() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
compareTo(FacetLabel) - Method in class org.apache.lucene.facet.taxonomy.FacetLabel: Compares this path with another FacetLabel for lexicographic order.
components - Variable in class org.apache.lucene.facet.taxonomy.FacetLabel: The components of this FacetLabel.
ConcurrentSortedSetDocValuesFacetCounts - Class in org.apache.lucene.facet.sortedset: Like SortedSetDocValuesFacetCounts, but aggregates counts concurrently across segments.
ConcurrentSortedSetDocValuesFacetCounts(SortedSetDocValuesReaderState, ExecutorService) - Constructor for class org.apache.lucene.facet.sortedset.ConcurrentSortedSetDocValuesFacetCounts: Returns all facet counts, same result as searching on MatchAllDocsQuery but faster.
ConcurrentSortedSetDocValuesFacetCounts(SortedSetDocValuesReaderState, FacetsCollector, ExecutorService) - Constructor for class org.apache.lucene.facet.sortedset.ConcurrentSortedSetDocValuesFacetCounts: Counts all facet dimensions across the provided hits.
config - Variable in class org.apache.lucene.facet.DrillSideways: FacetsConfig passed to constructor.
config - Variable in class org.apache.lucene.facet.taxonomy.TaxonomyFacets: Deprecated.

FacetsConfig provided to the constructor.
context - Variable in class org.apache.lucene.facet.FacetsCollector.MatchingDocs: Context for this segment.
cost() - Method in class org.apache.lucene.facet.taxonomy.BackCompatSortedNumericDocValues: Deprecated.
count(String, List<FacetsCollector.MatchingDocs>) - Method in class org.apache.lucene.facet.range.DoubleRangeFacetCounts: Counts from the provided field.
count(String, List<FacetsCollector.MatchingDocs>) - Method in class org.apache.lucene.facet.range.LongRangeFacetCounts: Counts from the provided field.
count(String, List<FacetsCollector.MatchingDocs>, byte[][], int, RangeFieldQuery.QueryType) - Method in class org.apache.lucene.facet.rangeonrange.DoubleRangeOnRangeFacetCounts: Counts from the provided field.
count(String, List<FacetsCollector.MatchingDocs>, byte[][], int, RangeFieldQuery.QueryType) - Method in class org.apache.lucene.facet.rangeonrange.LongRangeOnRangeFacetCounts: Counts from the provided field.
counter - Variable in class org.apache.lucene.facet.taxonomy.writercache.LabelToOrdinal: How many ordinals we've seen.
counts - Variable in class org.apache.lucene.facet.range.DoubleRangeFacetCounts: Counts, initialized in by subclass.
counts - Variable in class org.apache.lucene.facet.range.LongRangeFacetCounts: Counts, initialized in by subclass.
create(String, FacetSet...) - Static method in class org.apache.lucene.facet.facetset.FacetSetsField: Create a new FacetSets field.
createDrillDownFacetsCollector() - Method in class org.apache.lucene.facet.DrillSideways: Subclass can override to customize drill down facets collector.
createDrillDownFacetsCollectorManager() - Method in class org.apache.lucene.facet.DrillSideways: Subclass can override to customize drill down facets collector.
createIndexWriterConfig(IndexWriterConfig.OpenMode) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Create the IndexWriterConfig that would be used for opening the internal index writer.
createIterator(FacetsCollector.MatchingDocs, DocIdSetIterator...) - Method in class org.apache.lucene.facet.FacetCountsWithFilterQuery: Create a DocIdSetIterator from the provided hits that relies on fastMatchQuery if available for first-pass filtering.
createManager(int, long) - Static method in class org.apache.lucene.facet.RandomSamplingFacetsCollector: Creates a CollectorManager for concurrent random sampling through RandomSamplingFacetsCollector

D

decode(BytesRef, int, long[]) - Method in interface org.apache.lucene.facet.facetset.FacetSetDecoder: Decodes the facet set dimension values into the given destination buffer and returns the number of bytes read.
decode(BytesRef, IntsRef) - Method in class org.apache.lucene.facet.taxonomy.DocValuesOrdinalsReader: Deprecated.

Subclass and override if you change the encoding.
decodeInts(BytesRef, int, long[]) - Static method in interface org.apache.lucene.facet.facetset.FacetSetDecoder: An implementation of FacetSetDecoder.decode(BytesRef, int, long[]) for int/float dimension values which were encoded with IntFacetSet and FloatFacetSet respectively.
decodeLongs(BytesRef, int, long[]) - Static method in interface org.apache.lucene.facet.facetset.FacetSetDecoder: An implementation of FacetSetDecoder.decode(BytesRef, int, long[]) for long/double dimension values which were encoded with LongFacetSet and DoubleFacetSet respectively.
decRef() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Expert: decreases the refCount of this TaxonomyReader instance.
decRef(SearcherTaxonomyManager.SearcherAndTaxonomy) - Method in class org.apache.lucene.facet.taxonomy.SearcherTaxonomyManager
dedupAndEncode(IntsRef) - Method in class org.apache.lucene.facet.FacetsConfig: Deprecated.
Starting in Lucene 9, we moved to a more straight-forward numeric doc values encoding and no longer support custom binary encodings.
DEFAULT_DIM_CONFIG - Static variable in class org.apache.lucene.facet.FacetsConfig: Default per-dimension configuration.
DEFAULT_INDEX_FIELD_NAME - Static variable in class org.apache.lucene.facet.FacetsConfig: Which Lucene field holds the drill-downs and ords (as doc values).
DefaultSortedSetDocValuesReaderState - Class in org.apache.lucene.facet.sortedset: Default implementation of SortedSetDocValuesFacetCounts.
DefaultSortedSetDocValuesReaderState(IndexReader) - Constructor for class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState: Deprecated.
Users should explicitly provide facet configuration during instantiation. See DefaultSortedSetDocValuesReaderState(IndexReader, FacetsConfig). To maintain all existing behavior, a "default" facet configuration can be provided with FacetsConfig().
DefaultSortedSetDocValuesReaderState(IndexReader, String) - Constructor for class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState: Deprecated.
Users should explicitly provide facet configuration during instantiation. See DefaultSortedSetDocValuesReaderState(IndexReader, String, FacetsConfig). To maintain all existing behavior, a "default" facet configuration can be provided with FacetsConfig().
DefaultSortedSetDocValuesReaderState(IndexReader, String, FacetsConfig) - Constructor for class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState: Creates this, pulling doc values from the specified field.
DefaultSortedSetDocValuesReaderState(IndexReader, FacetsConfig) - Constructor for class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState: Creates this with a config, pulling doc values from the default FacetsConfig.DEFAULT_INDEX_FIELD_NAME.
defaultTaxonomyWriterCache() - Static method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Defines the default TaxonomyWriterCache to use in constructors which do not specify one.
DELIM_CHAR - Static variable in class org.apache.lucene.facet.FacetsConfig: Character used to join the category path components together into a single drill down term for indexing.
dim - Variable in class org.apache.lucene.facet.FacetField: Dimension for this field.
dim - Variable in class org.apache.lucene.facet.FacetResult: Dimension that was requested.
dim - Variable in class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetField: Dimension.
dim - Variable in class org.apache.lucene.facet.taxonomy.AssociationFacetField: Dimension for this field.
DimConfig() - Constructor for class org.apache.lucene.facet.FacetsConfig.DimConfig: Default constructor.
DIMENSION_AND_FULL_PATH - Enum constant in enum org.apache.lucene.facet.FacetsConfig.DrillDownTermsIndexing: Index dimension and full-path drill down terms.
DimRange - Class in org.apache.lucene.facet.facetset: Defines a single range in a FacetSet dimension.
DimRange(long, long) - Constructor for class org.apache.lucene.facet.facetset.DimRange: Creates a LongRange.
dims - Variable in class org.apache.lucene.facet.facetset.FacetSet: The number of dimension values in this set.
dims - Variable in class org.apache.lucene.facet.facetset.FacetSetMatcher: The number of dimensions that are matched by this matcher.
dims - Variable in class org.apache.lucene.facet.rangeonrange.Range: Number of dims per range
dimStartOrd - Variable in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState.DimTree: The first ord of the dimension
DimTree(int, List<Integer>, List<Boolean>) - Constructor for class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState.DimTree: Sibling and children must be of same length
DirectoryTaxonomyReader - Class in org.apache.lucene.facet.taxonomy.directory: A TaxonomyReader which retrieves stored taxonomy information from a Directory.
DirectoryTaxonomyReader(DirectoryTaxonomyWriter) - Constructor for class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader: Opens a DirectoryTaxonomyReader over the given DirectoryTaxonomyWriter (for NRT).
DirectoryTaxonomyReader(Directory) - Constructor for class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader: Open for reading a taxonomy stored in a given Directory.
DirectoryTaxonomyWriter - Class in org.apache.lucene.facet.taxonomy.directory: TaxonomyWriter which uses a Directory to store the taxonomy information on disk, and keeps an additional in-memory cache of some or all categories.
DirectoryTaxonomyWriter(Directory) - Constructor for class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Create this with OpenMode.CREATE_OR_APPEND.
DirectoryTaxonomyWriter(Directory, IndexWriterConfig.OpenMode) - Constructor for class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Creates a new instance with a default cache as defined by DirectoryTaxonomyWriter.defaultTaxonomyWriterCache().
DirectoryTaxonomyWriter(Directory, IndexWriterConfig.OpenMode, TaxonomyWriterCache) - Constructor for class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Construct a Taxonomy writer.
DirectoryTaxonomyWriter.DiskOrdinalMap - Class in org.apache.lucene.facet.taxonomy.directory: DirectoryTaxonomyWriter.OrdinalMap maintained on file system
DirectoryTaxonomyWriter.MemoryOrdinalMap - Class in org.apache.lucene.facet.taxonomy.directory: DirectoryTaxonomyWriter.OrdinalMap maintained in memory
DirectoryTaxonomyWriter.OrdinalMap - Interface in org.apache.lucene.facet.taxonomy.directory: Mapping from old ordinal to new ordinals, used when merging indexes with separate taxonomies.
DiskOrdinalMap(Path) - Constructor for class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.DiskOrdinalMap: Sole constructor.
docID() - Method in class org.apache.lucene.facet.taxonomy.BackCompatSortedNumericDocValues: Deprecated.
doClose() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
doClose() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: performs the actual task of closing the resources that are used by the taxonomy reader.
docValueCount() - Method in class org.apache.lucene.facet.taxonomy.BackCompatSortedNumericDocValues: Deprecated.
DocValuesOrdinalsReader - Class in org.apache.lucene.facet.taxonomy: Deprecated.
Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9
DocValuesOrdinalsReader() - Constructor for class org.apache.lucene.facet.taxonomy.DocValuesOrdinalsReader: Deprecated.

Default constructor.
DocValuesOrdinalsReader(String) - Constructor for class org.apache.lucene.facet.taxonomy.DocValuesOrdinalsReader: Deprecated.

Create this, with the specified indexed field name.
doOpenIfChanged() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader: Implements the opening of a new DirectoryTaxonomyReader instance if the taxonomy has changed.
doOpenIfChanged() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Implements the actual opening of a new TaxonomyReader instance if the taxonomy has changed.
doSetNextReader(LeafReaderContext) - Method in class org.apache.lucene.facet.FacetsCollector
DoubleFacetSet - Class in org.apache.lucene.facet.facetset: A FacetSet which encodes double dimension values.
DoubleFacetSet(double...) - Constructor for class org.apache.lucene.facet.facetset.DoubleFacetSet: Constructs a new instance of a facet set which stores double dimension values.
DoubleRange - Class in org.apache.lucene.facet.range: Represents a range over double values.
DoubleRange - Class in org.apache.lucene.facet.rangeonrange: Represents a double range for RangeOnRange faceting
DoubleRange(String, double[], double[]) - Constructor for class org.apache.lucene.facet.rangeonrange.DoubleRange: Represents a double range for RangeOnRange faceting
DoubleRange(String, double, boolean, double, boolean) - Constructor for class org.apache.lucene.facet.range.DoubleRange: Create a DoubleRange.
DoubleRange(String, double, boolean, double, boolean) - Constructor for class org.apache.lucene.facet.rangeonrange.DoubleRange: Represents a double range for RangeOnRange faceting
DoubleRangeFacetCounts - Class in org.apache.lucene.facet.range: Facets implementation that computes counts for dynamic double ranges.
DoubleRangeFacetCounts(String, FacetsCollector, DoubleRange...) - Constructor for class org.apache.lucene.facet.range.DoubleRangeFacetCounts: Create RangeFacetCounts, using double value from the specified field.
DoubleRangeFacetCounts(String, MultiDoubleValuesSource, FacetsCollector, DoubleRange...) - Constructor for class org.apache.lucene.facet.range.DoubleRangeFacetCounts: Create RangeFacetCounts, using the provided MultiDoubleValuesSource if non-null.
DoubleRangeFacetCounts(String, MultiDoubleValuesSource, FacetsCollector, Query, DoubleRange...) - Constructor for class org.apache.lucene.facet.range.DoubleRangeFacetCounts: Create RangeFacetCounts, using the provided MultiDoubleValuesSource if non-null.
DoubleRangeFacetCounts(String, DoubleValuesSource, FacetsCollector, DoubleRange...) - Constructor for class org.apache.lucene.facet.range.DoubleRangeFacetCounts: Create RangeFacetCounts, using the provided DoubleValuesSource if non-null.
DoubleRangeFacetCounts(String, DoubleValuesSource, FacetsCollector, Query, DoubleRange...) - Constructor for class org.apache.lucene.facet.range.DoubleRangeFacetCounts: Create RangeFacetCounts, using the provided DoubleValuesSource if non-null.
DoubleRangeOnRangeFacetCounts - Class in org.apache.lucene.facet.rangeonrange: Represents counts for double range on range faceting.
DoubleRangeOnRangeFacetCounts(String, FacetsCollector, RangeFieldQuery.QueryType, DoubleRange...) - Constructor for class org.apache.lucene.facet.rangeonrange.DoubleRangeOnRangeFacetCounts: Constructor without the fast match query, see other constructor description for more details.
DoubleRangeOnRangeFacetCounts(String, FacetsCollector, RangeFieldQuery.QueryType, Query, DoubleRange...) - Constructor for class org.apache.lucene.facet.rangeonrange.DoubleRangeOnRangeFacetCounts: Represents counts for double range on range faceting.
drillDownFacetsCollector - Variable in class org.apache.lucene.facet.DrillSideways.DrillSidewaysResult: FacetsCollector populated based on hits that match the full DrillDownQuery, treating all drill down dimensions as required clauses.
DrillDownQuery - Class in org.apache.lucene.facet: A Query for drill-down over facet categories.
DrillDownQuery(FacetsConfig) - Constructor for class org.apache.lucene.facet.DrillDownQuery: Creates a new DrillDownQuery without a base query, to perform a pure browsing query (equivalent to using MatchAllDocsQuery as base).
DrillDownQuery(FacetsConfig, Query) - Constructor for class org.apache.lucene.facet.DrillDownQuery: Creates a new DrillDownQuery over the given base query.
drillDownTermsIndexing - Variable in class org.apache.lucene.facet.FacetsConfig.DimConfig: Default drill down terms indexing option that index all.
DrillSideways - Class in org.apache.lucene.facet: Computes drill down and sideways counts for the provided DrillDownQuery.
DrillSideways(IndexSearcher, FacetsConfig, SortedSetDocValuesReaderState) - Constructor for class org.apache.lucene.facet.DrillSideways: Create a new DrillSideways instance, assuming the categories were indexed with SortedSetDocValuesFacetField.
DrillSideways(IndexSearcher, FacetsConfig, TaxonomyReader) - Constructor for class org.apache.lucene.facet.DrillSideways: Create a new DrillSideways instance.
DrillSideways(IndexSearcher, FacetsConfig, TaxonomyReader, SortedSetDocValuesReaderState) - Constructor for class org.apache.lucene.facet.DrillSideways: Create a new DrillSideways instance, where some dimensions were indexed with SortedSetDocValuesFacetField and others were indexed with FacetField.
DrillSideways(IndexSearcher, FacetsConfig, TaxonomyReader, SortedSetDocValuesReaderState, ExecutorService) - Constructor for class org.apache.lucene.facet.DrillSideways: Create a new DrillSideways instance, where some dimensions were indexed with SortedSetDocValuesFacetField and others were indexed with FacetField.
DrillSideways.ConcurrentDrillSidewaysResult<R> - Class in org.apache.lucene.facet: Result of a concurrent drill sideways search, including the Facets and TopDocs.
DrillSideways.DrillSidewaysResult - Class in org.apache.lucene.facet: Result of a drill sideways search, including the Facets and TopDocs.
drillSidewaysDims - Variable in class org.apache.lucene.facet.DrillSideways.DrillSidewaysResult: Dimensions that correspond to to the DrillSideways.DrillSidewaysResult.drillSidewaysFacetsCollector
drillSidewaysFacetsCollector - Variable in class org.apache.lucene.facet.DrillSideways.DrillSidewaysResult: FacetsCollectors populated for each drill sideways dimension.
DrillSidewaysResult(Facets, TopDocs, FacetsCollector, FacetsCollector[], String[]) - Constructor for class org.apache.lucene.facet.DrillSideways.DrillSidewaysResult: Sole constructor.

E

encode(IntsRef) - Method in class org.apache.lucene.facet.taxonomy.OrdinalMappingLeafReader: Deprecated.
Custom binary formats are no longer directly supported for taxonomy faceting starting in Lucene 9
end - Variable in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState.OrdRange: End of range, inclusive:
ensureOpen() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Verifies that this instance wasn't closed, or throws AlreadyClosedException if it is.
ensureOpen() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Throws AlreadyClosedException if this IndexReader is closed
equals(Object) - Method in class org.apache.lucene.facet.DrillDownQuery
equals(Object) - Method in class org.apache.lucene.facet.FacetResult
equals(Object) - Method in class org.apache.lucene.facet.LabelAndValue
equals(Object) - Method in class org.apache.lucene.facet.MultiDoubleValuesSource
equals(Object) - Method in class org.apache.lucene.facet.MultiLongValuesSource
equals(Object) - Method in class org.apache.lucene.facet.range.DoubleRange
equals(Object) - Method in class org.apache.lucene.facet.range.LongRange
equals(Object) - Method in class org.apache.lucene.facet.rangeonrange.DoubleRange
equals(Object) - Method in class org.apache.lucene.facet.rangeonrange.LongRange
equals(Object) - Method in class org.apache.lucene.facet.taxonomy.FacetLabel
ExactFacetSetMatcher - Class in org.apache.lucene.facet.facetset: A FacetSetMatcher which considers a set as a match only if all dimension values are equal to the given one.
ExactFacetSetMatcher(String, FacetSet) - Constructor for class org.apache.lucene.facet.facetset.ExactFacetSetMatcher: Constructs an instance to match the given facet set.

F

FacetCountsWithFilterQuery - Class in org.apache.lucene.facet: Base class for facet counts.
FacetCountsWithFilterQuery(Query) - Constructor for class org.apache.lucene.facet.FacetCountsWithFilterQuery: Create FacetCounts
FacetField - Class in org.apache.lucene.facet: Add an instance of this to your Document for every facet label.
FacetField(String, String...) - Constructor for class org.apache.lucene.facet.FacetField: Creates the this from dim and path.
FacetLabel - Class in org.apache.lucene.facet.taxonomy: Holds a sequence of string components, specifying the hierarchical name of a category.
FacetLabel(String...) - Constructor for class org.apache.lucene.facet.taxonomy.FacetLabel: Construct from the given path components.
FacetLabel(String, String[]) - Constructor for class org.apache.lucene.facet.taxonomy.FacetLabel: Construct from the dimension plus the given path components.
FacetLabelReader(OrdinalsReader, LeafReaderContext) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetLabels.FacetLabelReader: Deprecated.
Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9
FacetLabelReader(SortedNumericDocValues) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetLabels.FacetLabelReader: Construct from a specified SortedNumericDocValues field; useful for reading the default encoding.
FacetQuery - Class in org.apache.lucene.facet: A term Query over a FacetField.
FacetQuery(String, String...) - Constructor for class org.apache.lucene.facet.FacetQuery: Creates a new FacetQuery filtering the query on the given dimension.
FacetQuery(FacetsConfig, String, String...) - Constructor for class org.apache.lucene.facet.FacetQuery: Creates a new FacetQuery filtering the query on the given dimension.
FacetResult - Class in org.apache.lucene.facet: Counts or aggregates for a single dimension.
FacetResult(String, String[], Number, LabelAndValue[], int) - Constructor for class org.apache.lucene.facet.FacetResult: Sole constructor.
facets - Variable in class org.apache.lucene.facet.DrillSideways.DrillSidewaysResult: Combined drill down and sideways results.
Facets - Class in org.apache.lucene.facet: Common base class for all facets implementations.
Facets() - Constructor for class org.apache.lucene.facet.Facets: Default constructor.
FacetsCollector - Class in org.apache.lucene.facet: Collects hits for subsequent faceting.
FacetsCollector() - Constructor for class org.apache.lucene.facet.FacetsCollector: Default constructor
FacetsCollector(boolean) - Constructor for class org.apache.lucene.facet.FacetsCollector: Create this; if keepScores is true then a float[] is allocated to hold score of all hits.
FacetsCollector.MatchingDocs - Class in org.apache.lucene.facet: Holds the documents that were matched in the LeafReaderContext.
FacetsCollectorManager - Class in org.apache.lucene.facet: A CollectorManager implementation which produces FacetsCollector and produces a merged FacetsCollector.
FacetsCollectorManager() - Constructor for class org.apache.lucene.facet.FacetsCollectorManager: Sole constructor.
FacetsConfig - Class in org.apache.lucene.facet: Records per-dimension configuration.
FacetsConfig() - Constructor for class org.apache.lucene.facet.FacetsConfig: Default constructor.
FacetsConfig.DimConfig - Class in org.apache.lucene.facet: Holds the configuration for one dimension
FacetsConfig.DrillDownTermsIndexing - Enum in org.apache.lucene.facet: Drill down terms indexing option to control whether dimension and sub-path terms should be indexed.
FacetSet - Class in org.apache.lucene.facet.facetset: Holds a set of facet dimension values.
FacetSet(int) - Constructor for class org.apache.lucene.facet.facetset.FacetSet: Constructs a new instance of a facet set with the given number of dimensions.
FacetSetDecoder - Interface in org.apache.lucene.facet.facetset: A functional interface for decoding facet set values into comparable `long` ones.
FacetSetMatcher - Class in org.apache.lucene.facet.facetset: Matches the encoded FacetSet that was indexed in FacetSetsField.
FacetSetMatcher(String, int) - Constructor for class org.apache.lucene.facet.facetset.FacetSetMatcher: Constructs a new matcher.
FacetSetsField - Class in org.apache.lucene.facet.facetset: A BinaryDocValuesField which encodes a list of facet sets.
FacetUtils - Class in org.apache.lucene.facet: Utility class with a single method for getting a DocIdSetIterator that skips deleted docs
failNoMatch() - Method in class org.apache.lucene.facet.range.Range: Invoke this for a useless range.
failNoMatch() - Method in class org.apache.lucene.facet.rangeonrange.Range: Invoke this for a useless range.
fastMatchQuery - Variable in class org.apache.lucene.facet.FacetCountsWithFilterQuery: Optional: if specified, we first test this Query to see whether the document should be checked for matching ranges.
FastTaxonomyFacetCounts - Class in org.apache.lucene.facet.taxonomy: Computes facets counts, assuming the default encoding into DocValues was used.
FastTaxonomyFacetCounts(String, TaxonomyReader, FacetsConfig, FacetsCollector) - Constructor for class org.apache.lucene.facet.taxonomy.FastTaxonomyFacetCounts: Create FastTaxonomyFacetCounts, using the specified indexFieldName for ordinals.
FastTaxonomyFacetCounts(String, IndexReader, TaxonomyReader, FacetsConfig) - Constructor for class org.apache.lucene.facet.taxonomy.FastTaxonomyFacetCounts: Create FastTaxonomyFacetCounts, using the specified indexFieldName for ordinals, and counting all non-deleted documents in the index.
FastTaxonomyFacetCounts(TaxonomyReader, FacetsConfig, FacetsCollector) - Constructor for class org.apache.lucene.facet.taxonomy.FastTaxonomyFacetCounts: Create FastTaxonomyFacetCounts, which also counts all facet labels.
field - Variable in class org.apache.lucene.facet.range.DoubleRangeFacetCounts: Our field name.
field - Variable in class org.apache.lucene.facet.range.LongRangeFacetCounts: Our field name.
findCategory(FacetLabel) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Look up the given category in the cache and/or the on-disk storage, returning the category's ordinal, or a negative number in case the category does not yet exist in the taxonomy.
finish() - Method in class org.apache.lucene.facet.FacetsCollector
FloatAssociationFacetField - Class in org.apache.lucene.facet.taxonomy: Add an instance of this to your Document to add a facet label associated with a float.
FloatAssociationFacetField(float, String, String...) - Constructor for class org.apache.lucene.facet.taxonomy.FloatAssociationFacetField: Creates this from dim and path and a float association
FloatFacetSet - Class in org.apache.lucene.facet.facetset: A FacetSet which encodes float dimension values.
FloatFacetSet(float...) - Constructor for class org.apache.lucene.facet.facetset.FloatFacetSet: Constructs a new instance of a facet set which stores float dimension values.
FloatTaxonomyFacets - Class in org.apache.lucene.facet.taxonomy: Deprecated.
Visibility of this class will be reduced to pkg-private in a future version. This class is meant to host common code as an internal implementation detail to taxonomy faceting,and is not intended as an extension point for user-created Facets implementations. If your code is relying on this, please migrate necessary functionality down into your own class.
FloatTaxonomyFacets(String, TaxonomyReader, FacetsConfig) - Constructor for class org.apache.lucene.facet.taxonomy.FloatTaxonomyFacets: Deprecated.

Constructor that defaults the aggregation function to AssociationAggregationFunction.SUM.
FloatTaxonomyFacets(String, TaxonomyReader, AssociationAggregationFunction, FacetsConfig) - Constructor for class org.apache.lucene.facet.taxonomy.FloatTaxonomyFacets: Deprecated.

Constructor that uses the provided aggregation function.
floatToBytesRef(float) - Static method in class org.apache.lucene.facet.taxonomy.FloatAssociationFacetField: Encodes a float as a 4-byte BytesRef.
fromDoubleField(String) - Static method in class org.apache.lucene.facet.MultiDoubleValuesSource: Creates a MultiDoubleValuesSource that wraps a double-valued field
fromDoubles(double, boolean, double, boolean) - Static method in class org.apache.lucene.facet.facetset.DimRange: Creates a DimRange for the given min and max double values.
fromField(String, LongToDoubleFunction) - Static method in class org.apache.lucene.facet.MultiDoubleValuesSource: Creates a MultiDoubleValuesSource that wraps a generic NumericDocValues/SortedNumericDocValues field.
fromFloatField(String) - Static method in class org.apache.lucene.facet.MultiDoubleValuesSource: Creates a MultiDoubleValuesSource that wraps a float-valued field
fromFloats(float, boolean, float, boolean) - Static method in class org.apache.lucene.facet.facetset.DimRange: Creates a DimRange for the given min and max float values.
fromIntField(String) - Static method in class org.apache.lucene.facet.MultiDoubleValuesSource: Creates a MultiDoubleValuesSource that wraps an int-valued field
fromIntField(String) - Static method in class org.apache.lucene.facet.MultiLongValuesSource: Creates a MultiLongValuesSource that wraps an int-valued field
fromLongField(String) - Static method in class org.apache.lucene.facet.MultiDoubleValuesSource: Creates a MultiDoubleValuesSource that wraps a long-valued field
fromLongField(String) - Static method in class org.apache.lucene.facet.MultiLongValuesSource: Creates a MultiLongValuesSource that wraps a long-valued field
fromLongs(long, boolean, long, boolean) - Static method in class org.apache.lucene.facet.facetset.DimRange: Creates a DimRange for the given min and max long values.
fromSingleValued(DoubleValuesSource) - Static method in class org.apache.lucene.facet.MultiDoubleValuesSource: Creates a MultiDoubleValuesSource that wraps a single-valued DoubleValuesSource
fromSingleValued(LongValuesSource) - Static method in class org.apache.lucene.facet.MultiLongValuesSource: Creates a MultiLongValuesSource that wraps a single-valued LongValuesSource
FULL_PATH_ONLY - Enum constant in enum org.apache.lucene.facet.FacetsConfig.DrillDownTermsIndexing: Index only full-path drill down terms.

G

get(int, IntsRef) - Method in class org.apache.lucene.facet.taxonomy.OrdinalsReader.OrdinalsSegmentReader: Deprecated.

Get the ordinals for this document.
get(FacetLabel) - Method in class org.apache.lucene.facet.taxonomy.writercache.LruTaxonomyWriterCache
get(FacetLabel) - Method in interface org.apache.lucene.facet.taxonomy.writercache.TaxonomyWriterCache: Lookup a category in the cache, returning its ordinal, or a negative number if the category is not in the cache.
get(FacetLabel) - Method in class org.apache.lucene.facet.taxonomy.writercache.UTF8TaxonomyWriterCache: Deprecated.
getAllChildren(String, String...) - Method in class org.apache.lucene.facet.Facets: Returns all child labels with non-zero counts under the specified path.
getAllChildren(String, String...) - Method in class org.apache.lucene.facet.facetset.MatchingFacetSetsCounts
getAllChildren(String, String...) - Method in class org.apache.lucene.facet.LongValueFacetCounts
getAllChildren(String, String...) - Method in class org.apache.lucene.facet.MultiFacets
getAllChildren(String, String...) - Method in class org.apache.lucene.facet.range.DoubleRangeFacetCounts: Returns all child labels with non-zero counts under the specified path.
getAllChildren(String, String...) - Method in class org.apache.lucene.facet.range.LongRangeFacetCounts: Returns all child labels with non-zero counts under the specified path.
getAllChildren(String, String...) - Method in class org.apache.lucene.facet.rangeonrange.DoubleRangeOnRangeFacetCounts: Returns all child labels with non-zero counts under the specified path.
getAllChildren(String, String...) - Method in class org.apache.lucene.facet.rangeonrange.LongRangeOnRangeFacetCounts: Returns all child labels with non-zero counts under the specified path.
getAllChildren(String, String...) - Method in class org.apache.lucene.facet.sortedset.ConcurrentSortedSetDocValuesFacetCounts
getAllChildren(String, String...) - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetCounts
getAllChildren(String, String...) - Method in class org.apache.lucene.facet.StringValueFacetCounts
getAllChildren(String, String...) - Method in class org.apache.lucene.facet.taxonomy.FloatTaxonomyFacets: Deprecated.
getAllChildren(String, String...) - Method in class org.apache.lucene.facet.taxonomy.IntTaxonomyFacets: Deprecated.
getAllChildrenSortByValue() - Method in class org.apache.lucene.facet.LongValueFacetCounts: Returns all unique values seen, sorted by value.
getAllDims(int) - Method in class org.apache.lucene.facet.Facets: Returns topN labels for any dimension that had hits, sorted by the number of hits that dimension matched; this is used for "sparse" faceting, where many different dimensions were indexed, for example depending on the type of document.
getAllDims(int) - Method in class org.apache.lucene.facet.facetset.MatchingFacetSetsCounts
getAllDims(int) - Method in class org.apache.lucene.facet.LongValueFacetCounts
getAllDims(int) - Method in class org.apache.lucene.facet.MultiFacets
getAllDims(int) - Method in class org.apache.lucene.facet.range.DoubleRangeFacetCounts
getAllDims(int) - Method in class org.apache.lucene.facet.range.LongRangeFacetCounts
getAllDims(int) - Method in class org.apache.lucene.facet.rangeonrange.DoubleRangeOnRangeFacetCounts
getAllDims(int) - Method in class org.apache.lucene.facet.rangeonrange.LongRangeOnRangeFacetCounts
getAllDims(int) - Method in class org.apache.lucene.facet.sortedset.ConcurrentSortedSetDocValuesFacetCounts
getAllDims(int) - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetCounts
getAllDims(int) - Method in class org.apache.lucene.facet.StringValueFacetCounts
getAllDims(int) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyFacets: Deprecated.
getBaseQuery() - Method in class org.apache.lucene.facet.DrillDownQuery: Returns the internal baseQuery of the DrillDownQuery
getBinaryDocValues(String) - Method in class org.apache.lucene.facet.taxonomy.OrdinalMappingLeafReader
getBulkOrdinals(FacetLabel...) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getBulkOrdinals(FacetLabel...) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Returns the ordinals of the categories given as a path.
getBulkPath(int...) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader: Returns an array of FacetLabels for a given array of ordinals.
getBulkPath(int...) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Returns the path names of the list of ordinals associated with different categories.
getCache() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Returns the TaxonomyWriterCache in use by this writer.
getChildren() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyFacets: Deprecated.

Returns int[] mapping each ordinal to its first child; this is a large array and is computed (and then saved) the first time this method is invoked.
getChildren(int) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Returns an iterator over the children of the given ordinal.
getChildResources() - Method in class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState: Returns nested resources of this class.
getChildResources() - Method in class org.apache.lucene.facet.taxonomy.CachedOrdinalsReader: Deprecated.
getChildResources() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getCommitUserData() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getCommitUserData() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Retrieve user committed data.
getComparableValues() - Method in class org.apache.lucene.facet.facetset.DoubleFacetSet
getComparableValues() - Method in class org.apache.lucene.facet.facetset.FacetSet: Returns the dimension values in this facet set as comparable longs.
getComparableValues() - Method in class org.apache.lucene.facet.facetset.FloatFacetSet
getComparableValues() - Method in class org.apache.lucene.facet.facetset.IntFacetSet
getComparableValues() - Method in class org.apache.lucene.facet.facetset.LongFacetSet
getCoreCacheHelper() - Method in class org.apache.lucene.facet.taxonomy.OrdinalMappingLeafReader
getDefaultDimConfig() - Method in class org.apache.lucene.facet.FacetsConfig: Get the default configuration for new dimensions.
getDimConfig(String) - Method in class org.apache.lucene.facet.FacetsConfig: Get the current configuration for a dimension.
getDimConfigs() - Method in class org.apache.lucene.facet.FacetsConfig: Returns map of field name to FacetsConfig.DimConfig.
getDims() - Method in class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState
getDims() - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Returns a list of all dimensions
getDimTree(String) - Method in class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState
getDimTree(String) - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Returns mapping from prefix to SortedSetDocValuesReaderState.DimTree
getDirectory() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Returns the Directory of this taxonomy writer.
getDocValues() - Method in class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState: Return top-level doc values.
getDocValues() - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Return top-level doc values.
getDrillDownQueries() - Method in class org.apache.lucene.facet.DrillDownQuery: Returns the dimension queries added either via DrillDownQuery.add(String, Query) or DrillDownQuery.add(String, String...)
getFacetLabelReader(LeafReaderContext) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyFacetLabels: Create and return an instance of TaxonomyFacetLabels.FacetLabelReader to retrieve facet labels for multiple documents and (optionally) for a specific dimension.
getFacetsConfig() - Method in class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState
getFacetsConfig() - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Returns the associated facet config.
getField() - Method in class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState: Indexed field we are reading.
getField() - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Indexed field we are reading.
getIndexFieldName() - Method in class org.apache.lucene.facet.taxonomy.CachedOrdinalsReader: Deprecated.
getIndexFieldName() - Method in class org.apache.lucene.facet.taxonomy.DocValuesOrdinalsReader: Deprecated.
getIndexFieldName() - Method in class org.apache.lucene.facet.taxonomy.OrdinalsReader: Deprecated.

Returns the indexed field name this OrdinalsReader is reading from.
getInternalIndexReader() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader: Expert: returns the underlying DirectoryReader instance that is used by this TaxonomyReader.
getKeepScores() - Method in class org.apache.lucene.facet.FacetsCollector: True if scores were saved.
getLabelsFromRanges(Range[]) - Static method in class org.apache.lucene.facet.rangeonrange.Range: Gets a corresponding array of labels given a range
getLiveCommitData() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
getLiveCommitData() - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyWriter: Returns the commit user data iterable that was set on TaxonomyWriter.setLiveCommitData(Iterable).
getLongRanges() - Method in class org.apache.lucene.facet.range.DoubleRangeFacetCounts: Create long ranges from the double ranges.
getLongRanges() - Method in class org.apache.lucene.facet.range.LongRangeFacetCounts
getMap() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.DiskOrdinalMap
getMap() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.MemoryOrdinalMap
getMap() - Method in interface org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.OrdinalMap: Return the map from the taxonomy's original (consecutive) ordinals to the new taxonomy's ordinals.
getMatchingDocs() - Method in class org.apache.lucene.facet.FacetsCollector: Returns the documents matched by the query, one FacetsCollector.MatchingDocs per visited segment.
getMatchingDocs() - Method in class org.apache.lucene.facet.RandomSamplingFacetsCollector: Returns the sampled list of the matching documents.
getMaxOrdinal() - Method in class org.apache.lucene.facet.taxonomy.writercache.LabelToOrdinal: return the maximal Ordinal assigned so far
getMaxSize() - Method in class org.apache.lucene.facet.taxonomy.LRUHashMap: Return the max size
getMaxSize() - Method in class org.apache.lucene.facet.taxonomy.writercache.NameHashIntCacheLRU: Maximum number of cache entries before eviction.
getNextOrdinal() - Method in class org.apache.lucene.facet.taxonomy.writercache.LabelToOrdinal: Returns the next unassigned ordinal.
getOrdinal(String, String...) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Returns ordinal for the dim + path.
getOrdinal(FacetLabel) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getOrdinal(FacetLabel) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Returns the ordinal of the category given as a path.
getOrdinal(FacetLabel) - Method in class org.apache.lucene.facet.taxonomy.writercache.LabelToOrdinal: Returns the ordinal assigned to the given label, or LabelToOrdinal.INVALID_ORDINAL if the label cannot be found in this table.
getOrdinalsReader(String) - Method in class org.apache.lucene.facet.taxonomy.OrdinalMappingLeafReader: Deprecated.
Custom binary formats are no longer directly supported for taxonomy faceting starting in Lucene 9
getOrdRange(String) - Method in class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState
getOrdRange(String) - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Returns the SortedSetDocValuesReaderState.OrdRange for this dimension.
getOriginalMatchingDocs() - Method in class org.apache.lucene.facet.RandomSamplingFacetsCollector: Returns the original matching documents.
getParallelTaxonomyArrays() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getParallelTaxonomyArrays() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Returns a ParallelTaxonomyArrays object which can be used to efficiently traverse the taxonomy tree.
getParent(int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
getParent(int) - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyWriter: getParent() returns the ordinal of the parent category of the category with the given ordinal.
getPath(int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getPath(int) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Returns the path name of the category with the given ordinal.
getPrefixToOrdRange() - Method in class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState
getPrefixToOrdRange() - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Returns mapping from prefix to SortedSetDocValuesReaderState.OrdRange.
getQuery(Query, MultiDoubleValuesSource) - Method in class org.apache.lucene.facet.range.DoubleRange: Create a Query that matches documents in this range
getQuery(Query, MultiLongValuesSource) - Method in class org.apache.lucene.facet.range.LongRange: Create a Query that matches documents in this range
getQuery(Query, DoubleValuesSource) - Method in class org.apache.lucene.facet.range.DoubleRange: Create a Query that matches documents in this range
getQuery(Query, LongValuesSource) - Method in class org.apache.lucene.facet.range.LongRange: Create a Query that matches documents in this range
getReader() - Method in class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState
getReader() - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Returns top-level index reader.
getReader(LeafReaderContext) - Method in class org.apache.lucene.facet.taxonomy.CachedOrdinalsReader: Deprecated.
getReader(LeafReaderContext) - Method in class org.apache.lucene.facet.taxonomy.DocValuesOrdinalsReader: Deprecated.
getReader(LeafReaderContext) - Method in class org.apache.lucene.facet.taxonomy.OrdinalsReader: Deprecated.

Set current atomic reader.
getReaderCacheHelper() - Method in class org.apache.lucene.facet.taxonomy.OrdinalMappingLeafReader
getRefCount() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Returns the current refCount for this taxonomy reader.
getRefCount(SearcherTaxonomyManager.SearcherAndTaxonomy) - Method in class org.apache.lucene.facet.taxonomy.SearcherTaxonomyManager
getSamplingRate() - Method in class org.apache.lucene.facet.RandomSamplingFacetsCollector: Returns the sampling rate that was used.
getSiblings() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyFacets: Deprecated.

Returns int[] mapping each ordinal to its next sibling; this is a large array and is computed (and then saved) the first time this method is invoked.
getSize() - Method in class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState: Number of unique labels.
getSize() - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Number of unique labels.
getSize() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getSize() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
getSize() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Returns the number of categories in the taxonomy.
getSize() - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyWriter: getSize() returns the number of categories in the taxonomy.
getSize() - Method in class org.apache.lucene.facet.taxonomy.writercache.NameHashIntCacheLRU: Number of entries currently in the cache.
getSortedNumericDocValues(String) - Method in class org.apache.lucene.facet.taxonomy.OrdinalMappingLeafReader
getSpecificValue(String, String...) - Method in class org.apache.lucene.facet.Facets: Return the count or value for a specific path.
getSpecificValue(String, String...) - Method in class org.apache.lucene.facet.facetset.MatchingFacetSetsCounts
getSpecificValue(String, String...) - Method in class org.apache.lucene.facet.LongValueFacetCounts
getSpecificValue(String, String...) - Method in class org.apache.lucene.facet.MultiFacets
getSpecificValue(String, String...) - Method in class org.apache.lucene.facet.range.DoubleRangeFacetCounts
getSpecificValue(String, String...) - Method in class org.apache.lucene.facet.range.LongRangeFacetCounts
getSpecificValue(String, String...) - Method in class org.apache.lucene.facet.rangeonrange.DoubleRangeOnRangeFacetCounts
getSpecificValue(String, String...) - Method in class org.apache.lucene.facet.rangeonrange.LongRangeOnRangeFacetCounts
getSpecificValue(String, String...) - Method in class org.apache.lucene.facet.sortedset.ConcurrentSortedSetDocValuesFacetCounts
getSpecificValue(String, String...) - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetCounts
getSpecificValue(String, String...) - Method in class org.apache.lucene.facet.StringValueFacetCounts
getSpecificValue(String, String...) - Method in class org.apache.lucene.facet.taxonomy.FloatTaxonomyFacets: Deprecated.
getSpecificValue(String, String...) - Method in class org.apache.lucene.facet.taxonomy.IntTaxonomyFacets: Deprecated.
getTaxonomyEpoch() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Expert: returns current index epoch, if this is a near-real-time reader.
getTopChildren(int, String, String...) - Method in class org.apache.lucene.facet.Facets: Returns the topN child labels under the specified path.
getTopChildren(int, String, String...) - Method in class org.apache.lucene.facet.facetset.MatchingFacetSetsCounts
getTopChildren(int, String, String...) - Method in class org.apache.lucene.facet.LongValueFacetCounts
getTopChildren(int, String, String...) - Method in class org.apache.lucene.facet.MultiFacets
getTopChildren(int, String, String...) - Method in class org.apache.lucene.facet.range.DoubleRangeFacetCounts
getTopChildren(int, String, String...) - Method in class org.apache.lucene.facet.range.LongRangeFacetCounts
getTopChildren(int, String, String...) - Method in class org.apache.lucene.facet.rangeonrange.DoubleRangeOnRangeFacetCounts
getTopChildren(int, String, String...) - Method in class org.apache.lucene.facet.rangeonrange.LongRangeOnRangeFacetCounts
getTopChildren(int, String, String...) - Method in class org.apache.lucene.facet.sortedset.ConcurrentSortedSetDocValuesFacetCounts
getTopChildren(int, String, String...) - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetCounts
getTopChildren(int, String, String...) - Method in class org.apache.lucene.facet.StringValueFacetCounts
getTopChildren(int, String, String...) - Method in class org.apache.lucene.facet.taxonomy.FloatTaxonomyFacets: Deprecated.
getTopChildren(int, String, String...) - Method in class org.apache.lucene.facet.taxonomy.IntTaxonomyFacets: Deprecated.
getTopChildrenSortByCount(int) - Method in class org.apache.lucene.facet.LongValueFacetCounts: Deprecated.
Please use LongValueFacetCounts.getTopChildren(int, String, String...) instead for the same functionality.
getTopDims(int, int) - Method in class org.apache.lucene.facet.Facets: Returns labels for topN dimensions and their topNChildren sorted by the number of hits/aggregated values that dimension matched.
getTopDims(int, int) - Method in class org.apache.lucene.facet.sortedset.ConcurrentSortedSetDocValuesFacetCounts
getTopDims(int, int) - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetCounts
getTopDims(int, int) - Method in class org.apache.lucene.facet.taxonomy.FloatTaxonomyFacets: Deprecated.
getTopDims(int, int) - Method in class org.apache.lucene.facet.taxonomy.IntTaxonomyFacets: Deprecated.
getValue(int) - Method in class org.apache.lucene.facet.taxonomy.IntTaxonomyFacets: Deprecated.

Get the count for this ordinal.
getValueCount() - Method in class org.apache.lucene.facet.MultiDoubleValues: Retrieves the number of values for the current document.
getValueCount() - Method in class org.apache.lucene.facet.MultiLongValues: Retrieves the number of values for the current document.
getValues(LeafReaderContext) - Method in class org.apache.lucene.facet.MultiDoubleValuesSource: Returns a MultiDoubleValues instance for the passed-in LeafReaderContext
getValues(LeafReaderContext) - Method in class org.apache.lucene.facet.MultiLongValuesSource: Returns a MultiLongValues instance for the passed-in LeafReaderContext

H

hashCode() - Method in class org.apache.lucene.facet.DrillDownQuery
hashCode() - Method in class org.apache.lucene.facet.FacetResult
hashCode() - Method in class org.apache.lucene.facet.LabelAndValue
hashCode() - Method in class org.apache.lucene.facet.MultiDoubleValuesSource
hashCode() - Method in class org.apache.lucene.facet.MultiLongValuesSource
hashCode() - Method in class org.apache.lucene.facet.range.DoubleRange
hashCode() - Method in class org.apache.lucene.facet.range.LongRange
hashCode() - Method in class org.apache.lucene.facet.rangeonrange.DoubleRange
hashCode() - Method in class org.apache.lucene.facet.rangeonrange.LongRange
hashCode() - Method in class org.apache.lucene.facet.taxonomy.FacetLabel
hierarchical - Variable in class org.apache.lucene.facet.FacetsConfig.DimConfig: True if this dimension is hierarchical.
hits - Variable in class org.apache.lucene.facet.DrillSideways.DrillSidewaysResult: Hits.

I

incRef() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Expert: increments the refCount of this TaxonomyReader instance.
increment(int) - Method in class org.apache.lucene.facet.taxonomy.IntTaxonomyFacets: Deprecated.

Increment the count for this ordinal by 1.
increment(int, int) - Method in class org.apache.lucene.facet.taxonomy.IntTaxonomyFacets: Deprecated.

Increment the count for this ordinal by amount..
INDEX_EPOCH - Static variable in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Property name of user commit data that contains the index epoch.
indexFieldName - Variable in class org.apache.lucene.facet.FacetsConfig.DimConfig: Actual field where this dimension's facet labels should be indexed
indexFieldName - Variable in class org.apache.lucene.facet.taxonomy.TaxonomyFacets: Deprecated.

Index field name provided to the constructor.
IntAssociationFacetField - Class in org.apache.lucene.facet.taxonomy: Add an instance of this to your Document to add a facet label associated with an int.
IntAssociationFacetField(int, String, String...) - Constructor for class org.apache.lucene.facet.taxonomy.IntAssociationFacetField: Creates this from dim and path and an int association
IntFacetSet - Class in org.apache.lucene.facet.facetset: A FacetSet which encodes integer dimension values.
IntFacetSet(int...) - Constructor for class org.apache.lucene.facet.facetset.IntFacetSet: Constructs a new instance of a facet set which stores int dimension values.
IntTaxonomyFacets - Class in org.apache.lucene.facet.taxonomy: Deprecated.
Visibility of this class will be reduced to pkg-private in a future version. This class is meant to host common code as an internal implementation detail to FastTaxonomyFacetCounts and TaxonomyFacetIntAssociations,and is not intended as an extension point for user-created Facets implementations. If your code is relying on this, please migrate necessary functionality down into your own class.
IntTaxonomyFacets(String, TaxonomyReader, FacetsConfig, FacetsCollector) - Constructor for class org.apache.lucene.facet.taxonomy.IntTaxonomyFacets: Deprecated.

Constructor that defaults the aggregation function to AssociationAggregationFunction.SUM.
IntTaxonomyFacets(String, TaxonomyReader, FacetsConfig, AssociationAggregationFunction, FacetsCollector) - Constructor for class org.apache.lucene.facet.taxonomy.IntTaxonomyFacets: Deprecated.

Constructor that uses the provided aggregation function.
intToBytesRef(int) - Static method in class org.apache.lucene.facet.taxonomy.IntAssociationFacetField: Encodes an int as a 4-byte BytesRef, big-endian.
INVALID_ORDINAL - Static variable in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Invalid ordinal const
INVALID_ORDINAL - Static variable in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Ordinals are always non-negative, so a negative ordinal can be used to signify an error.
INVALID_ORDINAL - Static variable in class org.apache.lucene.facet.taxonomy.writercache.LabelToOrdinal: Returned by LabelToOrdinal.getOrdinal(org.apache.lucene.facet.taxonomy.FacetLabel) when the label isn't recognized.
isDimConfigured(String) - Method in class org.apache.lucene.facet.FacetsConfig: Returns true if the dimension for provided name has ever been manually configured.
isFull() - Method in class org.apache.lucene.facet.taxonomy.writercache.LruTaxonomyWriterCache
isFull() - Method in interface org.apache.lucene.facet.taxonomy.writercache.TaxonomyWriterCache: Returns true if the cache is full, such that the next TaxonomyWriterCache.put(org.apache.lucene.facet.taxonomy.FacetLabel, int) will evict entries from it, false otherwise.
isFull() - Method in class org.apache.lucene.facet.taxonomy.writercache.UTF8TaxonomyWriterCache: Deprecated.
iterator() - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState.DimTree: Iterates through all first level children of dimension
iterator() - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState.OrdRange: Iterates from start to end ord (inclusive)
iterator(int) - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState.DimTree: Iterates through all children of given pathOrd

L

label - Variable in class org.apache.lucene.facet.facetset.FacetSetMatcher: The label to associate to this matcher's aggregated value.
label - Variable in class org.apache.lucene.facet.LabelAndValue: Facet's label.
label - Variable in class org.apache.lucene.facet.range.Range: Label that identifies this range.
label - Variable in class org.apache.lucene.facet.rangeonrange.Range: Label that identifies this range.
label - Variable in class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetField: Deprecated.
This field will be removed in a future version. FacetsConfig.pathToString(String[]) can be applied to path as a replacement if string path is desired.
LabelAndValue - Class in org.apache.lucene.facet: Single label and its value, usually contained in a FacetResult.
LabelAndValue(String, Number) - Constructor for class org.apache.lucene.facet.LabelAndValue: Sole constructor.
LabelToOrdinal - Class in org.apache.lucene.facet.taxonomy.writercache: Abstract class for storing Label->Ordinal mappings in a taxonomy.
LabelToOrdinal() - Constructor for class org.apache.lucene.facet.taxonomy.writercache.LabelToOrdinal: Default constructor.
labelValues - Variable in class org.apache.lucene.facet.FacetResult: Child counts.
length - Variable in class org.apache.lucene.facet.taxonomy.FacetLabel: The number of components of this FacetLabel.
lessThan(TopOrdAndFloatQueue.OrdAndValue, TopOrdAndFloatQueue.OrdAndValue) - Method in class org.apache.lucene.facet.TopOrdAndFloatQueue
lessThan(TopOrdAndIntQueue.OrdAndValue, TopOrdAndIntQueue.OrdAndValue) - Method in class org.apache.lucene.facet.TopOrdAndIntQueue
liveDocsDISI(DocIdSetIterator, Bits) - Static method in class org.apache.lucene.facet.FacetUtils: Wrap the given DocIdSetIterator and liveDocs into another DocIdSetIterator that returns non-deleted documents during iteration.
loadOrdinalValues(LeafReader, String) - Static method in class org.apache.lucene.facet.FacetUtils: Deprecated.
Please do not rely on this method. It is added as a temporary measure for providing index backwards-compatibility with Lucene 8 and earlier indexes, and will be removed in Lucene 10.
loadOrdinalValues(LeafReader, String, BiConsumer<BytesRef, IntsRef>) - Static method in class org.apache.lucene.facet.FacetUtils: Deprecated.
Please do not rely on this method. It is added as a temporary measure for providing index backwards-compatibility with Lucene 8 and earlier indexes, and will be removed in Lucene 10.
LongFacetSet - Class in org.apache.lucene.facet.facetset: A FacetSet which encodes long dimension values.
LongFacetSet(long...) - Constructor for class org.apache.lucene.facet.facetset.LongFacetSet: Constructs a new instance of a facet set which stores long dimension values.
longHashCode() - Method in class org.apache.lucene.facet.taxonomy.FacetLabel: Calculate a 64-bit hash function for this path.
LongRange - Class in org.apache.lucene.facet.range: Represents a range over long values.
LongRange - Class in org.apache.lucene.facet.rangeonrange: Represents a long range for RangeOnRange faceting
LongRange(String, long[], long[]) - Constructor for class org.apache.lucene.facet.rangeonrange.LongRange: Represents a multidimensional long range for RangeOnRange faceting
LongRange(String, long, boolean, long, boolean) - Constructor for class org.apache.lucene.facet.range.LongRange: Create a LongRange.
LongRange(String, long, boolean, long, boolean) - Constructor for class org.apache.lucene.facet.rangeonrange.LongRange: Represents a single dimensional long range for RangeOnRange faceting
LongRangeFacetCounts - Class in org.apache.lucene.facet.range: Facets implementation that computes counts for dynamic long ranges.
LongRangeFacetCounts(String, FacetsCollector, LongRange...) - Constructor for class org.apache.lucene.facet.range.LongRangeFacetCounts: Create LongRangeFacetCounts using long values from the specified field.
LongRangeFacetCounts(String, MultiLongValuesSource, FacetsCollector, LongRange...) - Constructor for class org.apache.lucene.facet.range.LongRangeFacetCounts: Create LongRangeFacetCounts, using the provided MultiLongValuesSource if non-null.
LongRangeFacetCounts(String, MultiLongValuesSource, FacetsCollector, Query, LongRange...) - Constructor for class org.apache.lucene.facet.range.LongRangeFacetCounts: Create LongRangeFacetCounts, using the provided MultiLongValuesSource if non-null.
LongRangeFacetCounts(String, LongValuesSource, FacetsCollector, LongRange...) - Constructor for class org.apache.lucene.facet.range.LongRangeFacetCounts: Create LongRangeFacetCounts, using the provided LongValuesSource if non-null.
LongRangeFacetCounts(String, LongValuesSource, FacetsCollector, Query, LongRange...) - Constructor for class org.apache.lucene.facet.range.LongRangeFacetCounts: Create LongRangeFacetCounts, using the provided LongValuesSource if non-null.
LongRangeOnRangeFacetCounts - Class in org.apache.lucene.facet.rangeonrange: Represents counts for long range on range faceting.
LongRangeOnRangeFacetCounts(String, FacetsCollector, RangeFieldQuery.QueryType, LongRange...) - Constructor for class org.apache.lucene.facet.rangeonrange.LongRangeOnRangeFacetCounts: Constructor without the fast match query, see other constructor description for more details.
LongRangeOnRangeFacetCounts(String, FacetsCollector, RangeFieldQuery.QueryType, Query, LongRange...) - Constructor for class org.apache.lucene.facet.rangeonrange.LongRangeOnRangeFacetCounts: Represents counts for long range on range faceting.
LongValueFacetCounts - Class in org.apache.lucene.facet: Facets implementation that computes counts for all unique long values, more efficiently counting small values (0-1023) using an int array, and switching to a HashMap for values above 1023.
LongValueFacetCounts(String, FacetsCollector) - Constructor for class org.apache.lucene.facet.LongValueFacetCounts: Create LongValueFacetCounts, using either single-valued NumericDocValues or multi-valued SortedNumericDocValues from the specified field (depending on what has been indexed).
LongValueFacetCounts(String, MultiLongValuesSource, FacetsCollector) - Constructor for class org.apache.lucene.facet.LongValueFacetCounts: Create LongValueFacetCounts, using the provided MultiLongValuesSource if non-null.
LongValueFacetCounts(String, MultiLongValuesSource, IndexReader) - Constructor for class org.apache.lucene.facet.LongValueFacetCounts: Counts all facet values for the provided MultiLongValuesSource if non-null.
LongValueFacetCounts(String, IndexReader) - Constructor for class org.apache.lucene.facet.LongValueFacetCounts: Counts all facet values for this reader.
LongValueFacetCounts(String, LongValuesSource, FacetsCollector) - Constructor for class org.apache.lucene.facet.LongValueFacetCounts: Create LongValueFacetCounts, using the provided LongValuesSource if non-null.
LongValueFacetCounts(String, LongValuesSource, IndexReader) - Constructor for class org.apache.lucene.facet.LongValueFacetCounts: Counts all facet values for the provided LongValuesSource if non-null.
LRU_HASHED - Enum constant in enum org.apache.lucene.facet.taxonomy.writercache.LruTaxonomyWriterCache.LRUType: Use only the label's 64 bit longHashCode as the hash key.
LRU_STRING - Enum constant in enum org.apache.lucene.facet.taxonomy.writercache.LruTaxonomyWriterCache.LRUType: Use the label as the hash key; this is always correct but will usually use more RAM.
LRUHashMap<K,V> - Class in org.apache.lucene.facet.taxonomy: 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.
LRUHashMap(int) - Constructor for class org.apache.lucene.facet.taxonomy.LRUHashMap: Create a new hash map with a bounded size and with least recently used entries removed.
LruTaxonomyWriterCache - Class in org.apache.lucene.facet.taxonomy.writercache: LRU TaxonomyWriterCache - good choice for huge taxonomies.
LruTaxonomyWriterCache(int) - Constructor for class org.apache.lucene.facet.taxonomy.writercache.LruTaxonomyWriterCache: Creates this with LruTaxonomyWriterCache.LRUType.LRU_STRING method.
LruTaxonomyWriterCache(int, LruTaxonomyWriterCache.LRUType) - Constructor for class org.apache.lucene.facet.taxonomy.writercache.LruTaxonomyWriterCache: Creates this with the specified method.
LruTaxonomyWriterCache.LRUType - Enum in org.apache.lucene.facet.taxonomy.writercache: Determines cache type.

M

main(String[]) - Static method in class org.apache.lucene.facet.taxonomy.PrintTaxonomyStats: Command-line tool.
mapDocValue(long) - Method in class org.apache.lucene.facet.range.DoubleRangeFacetCounts
mapDocValue(long) - Method in class org.apache.lucene.facet.range.LongRangeFacetCounts
matches(long[]) - Method in class org.apache.lucene.facet.facetset.ExactFacetSetMatcher
matches(long[]) - Method in class org.apache.lucene.facet.facetset.FacetSetMatcher: Returns true if the facet set encoded in the given long[] is matched by this matcher.
matches(long[]) - Method in class org.apache.lucene.facet.facetset.RangeFacetSetMatcher
MatchingDocs(LeafReaderContext, DocIdSet, int, float[]) - Constructor for class org.apache.lucene.facet.FacetsCollector.MatchingDocs: Sole constructor.
MatchingFacetSetsCounts - Class in org.apache.lucene.facet.facetset: Returns the counts for each given FacetSet
MatchingFacetSetsCounts(String, FacetsCollector, FacetSetDecoder, FacetSetMatcher...) - Constructor for class org.apache.lucene.facet.facetset.MatchingFacetSetsCounts: Constructs a new instance of matching facet set counts which calculates the counts for each given facet set matcher.
MatchingFacetSetsCounts(String, FacetsCollector, FacetSetDecoder, Query, FacetSetMatcher...) - Constructor for class org.apache.lucene.facet.facetset.MatchingFacetSetsCounts: Constructs a new instance of matching facet set counts which calculates the counts for each given facet set matcher.
max - Variable in class org.apache.lucene.facet.facetset.DimRange: Inclusive max
max - Variable in class org.apache.lucene.facet.range.DoubleRange: Maximum (inclusive.
max - Variable in class org.apache.lucene.facet.range.LongRange: Maximum (inclusive).
max - Variable in class org.apache.lucene.facet.rangeonrange.DoubleRange: Maximum (inclusive).
max - Variable in class org.apache.lucene.facet.rangeonrange.LongRange: Maximum (inclusive).
MAX - Static variable in class org.apache.lucene.facet.taxonomy.AssociationAggregationFunction: Aggregation that computes the maximum value
MAX_CATEGORY_PATH_LENGTH - Static variable in class org.apache.lucene.facet.taxonomy.FacetLabel: The maximum number of characters a FacetLabel can have.
MemoryOrdinalMap() - Constructor for class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.MemoryOrdinalMap: Sole constructor.
merge(Directory, Directory, DirectoryTaxonomyWriter.OrdinalMap, IndexWriter, DirectoryTaxonomyWriter, FacetsConfig) - Static method in class org.apache.lucene.facet.taxonomy.TaxonomyMergeUtils: Merges the given taxonomy and index directories and commits the changes to the given writers.
min - Variable in class org.apache.lucene.facet.facetset.DimRange: Inclusive min
min - Variable in class org.apache.lucene.facet.range.DoubleRange: Minimum (inclusive).
min - Variable in class org.apache.lucene.facet.range.LongRange: Minimum (inclusive).
min - Variable in class org.apache.lucene.facet.rangeonrange.DoubleRange: Minimum (inclusive).
min - Variable in class org.apache.lucene.facet.rangeonrange.LongRange: Minimum (inclusive).
MultiDoubleValues - Class in org.apache.lucene.facet: Per-segment, per-document double values, which can be calculated at search-time.
MultiDoubleValues() - Constructor for class org.apache.lucene.facet.MultiDoubleValues: Instantiates a new MultiDoubleValues
MultiDoubleValuesSource - Class in org.apache.lucene.facet: Base class for producing MultiDoubleValues.
MultiDoubleValuesSource() - Constructor for class org.apache.lucene.facet.MultiDoubleValuesSource: Instantiates a new MultiDoubleValuesSource
MultiFacetQuery - Class in org.apache.lucene.facet: A multi-terms Query over a FacetField.
MultiFacetQuery(String, String[]...) - Constructor for class org.apache.lucene.facet.MultiFacetQuery: Creates a new MultiFacetQuery filtering the query on the given dimension.
MultiFacetQuery(FacetsConfig, String, String[]...) - Constructor for class org.apache.lucene.facet.MultiFacetQuery: Creates a new MultiFacetQuery filtering the query on the given dimension.
MultiFacets - Class in org.apache.lucene.facet: Maps specified dims to provided Facets impls; else, uses the default Facets impl.
MultiFacets(Map<String, Facets>) - Constructor for class org.apache.lucene.facet.MultiFacets: Create this, with no default Facets.
MultiFacets(Map<String, Facets>, Facets) - Constructor for class org.apache.lucene.facet.MultiFacets: Create this, with the specified default Facets for fields not included in dimToFacets.
MultiLongValues - Class in org.apache.lucene.facet: Per-segment, per-document long values, which can be calculated at search-time.
MultiLongValues() - Constructor for class org.apache.lucene.facet.MultiLongValues: Instantiates a new MultiLongValues
MultiLongValuesSource - Class in org.apache.lucene.facet: Base class for producing MultiLongValues.
MultiLongValuesSource() - Constructor for class org.apache.lucene.facet.MultiLongValuesSource: Instantiates a new MultiLongValuesSource
multiValued - Variable in class org.apache.lucene.facet.FacetsConfig.DimConfig: True if this dimension is multi-valued.

N

NameHashIntCacheLRU - Class in org.apache.lucene.facet.taxonomy.writercache: An LRU cache of mapping from name to int.
newCollector() - Method in class org.apache.lucene.facet.FacetsCollectorManager
next() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader.ChildrenIterator: Return the next child ordinal, or TaxonomyReader.INVALID_ORDINAL if no more children.
nextDoc() - Method in class org.apache.lucene.facet.taxonomy.BackCompatSortedNumericDocValues: Deprecated.
nextFacetLabel(int) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyFacetLabels.FacetLabelReader: Retrieves the next FacetLabel for the specified docId, or null if there are no more.
nextFacetLabel(int, String) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyFacetLabels.FacetLabelReader: Retrieves the next FacetLabel for the specified docId under the requested facetDimension, or null if there are no more.
nextValue() - Method in class org.apache.lucene.facet.MultiDoubleValues: Iterates to the next value in the current document.
nextValue() - Method in class org.apache.lucene.facet.MultiLongValues: Iterates to the next value in the current document.
nextValue() - Method in class org.apache.lucene.facet.taxonomy.BackCompatSortedNumericDocValues: Deprecated.
NONE - Enum constant in enum org.apache.lucene.facet.FacetsConfig.DrillDownTermsIndexing: Index no drill down terms.

O

offsets - Variable in class org.apache.lucene.facet.taxonomy.CachedOrdinalsReader.CachedOrds: Deprecated.

Index into CachedOrdinalsReader.CachedOrds.ordinals for each document.
openIfChanged(T) - Static method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: If the taxonomy has changed since the provided reader was opened, open and return a new TaxonomyReader; else, return null.
openIndexReader(IndexWriter) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader: Open the DirectoryReader from this IndexWriter.
openIndexReader(Directory) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader: Open the DirectoryReader from this Directory.
openIndexWriter(Directory, IndexWriterConfig) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Open internal index writer, which contains the taxonomy data.
ord - Variable in class org.apache.lucene.facet.TopOrdAndFloatQueue.OrdAndValue: Ordinal of the entry.
ord - Variable in class org.apache.lucene.facet.TopOrdAndIntQueue.OrdAndValue: Ordinal of the entry.
OrdAndValue() - Constructor for class org.apache.lucene.facet.TopOrdAndFloatQueue.OrdAndValue: Default constructor.
OrdAndValue() - Constructor for class org.apache.lucene.facet.TopOrdAndIntQueue.OrdAndValue: Default constructor.
OrdinalMappingLeafReader - Class in org.apache.lucene.facet.taxonomy: A FilterLeafReader for updating facets ordinal references, based on an ordinal map.
OrdinalMappingLeafReader(LeafReader, int[], FacetsConfig) - Constructor for class org.apache.lucene.facet.taxonomy.OrdinalMappingLeafReader: Wraps an LeafReader, mapping ordinals according to the ordinalMap, using the provided FacetsConfig which was used to build the wrapped reader.
ordinals - Variable in class org.apache.lucene.facet.taxonomy.CachedOrdinalsReader.CachedOrds: Deprecated.

Holds ords for all docs.
OrdinalsReader - Class in org.apache.lucene.facet.taxonomy: Deprecated.
Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9
OrdinalsReader() - Constructor for class org.apache.lucene.facet.taxonomy.OrdinalsReader: Deprecated.

Default constructor.
OrdinalsReader.OrdinalsSegmentReader - Class in org.apache.lucene.facet.taxonomy: Deprecated.

Returns ordinals for documents in one segment.
OrdinalsSegmentReader() - Constructor for class org.apache.lucene.facet.taxonomy.OrdinalsReader.OrdinalsSegmentReader: Deprecated.

Default constructor.
OrdRange(int, int) - Constructor for class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState.OrdRange: Start and end are inclusive.
org.apache.lucene.facet - package org.apache.lucene.facet: Faceted search.
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.
org.apache.lucene.facet.range - package org.apache.lucene.facet.range: Provides range faceting capabilities.
org.apache.lucene.facet.rangeonrange - package org.apache.lucene.facet.rangeonrange: Provides range on range faceting capabilities.
org.apache.lucene.facet.sortedset - package org.apache.lucene.facet.sortedset: Provides faceting capabilities over facets that were indexed with SortedSetDocValuesFacetField.
org.apache.lucene.facet.taxonomy - package org.apache.lucene.facet.taxonomy: Taxonomy of Categories.
org.apache.lucene.facet.taxonomy.directory - package org.apache.lucene.facet.taxonomy.directory: Taxonomy index implementation using on top of a Directory.
org.apache.lucene.facet.taxonomy.writercache - package org.apache.lucene.facet.taxonomy.writercache: Improves indexing time by caching a map of CategoryPath to their Ordinal.

P

packValues(byte[], int) - Method in class org.apache.lucene.facet.facetset.FacetSet: Packs the dimension values into the given byte[] and returns the number of packed-values bytes.
packValues(byte[], int) - Method in class org.apache.lucene.facet.facetset.FloatFacetSet
packValues(byte[], int) - Method in class org.apache.lucene.facet.facetset.IntFacetSet
ParallelTaxonomyArrays - Class in org.apache.lucene.facet.taxonomy: Returns 3 arrays for traversing the taxonomy: parents: parents[i] denotes the parent of category ordinal i.
ParallelTaxonomyArrays() - Constructor for class org.apache.lucene.facet.taxonomy.ParallelTaxonomyArrays: Sole constructor.
parents - Variable in class org.apache.lucene.facet.taxonomy.TaxonomyFacets: Deprecated.

Maps an ordinal to its parent, or -1 if there is no parent (root node).
parents() - Method in class org.apache.lucene.facet.taxonomy.ParallelTaxonomyArrays: Returns the parents array, where parents[i] denotes the parent of category ordinal i.
path - Variable in class org.apache.lucene.facet.FacetField: Path for this field.
path - Variable in class org.apache.lucene.facet.FacetResult: Path whose children were requested.
path - Variable in class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetField: Path.
path - Variable in class org.apache.lucene.facet.taxonomy.AssociationFacetField: Facet path for this field.
pathToString(String[]) - Static method in class org.apache.lucene.facet.FacetsConfig: Turns a dim + path into an encoded string.
pathToString(String[], int) - Static method in class org.apache.lucene.facet.FacetsConfig: Turns the first length elements of path into an encoded string.
pathToString(String, String...) - Static method in class org.apache.lucene.facet.FacetsConfig: Turns a dim + path into an encoded string.
prepareCommit() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: prepare most of the work needed for a two-phase commit.
printStats(TaxonomyReader, PrintStream, boolean) - Static method in class org.apache.lucene.facet.taxonomy.PrintTaxonomyStats: Recursively prints stats for all ordinals.
PrintTaxonomyStats - Class in org.apache.lucene.facet.taxonomy: Prints how many ords are under each dimension.
PrintTaxonomyStats() - Constructor for class org.apache.lucene.facet.taxonomy.PrintTaxonomyStats: Sole constructor.
put(FacetLabel, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.LruTaxonomyWriterCache
put(FacetLabel, int) - Method in interface org.apache.lucene.facet.taxonomy.writercache.TaxonomyWriterCache: Add a category to the cache, with the given ordinal as the value.
put(FacetLabel, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.UTF8TaxonomyWriterCache: Deprecated.

R

ramBytesUsed() - Method in class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState: Return the memory usage of this object in bytes.
ramBytesUsed() - Method in class org.apache.lucene.facet.taxonomy.CachedOrdinalsReader.CachedOrds: Deprecated.
ramBytesUsed() - Method in class org.apache.lucene.facet.taxonomy.CachedOrdinalsReader: Deprecated.
ramBytesUsed() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
ramBytesUsed() - Method in class org.apache.lucene.facet.taxonomy.writercache.UTF8TaxonomyWriterCache: Deprecated.
RandomSamplingFacetsCollector - Class in org.apache.lucene.facet: Collects hits for subsequent faceting, using sampling if needed.
RandomSamplingFacetsCollector(int) - Constructor for class org.apache.lucene.facet.RandomSamplingFacetsCollector: Constructor with the given sample size and default seed.
RandomSamplingFacetsCollector(int, long) - Constructor for class org.apache.lucene.facet.RandomSamplingFacetsCollector: Constructor with the given sample size and seed.
Range - Class in org.apache.lucene.facet.range: Base class for a single labeled range.
Range - Class in org.apache.lucene.facet.rangeonrange: Base class for a single labeled range.
Range(String) - Constructor for class org.apache.lucene.facet.range.Range: Sole constructor.
Range(String, int) - Constructor for class org.apache.lucene.facet.rangeonrange.Range: Sole constructor.
RangeFacetSetMatcher - Class in org.apache.lucene.facet.facetset: A FacetSetMatcher which considers a set as a match if all dimensions fall within the given corresponding range.
RangeFacetSetMatcher(String, DimRange...) - Constructor for class org.apache.lucene.facet.facetset.RangeFacetSetMatcher: Constructs an instance to match facet sets with dimensions that fall within the given ranges.
ranges - Variable in class org.apache.lucene.facet.range.DoubleRangeFacetCounts: Ranges passed to constructor.
ranges - Variable in class org.apache.lucene.facet.range.LongRangeFacetCounts: Ranges passed to constructor.
reader - Variable in class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState: IndexReader passed to the constructor.
reduce(Collection<FacetsCollector>) - Method in class org.apache.lucene.facet.FacetsCollectorManager
refreshIfNeeded(SearcherTaxonomyManager.SearcherAndTaxonomy) - Method in class org.apache.lucene.facet.taxonomy.SearcherTaxonomyManager
removeEldestEntry(Map.Entry<K, V>) - Method in class org.apache.lucene.facet.taxonomy.LRUHashMap
replaceTaxonomy(Directory) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Replaces the current taxonomy with the given one.
requireDimCount - Variable in class org.apache.lucene.facet.FacetsConfig.DimConfig: True if the count/aggregate for the entire dimension is required, which is unusual (default is false).
rewrite(IndexSearcher) - Method in class org.apache.lucene.facet.DrillDownQuery
rollback() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Rollback changes to the taxonomy writer and closes the instance.
rollup() - Method in class org.apache.lucene.facet.taxonomy.FloatTaxonomyFacets: Deprecated.

Rolls up any single-valued hierarchical dimensions.
rollup() - Method in class org.apache.lucene.facet.taxonomy.IntTaxonomyFacets: Deprecated.

Rolls up any single-valued hierarchical dimensions.
ROOT_ORDINAL - Static variable in class org.apache.lucene.facet.taxonomy.TaxonomyReader: The root category (the category with the empty path) always has the ordinal 0, to which we give a name ROOT_ORDINAL.

S

scoreMode() - Method in class org.apache.lucene.facet.FacetsCollector
scores - Variable in class org.apache.lucene.facet.FacetsCollector.MatchingDocs: Non-sparse scores array.
scoreSubDocsAtOnce() - Method in class org.apache.lucene.facet.DrillSideways: Override this and return true if your collector (e.g., ToParentBlockJoinCollector) expects all sub-scorers to be positioned on the document being collected.
search(DrillDownQuery, int) - Method in class org.apache.lucene.facet.DrillSideways: Search, sorting by score, and computing drill down and sideways counts.
search(DrillDownQuery, Collector) - Method in class org.apache.lucene.facet.DrillSideways: Deprecated.
This method is deprecated in interest of the DrillSideways.search(DrillDownQuery, CollectorManager) method.
search(DrillDownQuery, CollectorManager<?, R>) - Method in class org.apache.lucene.facet.DrillSideways: Runs a search, using a CollectorManager to gather and merge search results
search(DrillDownQuery, Query, FieldDoc, int, Sort, boolean) - Method in class org.apache.lucene.facet.DrillSideways: Search, sorting by Sort, and computing drill down and sideways counts.
search(IndexSearcher, Query, int, Collector) - Static method in class org.apache.lucene.facet.FacetsCollector: Utility method, to search and also collect all hits into the provided Collector.
search(IndexSearcher, Query, int, Sort, boolean, Collector) - Static method in class org.apache.lucene.facet.FacetsCollector: Utility method, to search and also collect all hits into the provided Collector.
search(IndexSearcher, Query, int, Sort, Collector) - Static method in class org.apache.lucene.facet.FacetsCollector: Utility method, to search and also collect all hits into the provided Collector.
search(ScoreDoc, DrillDownQuery, int) - Method in class org.apache.lucene.facet.DrillSideways: Search, sorting by score, and computing drill down and sideways counts.
searchAfter(IndexSearcher, ScoreDoc, Query, int, Collector) - Static method in class org.apache.lucene.facet.FacetsCollector: Utility method, to search and also collect all hits into the provided Collector.
searchAfter(IndexSearcher, ScoreDoc, Query, int, Sort, boolean, Collector) - Static method in class org.apache.lucene.facet.FacetsCollector: Utility method, to search and also collect all hits into the provided Collector.
searchAfter(IndexSearcher, ScoreDoc, Query, int, Sort, Collector) - Static method in class org.apache.lucene.facet.FacetsCollector: Utility method, to search and also collect all hits into the provided Collector.
searcher - Variable in class org.apache.lucene.facet.DrillSideways: IndexSearcher passed to constructor.
searcher - Variable in class org.apache.lucene.facet.taxonomy.SearcherTaxonomyManager.SearcherAndTaxonomy: Point-in-time IndexSearcher.
SearcherAndTaxonomy(IndexSearcher, DirectoryTaxonomyReader) - Constructor for class org.apache.lucene.facet.taxonomy.SearcherTaxonomyManager.SearcherAndTaxonomy: Create a SearcherAndTaxonomy
SearcherTaxonomyManager - Class in org.apache.lucene.facet.taxonomy: Manages near-real-time reopen of both an IndexSearcher and a TaxonomyReader.
SearcherTaxonomyManager(IndexReader, DirectoryTaxonomyReader, SearcherFactory) - Constructor for class org.apache.lucene.facet.taxonomy.SearcherTaxonomyManager: Creates this from already opened IndexReader and DirectoryTaxonomyReader instances.
SearcherTaxonomyManager(IndexWriter, boolean, SearcherFactory, DirectoryTaxonomyWriter) - Constructor for class org.apache.lucene.facet.taxonomy.SearcherTaxonomyManager: Expert: creates near-real-time searcher and taxonomy reader from the corresponding writers, controlling whether deletes should be applied.
SearcherTaxonomyManager(IndexWriter, SearcherFactory, DirectoryTaxonomyWriter) - Constructor for class org.apache.lucene.facet.taxonomy.SearcherTaxonomyManager: Creates near-real-time searcher and taxonomy reader from the corresponding writers.
SearcherTaxonomyManager(Directory, Directory, SearcherFactory) - Constructor for class org.apache.lucene.facet.taxonomy.SearcherTaxonomyManager: Creates search and taxonomy readers over the corresponding directories.
SearcherTaxonomyManager.SearcherAndTaxonomy - Class in org.apache.lucene.facet.taxonomy: Holds a matched pair of IndexSearcher and TaxonomyReader
setCacheMissesUntilFill(int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Set the number of cache misses before an attempt is made to read the entire taxonomy into the in-memory cache.
setCacheSize(int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader: setCacheSize controls the maximum allowed size of each of the caches used by DirectoryTaxonomyReader.getPath(int) and DirectoryTaxonomyReader.getOrdinal(FacetLabel).
setDrillDownTermsIndexing(String, FacetsConfig.DrillDownTermsIndexing) - Method in class org.apache.lucene.facet.FacetsConfig: Specify drill down terms option on the field / dimension.
setHierarchical(String, boolean) - Method in class org.apache.lucene.facet.FacetsConfig: Pass true if this dimension is hierarchical (has depth > 1 paths).
setIndexFieldName(String, String) - Method in class org.apache.lucene.facet.FacetsConfig: Specify which index field name should hold the ordinals for this dimension; this is only used by the taxonomy based facet methods.
setLiveCommitData(Iterable<Map.Entry<String, String>>) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
setLiveCommitData(Iterable<Map.Entry<String, String>>) - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyWriter: Sets the commit user data iterable.
setMaxSize(int) - Method in class org.apache.lucene.facet.taxonomy.LRUHashMap: setMaxSize() allows changing the map's maximal number of elements which was defined at construction time.
setMultiValued(String, boolean) - Method in class org.apache.lucene.facet.FacetsConfig: Pass true if this dimension may have more than one value per document.
setRequireDimCount(String, boolean) - Method in class org.apache.lucene.facet.FacetsConfig: Pass true if at search time you require accurate counts of the dimension, i.e.
setScorer(Scorable) - Method in class org.apache.lucene.facet.FacetsCollector
setSize(int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.DiskOrdinalMap
setSize(int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.MemoryOrdinalMap
setSize(int) - Method in interface org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.OrdinalMap: Set the size of the map.
siblings() - Method in class org.apache.lucene.facet.taxonomy.ParallelTaxonomyArrays: Returns the siblings array, where siblings[i] denotes the sibling of category ordinal i.
siblingsLoaded() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyFacets: Deprecated.

Returns true if the (costly, and lazily initialized) sibling int[] was initialized.
size() - Method in class org.apache.lucene.facet.taxonomy.writercache.LruTaxonomyWriterCache
size() - Method in interface org.apache.lucene.facet.taxonomy.writercache.TaxonomyWriterCache: How many labels are currently stored in the cache.
size() - Method in class org.apache.lucene.facet.taxonomy.writercache.UTF8TaxonomyWriterCache: Deprecated.

How many labels are currently stored in the cache.
sizePackedBytes() - Method in class org.apache.lucene.facet.facetset.FacetSet: Returns the size of the packed values in this facet set.
sizePackedBytes() - Method in class org.apache.lucene.facet.facetset.FloatFacetSet
sizePackedBytes() - Method in class org.apache.lucene.facet.facetset.IntFacetSet
SortedSetDocValuesFacetCounts - Class in org.apache.lucene.facet.sortedset: Compute facets counts from previously indexed SortedSetDocValuesFacetField, without require a separate taxonomy index.
SortedSetDocValuesFacetCounts(SortedSetDocValuesReaderState) - Constructor for class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetCounts: Returns all facet counts, same result as searching on MatchAllDocsQuery but faster.
SortedSetDocValuesFacetCounts(SortedSetDocValuesReaderState, FacetsCollector) - Constructor for class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetCounts: Counts all facet dimensions across the provided hits.
SortedSetDocValuesFacetField - Class in org.apache.lucene.facet.sortedset: Add an instance of this to your Document for every facet label to be indexed via SortedSetDocValues.
SortedSetDocValuesFacetField(String, String...) - Constructor for class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetField: Sole constructor.
SortedSetDocValuesReaderState - Class in org.apache.lucene.facet.sortedset: Wraps a IndexReader and resolves ords using existing SortedSetDocValues APIs without a separate taxonomy index.
SortedSetDocValuesReaderState() - Constructor for class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Sole constructor.
SortedSetDocValuesReaderState.DimTree - Class in org.apache.lucene.facet.sortedset: Holds children and sibling information for a single dimension.
SortedSetDocValuesReaderState.OrdRange - Class in org.apache.lucene.facet.sortedset: Holds start/end range of ords, which maps to one dimension.
sparseValues - Variable in class org.apache.lucene.facet.taxonomy.IntTaxonomyFacets: Deprecated.

Sparse ordinal values.
start - Variable in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState.OrdRange: Start of range, inclusive:
state - Variable in class org.apache.lucene.facet.DrillSideways: SortedSetDocValuesReaderState passed to constructor; can be null.
StringDocValuesReaderState - Class in org.apache.lucene.facet: Stores an OrdinalMap created for a specific IndexReader (reader) + field.
StringDocValuesReaderState(IndexReader, String) - Constructor for class org.apache.lucene.facet.StringDocValuesReaderState: Construct state specific to a reader + field.
stringToPath(String) - Static method in class org.apache.lucene.facet.FacetsConfig: Turns an encoded string (from a previous call to FacetsConfig.pathToString(java.lang.String, java.lang.String...)) back into the original String[].
StringValueFacetCounts - Class in org.apache.lucene.facet: Compute facet counts from a previously indexed SortedSetDocValues or SortedDocValues field.
StringValueFacetCounts(StringDocValuesReaderState) - Constructor for class org.apache.lucene.facet.StringValueFacetCounts: Returns all facet counts for the field, same result as searching on MatchAllDocsQuery but faster.
StringValueFacetCounts(StringDocValuesReaderState, FacetsCollector) - Constructor for class org.apache.lucene.facet.StringValueFacetCounts: Counts facets across the provided hits.
subpath(int) - Method in class org.apache.lucene.facet.taxonomy.FacetLabel: Returns a sub-path of this path up to length components.
SUM - Static variable in class org.apache.lucene.facet.taxonomy.AssociationAggregationFunction: Aggregation that computes the sum

T

TaxonomyFacetCounts - Class in org.apache.lucene.facet.taxonomy: Deprecated.
Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9. Please switch to FastTaxonomyFacetCounts or implement your own Facets implementation if you have custom needs.
TaxonomyFacetCounts(OrdinalsReader, TaxonomyReader, FacetsConfig, FacetsCollector) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetCounts: Deprecated.

Create TaxonomyFacetCounts, which also counts all facet labels.
TaxonomyFacetFloatAssociations - Class in org.apache.lucene.facet.taxonomy: Aggregates float values associated with facet fields.
TaxonomyFacetFloatAssociations(String, TaxonomyReader, FacetsConfig, FacetsCollector, AssociationAggregationFunction) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetFloatAssociations: Create TaxonomyFacetFloatAssociations against the specified index field.
TaxonomyFacetFloatAssociations(String, TaxonomyReader, FacetsConfig, FacetsCollector, AssociationAggregationFunction, DoubleValuesSource) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetFloatAssociations: Create TaxonomyFacetFloatAssociations against the specified index field.
TaxonomyFacetFloatAssociations(OrdinalsReader, TaxonomyReader, FacetsConfig, FacetsCollector, AssociationAggregationFunction, DoubleValuesSource) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetFloatAssociations: Deprecated.
Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9
TaxonomyFacetFloatAssociations(TaxonomyReader, FacetsConfig, FacetsCollector, AssociationAggregationFunction) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetFloatAssociations: Create TaxonomyFacetFloatAssociations against the default index field.
TaxonomyFacetFloatAssociations(TaxonomyReader, FacetsConfig, FacetsCollector, AssociationAggregationFunction, DoubleValuesSource) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetFloatAssociations: Create TaxonomyFacetFloatAssociations against the default index field.
TaxonomyFacetIntAssociations - Class in org.apache.lucene.facet.taxonomy: Aggregates int values previously indexed with IntAssociationFacetField, assuming the default encoding.
TaxonomyFacetIntAssociations(String, TaxonomyReader, FacetsConfig, FacetsCollector, AssociationAggregationFunction) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetIntAssociations: Create TaxonomyFacetIntAssociations against the specified index field.
TaxonomyFacetIntAssociations(TaxonomyReader, FacetsConfig, FacetsCollector, AssociationAggregationFunction) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetIntAssociations: Create TaxonomyFacetIntAssociations against the default index field.
TaxonomyFacetLabels - Class in org.apache.lucene.facet.taxonomy: Utility class to easily retrieve previously indexed facet labels, allowing you to skip also adding stored fields for these values, reducing your index size.
TaxonomyFacetLabels(TaxonomyReader, String) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetLabels: Sole constructor.
TaxonomyFacetLabels.FacetLabelReader - Class in org.apache.lucene.facet.taxonomy: Utility class to retrieve facet labels for multiple documents.
TaxonomyFacets - Class in org.apache.lucene.facet.taxonomy: Deprecated.
Visibility of this class will be reduced to pkg-private in a future version. This class is meant to host common code as an internal implementation detail to taxonomy faceting,and is not intended as an extension point for user-created Facets implementations. If your code is relying on this, please migrate necessary functionality down into your own class.
TaxonomyFacets(String, TaxonomyReader, FacetsConfig) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacets: Deprecated.

Sole constructor.
TaxonomyFacetSumFloatAssociations - Class in org.apache.lucene.facet.taxonomy: Deprecated.
This class is being deprecated in favor of TaxonomyFacetFloatAssociations, which provides more flexible aggregation functionality beyond just "sum"
TaxonomyFacetSumFloatAssociations(String, TaxonomyReader, FacetsConfig, FacetsCollector) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetSumFloatAssociations: Deprecated.

Create TaxonomyFacetSumFloatAssociations against the specified index field.
TaxonomyFacetSumFloatAssociations(TaxonomyReader, FacetsConfig, FacetsCollector) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetSumFloatAssociations: Deprecated.

Create TaxonomyFacetSumFloatAssociations against the default index field.
TaxonomyFacetSumIntAssociations - Class in org.apache.lucene.facet.taxonomy: Deprecated.
This class is being deprecated in favor of TaxonomyFacetIntAssociations, which provides more flexible aggregation functionality beyond just "sum"
TaxonomyFacetSumIntAssociations(String, TaxonomyReader, FacetsConfig, FacetsCollector) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetSumIntAssociations: Deprecated.

Create TaxonomyFacetSumIntAssociations against the specified index field.
TaxonomyFacetSumIntAssociations(TaxonomyReader, FacetsConfig, FacetsCollector) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetSumIntAssociations: Deprecated.

Create TaxonomyFacetSumIntAssociations against the default index field.
TaxonomyFacetSumValueSource - Class in org.apache.lucene.facet.taxonomy: Deprecated.
This class is being deprecated in favor of TaxonomyFacetFloatAssociations, which provides more flexible aggregation functionality beyond just "sum"
TaxonomyFacetSumValueSource(String, TaxonomyReader, FacetsConfig, FacetsCollector, DoubleValuesSource) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetSumValueSource: Deprecated.

Aggregates double facet values from the provided DoubleValuesSource, pulling ordinals from the specified indexed facet field.
TaxonomyFacetSumValueSource(OrdinalsReader, TaxonomyReader, FacetsConfig, FacetsCollector, DoubleValuesSource) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetSumValueSource: Deprecated.
Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9
TaxonomyFacetSumValueSource(TaxonomyReader, FacetsConfig, FacetsCollector, DoubleValuesSource) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetSumValueSource: Deprecated.

Aggregates double facet values from the provided DoubleValuesSource, pulling ordinals from the default indexed facet field FacetsConfig.DEFAULT_INDEX_FIELD_NAME.
TaxonomyMergeUtils - Class in org.apache.lucene.facet.taxonomy: Utility methods for merging index and taxonomy directories.
taxonomyReader - Variable in class org.apache.lucene.facet.taxonomy.SearcherTaxonomyManager.SearcherAndTaxonomy: Matching point-in-time DirectoryTaxonomyReader.
TaxonomyReader - Class in org.apache.lucene.facet.taxonomy: TaxonomyReader is the read-only interface with which the faceted-search library uses the taxonomy during search time.
TaxonomyReader() - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyReader: Sole constructor.
TaxonomyReader.ChildrenIterator - Class in org.apache.lucene.facet.taxonomy: An iterator over a category's children.
TaxonomyWriter - Interface in org.apache.lucene.facet.taxonomy: TaxonomyWriter is the interface which the faceted-search library uses to dynamically build the taxonomy at indexing time.
TaxonomyWriterCache - Interface in org.apache.lucene.facet.taxonomy.writercache: TaxonomyWriterCache is a relatively simple interface for a cache of category->ordinal mappings, used in TaxonomyWriter implementations (such as DirectoryTaxonomyWriter).
taxoReader - Variable in class org.apache.lucene.facet.DrillSideways: TaxonomyReader passed to constructor.
taxoReader - Variable in class org.apache.lucene.facet.taxonomy.TaxonomyFacets: Deprecated.

TaxonomyReader provided to the constructor.
term(String, String, String...) - Static method in class org.apache.lucene.facet.DrillDownQuery: Creates a drill-down term.
toMultiDoubleValuesSource() - Method in class org.apache.lucene.facet.MultiLongValuesSource: Convert to a MultiDoubleValuesSource by casting long values to doubles
toMultiLongValuesSource() - Method in class org.apache.lucene.facet.MultiDoubleValuesSource: Convert to a MultiLongValuesSource by casting the double values to longs
TopOrdAndFloatQueue - Class in org.apache.lucene.facet: Keeps highest results, first by largest float value, then tie break by smallest ord.
TopOrdAndFloatQueue(int) - Constructor for class org.apache.lucene.facet.TopOrdAndFloatQueue: Sole constructor.
TopOrdAndFloatQueue.OrdAndValue - Class in org.apache.lucene.facet: Holds a single entry.
TopOrdAndIntQueue - Class in org.apache.lucene.facet: Keeps highest results, first by largest int value, then tie break by smallest ord.
TopOrdAndIntQueue(int) - Constructor for class org.apache.lucene.facet.TopOrdAndIntQueue: Sole constructor.
TopOrdAndIntQueue.OrdAndValue - Class in org.apache.lucene.facet: Holds a single entry.
toString() - Method in class org.apache.lucene.facet.FacetField
toString() - Method in class org.apache.lucene.facet.FacetResult
toString() - Method in class org.apache.lucene.facet.LabelAndValue
toString() - Method in class org.apache.lucene.facet.LongValueFacetCounts
toString() - Method in class org.apache.lucene.facet.MultiDoubleValuesSource
toString() - Method in class org.apache.lucene.facet.MultiLongValuesSource
toString() - Method in class org.apache.lucene.facet.range.DoubleRange
toString() - Method in class org.apache.lucene.facet.range.LongRange
toString() - Method in class org.apache.lucene.facet.range.DoubleRangeFacetCounts
toString() - Method in class org.apache.lucene.facet.range.LongRangeFacetCounts
toString() - Method in class org.apache.lucene.facet.rangeonrange.DoubleRange
toString() - Method in class org.apache.lucene.facet.rangeonrange.LongRange
toString() - Method in class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState
toString() - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetField
toString() - Method in class org.apache.lucene.facet.StringDocValuesReaderState
toString() - Method in class org.apache.lucene.facet.taxonomy.AssociationFacetField
toString() - Method in class org.apache.lucene.facet.taxonomy.FacetLabel: Returns a string representation of the path.
toString() - Method in class org.apache.lucene.facet.taxonomy.FloatAssociationFacetField
toString() - Method in class org.apache.lucene.facet.taxonomy.IntAssociationFacetField
toString(int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader: Returns ordinal -> label mapping, up to the provided max ordinal or number of ordinals, whichever is smaller.
toString(String) - Method in class org.apache.lucene.facet.DrillDownQuery
totalHits - Variable in class org.apache.lucene.facet.FacetsCollector.MatchingDocs: Total number of hits
totCount - Variable in class org.apache.lucene.facet.range.DoubleRangeFacetCounts: Total number of hits.
totCount - Variable in class org.apache.lucene.facet.range.LongRangeFacetCounts: Total number of hits.
tryIncRef() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Expert: increments the refCount of this TaxonomyReader instance only if it has not been closed yet.
tryIncRef(SearcherTaxonomyManager.SearcherAndTaxonomy) - Method in class org.apache.lucene.facet.taxonomy.SearcherTaxonomyManager
TYPE - Static variable in class org.apache.lucene.facet.FacetField: Field type used for storing facet values.
TYPE - Static variable in class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetField: Indexed FieldType.
TYPE - Static variable in class org.apache.lucene.facet.taxonomy.AssociationFacetField: Indexed FieldType.

U

unwrapSingleton(MultiDoubleValuesSource) - Static method in class org.apache.lucene.facet.MultiDoubleValuesSource: Returns a single-valued view of the MultiDoubleValuesSource if it was previously wrapped with MultiDoubleValuesSource.fromSingleValued(DoubleValuesSource), or null.
unwrapSingleton(MultiLongValuesSource) - Static method in class org.apache.lucene.facet.MultiLongValuesSource: Returns a single-valued view of the MultiLongValuesSource if it was previously wrapped with MultiLongValuesSource.fromSingleValued(LongValuesSource), or null.
useHashTable(FacetsCollector, TaxonomyReader) - Method in class org.apache.lucene.facet.taxonomy.IntTaxonomyFacets: Deprecated.

Return true if a sparse hash table should be used for counting, instead of a dense int[].
useNumericDocValuesForOrdinals() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
useNumericDocValuesForOrdinals() - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyWriter: Deprecated.
Please don't rely on this method as it will be removed in Lucene 10. It's being introduced to support backwards-compatibility with Lucene 8 and earlier index formats temporarily.
UTF8TaxonomyWriterCache - Class in org.apache.lucene.facet.taxonomy.writercache: Deprecated.
Use LruTaxonomyWriterCache instead.
UTF8TaxonomyWriterCache() - Constructor for class org.apache.lucene.facet.taxonomy.writercache.UTF8TaxonomyWriterCache: Deprecated.

Sole constructor.

V

validateTopN(int) - Static method in class org.apache.lucene.facet.Facets: This helper method checks if topN is valid for getTopChildren and getAllDims.
value - Variable in class org.apache.lucene.facet.FacetResult: Total number of documents containing a value for this path, even those not included in the topN.
value - Variable in class org.apache.lucene.facet.LabelAndValue: Value associated with this label.
value - Variable in class org.apache.lucene.facet.TopOrdAndFloatQueue.OrdAndValue: Value associated with the ordinal.
value - Variable in class org.apache.lucene.facet.TopOrdAndIntQueue.OrdAndValue: Value associated with the ordinal.
valueOf(String) - Static method in enum org.apache.lucene.facet.FacetsConfig.DrillDownTermsIndexing: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.lucene.facet.taxonomy.writercache.LruTaxonomyWriterCache.LRUType: Returns the enum constant of this type with the specified name.
values - Variable in class org.apache.lucene.facet.facetset.DoubleFacetSet: The raw dimension values of this facet set.
values - Variable in class org.apache.lucene.facet.facetset.FloatFacetSet: The raw dimension values of this facet set.
values - Variable in class org.apache.lucene.facet.facetset.IntFacetSet: The raw dimension values of this facet set.
values - Variable in class org.apache.lucene.facet.facetset.LongFacetSet: The raw dimension values of this facet set.
values - Variable in class org.apache.lucene.facet.taxonomy.FloatTaxonomyFacets: Deprecated.

Per-ordinal value.
values - Variable in class org.apache.lucene.facet.taxonomy.IntTaxonomyFacets: Deprecated.

Dense ordinal values.
values() - Static method in enum org.apache.lucene.facet.FacetsConfig.DrillDownTermsIndexing: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.lucene.facet.taxonomy.writercache.LruTaxonomyWriterCache.LRUType: Returns an array containing the constants of this enum type, in the order they are declared.
verifyDim(String) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyFacets: Deprecated.

Verifies and returns FacetsConfig.DimConfig for the given dimension name.
verifyLabel(String) - Static method in class org.apache.lucene.facet.FacetField: Verifies the label is not null or empty string.
visit(QueryVisitor) - Method in class org.apache.lucene.facet.DrillDownQuery

W

wrap(BinaryDocValues, BiConsumer<BytesRef, IntsRef>) - Static method in class org.apache.lucene.facet.taxonomy.BackCompatSortedNumericDocValues: Deprecated.

Wrap the provided binary encoded doc values.

A B C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form