A B C D E F G H I K L M N O P Q R S T U V W

## A

acceptsDocsOutOfOrder() - Method in class org.apache.lucene.facet.search.FacetsCollector
accumulate(ScoredDocIDs) - Method in class org.apache.lucene.facet.search.AdaptiveFacetsAccumulator
accumulate(ScoredDocIDs) - Method in class org.apache.lucene.facet.search.FacetsAccumulator
  Accumulate facets over given documents, according to facet requests in effect.
accumulate(ScoredDocIDs) - Method in class org.apache.lucene.facet.search.sampling.SamplingAccumulator
accumulate(ScoredDocIDs) - Method in class org.apache.lucene.facet.search.SamplingWrapper
accumulate(ScoredDocIDs) - Method in class org.apache.lucene.facet.search.StandardFacetsAccumulator
actualDocsToAccumulate(ScoredDocIDs) - Method in class org.apache.lucene.facet.search.sampling.SamplingAccumulator
actualDocsToAccumulate(ScoredDocIDs) - Method in class org.apache.lucene.facet.search.StandardFacetsAccumulator
  Set the actual set of documents over which accumulation should take place.
actualSampleRatio - Variable in class org.apache.lucene.facet.search.sampling.Sampler.SampleResult
AdaptiveFacetsAccumulator - Class in org.apache.lucene.facet.search
  `FacetsAccumulator` whose behavior regarding complements, sampling, etc.
AdaptiveFacetsAccumulator(FacetSearchParams, IndexReader, TaxonomyReader) - Constructor for class org.apache.lucene.facet.search.AdaptiveFacetsAccumulator
  Create an `AdaptiveFacetsAccumulator`
AdaptiveFacetsAccumulator(FacetSearchParams, IndexReader, TaxonomyReader, IntArrayAllocator, FloatArrayAllocator) - Constructor for class org.apache.lucene.facet.search.AdaptiveFacetsAccumulator
  Create an `AdaptiveFacetsAccumulator`
add(T) - Method in interface org.apache.lucene.facet.search.Heap
  Add a new value to the heap, return the new top().
add(CharSequence) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Add the given component to the end of the path.
add(CharSequence, char) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Add the given components to the end of the path.
add(int) - Method in class org.apache.lucene.util.collections.IntHashSet
  Add a mapping int key -> int value.
addCategory(CategoryPath) - Method in class org.apache.lucene.facet.index.CategoryContainer
  Add a category.
addCategory(CategoryPath, CategoryProperty) - Method in class org.apache.lucene.facet.index.CategoryContainer
  Add a category with a property.
addCategory(CategoryPath, CategoryProperty...) - Method in class org.apache.lucene.facet.index.CategoryContainer
  Add a category with multiple properties.
addCategory(CategoryAttribute) - Method in class org.apache.lucene.facet.index.CategoryContainer
  Add an entire `CategoryAttribute`.
addCategory(CategoryPath) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
addCategory(CategoryPath) - 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.
addCategoryDocument(CategoryPath, int, int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
addCategoryEnhancements(CategoryEnhancement...) - Method in class org.apache.lucene.facet.enhancements.params.DefaultEnhancementsIndexingParams
addCategoryEnhancements(CategoryEnhancement...) - Method in interface org.apache.lucene.facet.enhancements.params.EnhancementsIndexingParams
  Add `CategoryEnhancement`s to the indexing parameters
addCategoryListParams(CategoryPath, CategoryListParams) - Method in class org.apache.lucene.facet.index.params.PerDimensionIndexingParams
  Add a CategoryListParams for a given CategoryPath's dimension or "zero-th" category.
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.
addFacetRequest(FacetRequest) - Method in class org.apache.lucene.facet.search.params.FacetSearchParams
  Add a facet request to apply for this faceted search.
addLabel(CategoryPath, int, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.CollisionMap
addLabel(CategoryPath, int, int, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.CollisionMap
addLabel(CategoryPath, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.CompactLabelToOrdinal
addLabel(CategoryPath, int, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.CompactLabelToOrdinal
addLabel(CategoryPath, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.LabelToOrdinal
  Adds a new label if its not yet in the table.
addLabel(CategoryPath, int, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.LabelToOrdinal
  Adds a new label if its not yet in the table.
addLabelOffset(int, int, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.CollisionMap
  This method does not check if the same value is already in the map because we pass in an char-array offset, so so we now that we're in resize-mode here.
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
addProperty(CategoryProperty) - Method in interface org.apache.lucene.facet.index.attributes.CategoryAttribute
  Add a property.
addProperty(CategoryProperty) - Method in class org.apache.lucene.facet.index.attributes.CategoryAttributeImpl
addRetainableProperty(Class<? extends CategoryProperty>) - Method in class org.apache.lucene.facet.index.streaming.CategoryParentsStream
  Add a `CategoryProperty` class which is retained when creating parent tokens.
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.
addToArray(int) - Method in class org.apache.lucene.util.collections.IntArray
  Adds a value to the array.
aggregate(int) - Method in interface org.apache.lucene.facet.search.aggregator.Aggregator
  Collect (and do whatever an implementation deems appropriate) the category given by its ordinal.
aggregate(int) - Method in class org.apache.lucene.facet.search.aggregator.association.AssociationFloatSumAggregator
aggregate(int) - Method in class org.apache.lucene.facet.search.aggregator.association.AssociationIntSumAggregator
aggregate(int) - Method in class org.apache.lucene.facet.search.aggregator.ComplementCountingAggregator
aggregate(int) - Method in class org.apache.lucene.facet.search.aggregator.CountingAggregator
aggregate(int) - Method in class org.apache.lucene.facet.search.aggregator.ScoringAggregator
Aggregator - Interface in org.apache.lucene.facet.search.aggregator
  An Aggregator is the analogue of Lucene's Collector (see `Collector`), for processing the categories belonging to a certain document.
allocate() - Method in class org.apache.lucene.facet.search.TemporaryObjectAllocator
  Allocate a new object.
appendIntToStream(int) - Method in class org.apache.lucene.facet.index.CategoryListPayloadStream
  Appends an integer to the stream.
appendSubResult(FacetResultNode) - Method in class org.apache.lucene.facet.search.results.MutableFacetResultNode
  Append a sub result (as last).
appendTo(Appendable, char) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Build a string representation of the path, with its components separated by the given delimiter character.
appendTo(Appendable, char, int) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  like `CategoryPath.appendTo(Appendable, char)`, but takes only a prefix of the path, rather than the whole path.
appendTo(Appendable, char, int, int) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  like `CategoryPath.appendTo(Appendable, char)`, but takes only a part of the path, rather than the whole path.
ArrayHashMap<K,V> - Class in org.apache.lucene.util.collections
  An Array-based hashtable which maps, similar to Java's HashMap, only performance tests showed it performs better.
ArrayHashMap() - Constructor for class org.apache.lucene.util.collections.ArrayHashMap
  Constructs a map with default capacity.
ArrayHashMap(int) - Constructor for class org.apache.lucene.util.collections.ArrayHashMap
  Constructs a map with given capacity.
association - Variable in class org.apache.lucene.facet.enhancements.association.AssociationProperty
ASSOCIATION_POSTING_TERM - Static variable in class org.apache.lucene.facet.enhancements.association.AssociationsPayloadIterator
  Default Term for associations
AssociationEnhancement - Class in org.apache.lucene.facet.enhancements.association
  A `CategoryEnhancement` for adding associations data to the index (categories with `AssociationProperty`s).
AssociationEnhancement() - Constructor for class org.apache.lucene.facet.enhancements.association.AssociationEnhancement
AssociationFloatProperty - Class in org.apache.lucene.facet.enhancements.association
  An `AssociationProperty` which treats the association as float - the association bits are actually float bits, and thus merging two associations is done by float summation.
AssociationFloatProperty(float) - Constructor for class org.apache.lucene.facet.enhancements.association.AssociationFloatProperty
  Constructor.
AssociationFloatSumAggregator - Class in org.apache.lucene.facet.search.aggregator.association
  An `Aggregator` which updates the weight of a category by summing the weights of the float association it finds for every document.
AssociationFloatSumAggregator(IndexReader, float[]) - Constructor for class org.apache.lucene.facet.search.aggregator.association.AssociationFloatSumAggregator
AssociationFloatSumAggregator(String, IndexReader, float[]) - Constructor for class org.apache.lucene.facet.search.aggregator.association.AssociationFloatSumAggregator
AssociationFloatSumFacetRequest - Class in org.apache.lucene.facet.search.params.association
  Facet request for weighting facets according to their float association by summing the association values.
AssociationFloatSumFacetRequest(CategoryPath, int) - Constructor for class org.apache.lucene.facet.search.params.association.AssociationFloatSumFacetRequest
  Create a float association facet request for a given node in the taxonomy.
AssociationIntProperty - Class in org.apache.lucene.facet.enhancements.association
  An `AssociationProperty` which treats the association as int - merges two associations by summation.
AssociationIntProperty(int) - Constructor for class org.apache.lucene.facet.enhancements.association.AssociationIntProperty
AssociationIntSumAggregator - Class in org.apache.lucene.facet.search.aggregator.association
  An `Aggregator` which updates the weight of a category by summing the weights of the integer association it finds for every document.
AssociationIntSumAggregator(IndexReader, int[]) - Constructor for class org.apache.lucene.facet.search.aggregator.association.AssociationIntSumAggregator
AssociationIntSumAggregator(String, IndexReader, int[]) - Constructor for class org.apache.lucene.facet.search.aggregator.association.AssociationIntSumAggregator
AssociationIntSumFacetRequest - Class in org.apache.lucene.facet.search.params.association
  Facet request for weighting facets according to their integer association by summing the association values.
AssociationIntSumFacetRequest(CategoryPath, int) - Constructor for class org.apache.lucene.facet.search.params.association.AssociationIntSumFacetRequest
  Create an integer association facet request for a given node in the taxonomy.
AssociationListTokenizer - Class in org.apache.lucene.facet.enhancements.association
  Tokenizer for associations of a category
AssociationListTokenizer(TokenStream, EnhancementsIndexingParams, CategoryEnhancement) - Constructor for class org.apache.lucene.facet.enhancements.association.AssociationListTokenizer
AssociationProperty - Class in org.apache.lucene.facet.enhancements.association
  A `CategoryProperty` associating a single integer value to a `CategoryAttribute`.
AssociationProperty(int) - Constructor for class org.apache.lucene.facet.enhancements.association.AssociationProperty
  Construct an `AssociationProperty`.
AssociationsPayloadIterator - Class in org.apache.lucene.facet.enhancements.association
  Allows easy iteration over the associations payload, decoding and breaking it to (ordinal, value) pairs, stored in a hash.
AssociationsPayloadIterator(IndexReader, String) - Constructor for class org.apache.lucene.facet.enhancements.association.AssociationsPayloadIterator
  Construct a new association-iterator, initializing the inner payload iterator, with the supplied term and checking whether there are any associations within the given index
associationsPayloadIterator - Variable in class org.apache.lucene.facet.search.aggregator.association.AssociationFloatSumAggregator
associationsPayloadIterator - Variable in class org.apache.lucene.facet.search.aggregator.association.AssociationIntSumAggregator
available() - Method in class org.apache.lucene.util.UnsafeByteArrayInputStream

## B

buffer - Variable in class org.apache.lucene.facet.search.PayloadIterator
build(Document) - Method in class org.apache.lucene.facet.index.CategoryDocumentBuilder
  Adds the fields created in one of the "set" methods to the document
bytesNeeded(int) - Static method in class org.apache.lucene.util.Vint8
  Returns the number of bytes needed to encode `number`.

## C

calcBaseHashIndex(K) - Method in class org.apache.lucene.util.collections.ArrayHashMap
  Calculating the baseHash index using the internal internal `hashFactor`.
calcBaseHashIndex(float) - Method in class org.apache.lucene.util.collections.FloatToObjectMap
  Calculating the baseHash index using the internal `hashFactor`.
calcBaseHashIndex(int) - Method in class org.apache.lucene.util.collections.IntHashSet
  Calculating the baseHash index using the internal `hashFactor` .
calcBaseHashIndex(int) - Method in class org.apache.lucene.util.collections.IntToDoubleMap
  Calculating the baseHash index using the internal `hashFactor` .
calcBaseHashIndex(int) - Method in class org.apache.lucene.util.collections.IntToIntMap
  Calculating the baseHash index using the internal `hashFactor`.
calcBaseHashIndex(int) - Method in class org.apache.lucene.util.collections.IntToObjectMap
  Calculating the baseHash index using the internal `hashFactor`.
calcBaseHashIndex(K) - Method in class org.apache.lucene.util.collections.ObjectToFloatMap
  Calculating the baseHash index using the internal `hashFactor`.
calcBaseHashIndex(K) - Method in class org.apache.lucene.util.collections.ObjectToIntMap
  Calculating the baseHash index using the internal `hashFactor`.
capacity() - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.CollisionMap
capacityChars() - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Returns the current character capacity of the CategoryPath.
capacityComponents() - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Returns the current component capacity of the CategoryPath.
categoriesMap - Variable in class org.apache.lucene.facet.index.CategoryDocumentBuilder
CategoryAttribute - Interface in org.apache.lucene.facet.index.attributes
  An attribute which contains for a certain category the `CategoryPath` and additional properties.
categoryAttribute - Variable in class org.apache.lucene.facet.index.streaming.CategoryAttributesStream
categoryAttribute - Variable in class org.apache.lucene.facet.index.streaming.CategoryParentsStream
  An attribute containing all data related to the category
categoryAttribute - Variable in class org.apache.lucene.facet.index.streaming.CategoryTokenizerBase
  The stream's category attributes.
CategoryAttributeImpl - Class in org.apache.lucene.facet.index.attributes
  An implementation of `CategoryAttribute`.
CategoryAttributeImpl() - Constructor for class org.apache.lucene.facet.index.attributes.CategoryAttributeImpl
  Construct an empty CategoryAttributeImpl.
CategoryAttributeImpl(CategoryPath) - Constructor for class org.apache.lucene.facet.index.attributes.CategoryAttributeImpl
  Construct a CategoryAttributeImpl with the given CategoryPath.
CategoryAttributesIterable - Class in org.apache.lucene.facet.index.attributes
  This class transforms an `Iterable` of `CategoryPath` objects into an `Iterable` of `CategoryAttribute` objects, which can be used to construct a `CategoryAttributesStream`.
CategoryAttributesIterable(Iterable<CategoryPath>) - Constructor for class org.apache.lucene.facet.index.attributes.CategoryAttributesIterable
CategoryAttributesStream - Class in org.apache.lucene.facet.index.streaming
  An attribute stream built from an `Iterable` of `CategoryAttribute`.
CategoryAttributesStream(Iterable<CategoryAttribute>) - Constructor for class org.apache.lucene.facet.index.streaming.CategoryAttributesStream
  Constructor
CategoryContainer - Class in org.apache.lucene.facet.index
  A container to add categories which are to be introduced to `CategoryDocumentBuilder.setCategories(Iterable)`.
CategoryContainer() - Constructor for class org.apache.lucene.facet.index.CategoryContainer
  Constructor.
CategoryDocumentBuilder - Class in org.apache.lucene.facet.index
  A utility class which allows attachment of `CategoryPath`s or `CategoryAttribute`s to a given document using a taxonomy.
  Construction could be done with either a given `FacetIndexingParams` or the default implementation `DefaultFacetIndexingParams`.
  A CategoryDocumentBuilder can be reused by repeatedly setting the categories and building the document.
CategoryDocumentBuilder(TaxonomyWriter) - Constructor for class org.apache.lucene.facet.index.CategoryDocumentBuilder
  Creating a facets document builder with default facet indexing parameters.
  See: `CategoryDocumentBuilder.CategoryDocumentBuilder(TaxonomyWriter, FacetIndexingParams)`
CategoryDocumentBuilder(TaxonomyWriter, FacetIndexingParams) - Constructor for class org.apache.lucene.facet.index.CategoryDocumentBuilder
  Creating a facets document builder with a given facet indexing parameters object.
CategoryEnhancement - Interface in org.apache.lucene.facet.enhancements
  This interface allows easy addition of enhanced category features.
CategoryListCache - Class in org.apache.lucene.facet.search.cache
  Cache for `CategoryListData`, per `CategoryListParams`.
CategoryListCache() - Constructor for class org.apache.lucene.facet.search.cache.CategoryListCache
CategoryListData - Class in org.apache.lucene.facet.search.cache
  Category list data maintained in RAM.
CategoryListData() - Constructor for class org.apache.lucene.facet.search.cache.CategoryListData
  Empty constructor for extensions with modified computation of the data.
CategoryListIterator - Interface in org.apache.lucene.facet.search
  An interface for iterating over a "category list", i.e., the list of categories per document.
CategoryListParams - Class in org.apache.lucene.facet.index.params
  Contains parameters for a category list *
CategoryListParams() - Constructor for class org.apache.lucene.facet.index.params.CategoryListParams
  Constructs a default category list parameters object, using `CategoryListParams.DEFAULT_TERM`.
CategoryListParams(Term) - Constructor for class org.apache.lucene.facet.index.params.CategoryListParams
  Constructs a category list parameters object, using the given `Term`.
CategoryListPayloadStream - Class in org.apache.lucene.facet.index
  Accumulates category IDs for a single document, for writing in byte array form, for example, to a Lucene Payload.
CategoryListPayloadStream(IntEncoder) - Constructor for class org.apache.lucene.facet.index.CategoryListPayloadStream
  Creates a Payload stream using the specified encoder.
CategoryListTokenizer - Class in org.apache.lucene.facet.index.streaming
  A base class for category list tokenizers, which add category list tokens to category streams.
CategoryListTokenizer(TokenStream, FacetIndexingParams) - Constructor for class org.apache.lucene.facet.index.streaming.CategoryListTokenizer
CategoryParentsStream - Class in org.apache.lucene.facet.index.streaming
  This class adds parents to a `CategoryAttributesStream`.
CategoryParentsStream(CategoryAttributesStream, TaxonomyWriter, FacetIndexingParams) - Constructor for class org.apache.lucene.facet.index.streaming.CategoryParentsStream
  Constructor.
categoryPath - Variable in class org.apache.lucene.facet.index.attributes.CategoryAttributeImpl
  The category path instance.
CategoryPath - Class in org.apache.lucene.facet.taxonomy
  A CategoryPath holds a sequence of string components, specifying the hierarchical name of a category.
CategoryPath(int, int) - Constructor for class org.apache.lucene.facet.taxonomy.CategoryPath
  Construct a new empty CategoryPath object.
CategoryPath() - Constructor for class org.apache.lucene.facet.taxonomy.CategoryPath
  Create an empty CategoryPath object.
CategoryPath(String, char) - Constructor for class org.apache.lucene.facet.taxonomy.CategoryPath
  Construct a new CategoryPath object, given a single string with components separated by a given delimiter character.
CategoryPath(CharSequence...) - Constructor for class org.apache.lucene.facet.taxonomy.CategoryPath
  Construct a new CategoryPath object, copying an existing path given as an array of strings.
CategoryPath(CategoryPath) - Constructor for class org.apache.lucene.facet.taxonomy.CategoryPath
  Construct a new CategoryPath object, copying the path given in an existing CategoryPath object.
CategoryPath(CategoryPath, int) - Constructor for class org.apache.lucene.facet.taxonomy.CategoryPath
  Construct a new CategoryPath object, copying a prefix with the given number of components of the path given in an existing CategoryPath object.
CategoryProperty - Interface in org.apache.lucene.facet.index.attributes
  Property that can be added to `CategoryAttribute`s during indexing.
CategoryTokenizer - Class in org.apache.lucene.facet.index.streaming
  Basic class for setting the `CharTermAttribute`s and `PayloadAttribute`s of category tokens.
CategoryTokenizer(TokenStream, FacetIndexingParams) - Constructor for class org.apache.lucene.facet.index.streaming.CategoryTokenizer
CategoryTokenizerBase - Class in org.apache.lucene.facet.index.streaming
  A base class for all token filters which add term and payload attributes to tokens and are to be used in `CategoryDocumentBuilder`.
CategoryTokenizerBase(TokenStream, FacetIndexingParams) - Constructor for class org.apache.lucene.facet.index.streaming.CategoryTokenizerBase
  Constructor.
chars - Variable in class org.apache.lucene.facet.taxonomy.CategoryPath
charsNeededForFullPath() - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Returns the number of characters required to represent this entire category path, if written using `CategoryPath.copyToCharArray(char[], int, int, char)` or `CategoryPath.appendTo(Appendable, char)`.
ChunksIntEncoder - Class in org.apache.lucene.util.encoding
  An `IntEncoder` which encodes values in chunks.
ChunksIntEncoder(int) - Constructor for class org.apache.lucene.util.encoding.ChunksIntEncoder
Cl2oTaxonomyWriterCache - Class in org.apache.lucene.facet.taxonomy.writercache.cl2o
  `TaxonomyWriterCache` using `CompactLabelToOrdinal`.
Cl2oTaxonomyWriterCache(int, float, int) - Constructor for class org.apache.lucene.facet.taxonomy.writercache.cl2o.Cl2oTaxonomyWriterCache
clear() - Method in interface org.apache.lucene.facet.index.attributes.CategoryAttribute
  Resets this attribute to its initial value: a null category path and no properties.
clear() - Method in class org.apache.lucene.facet.index.attributes.CategoryAttributeImpl
clear() - Method in class org.apache.lucene.facet.index.attributes.OrdinalProperty
clear() - Method in class org.apache.lucene.facet.index.CategoryContainer
  Remove all categories.
clear(float[]) - Method in class org.apache.lucene.facet.search.FloatArrayAllocator
clear() - Method in interface org.apache.lucene.facet.search.Heap
  Clear the heap
clear(int[]) - Method in class org.apache.lucene.facet.search.IntArrayAllocator
clear(T) - Method in class org.apache.lucene.facet.search.TemporaryObjectAllocator
  Subclasses must override this method to clear an existing object of the desired type, to prepare it for reuse.
clear() - Method in class org.apache.lucene.facet.search.TotalFacetCountsCache
  Clear the cache.
clear() - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Empty the CategoryPath object, so that it has zero components.
clear() - Method in class org.apache.lucene.util.collections.ArrayHashMap
  Empties the map.
clear() - Method in class org.apache.lucene.util.collections.FloatToObjectMap
  Empties the map.
clear(boolean) - Method in class org.apache.lucene.util.collections.IntArray
  Clear the IntArray (set all elements to zero).
clear() - Method in class org.apache.lucene.util.collections.IntHashSet
  Empties the map.
clear() - Method in class org.apache.lucene.util.collections.IntToDoubleMap
  Empties the map.
clear() - Method in class org.apache.lucene.util.collections.IntToIntMap
  Empties the map.
clear() - Method in class org.apache.lucene.util.collections.IntToObjectMap
  Empties the map.
clear() - Method in class org.apache.lucene.util.collections.ObjectToFloatMap
  Empties the map.
clear() - Method in class org.apache.lucene.util.collections.ObjectToIntMap
  Empties the map.
clearCategoryProperties() - Method in class org.apache.lucene.facet.index.streaming.CategoryParentsStream
  Clear the properties of the current `CategoryAttribute` attribute before setting the parent attributes.
clearProperties() - Method in interface org.apache.lucene.facet.index.attributes.CategoryAttribute
  Clear all properties.
clearProperties() - Method in class org.apache.lucene.facet.index.attributes.CategoryAttributeImpl
clone() - Method in interface org.apache.lucene.facet.index.attributes.CategoryAttribute
  Clone this `CategoryAttribute`.
clone() - Method in class org.apache.lucene.facet.index.attributes.CategoryAttributeImpl
clone() - Method in class org.apache.lucene.facet.search.params.FacetRequest
clone() - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
close() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
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.writercache.cl2o.Cl2oTaxonomyWriterCache
close() - Method in class org.apache.lucene.facet.taxonomy.writercache.lru.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.util.encoding.ChunksIntEncoder
close() - Method in class org.apache.lucene.util.encoding.IntEncoder
  Instructs the encoder to finish the encoding process.
close() - Method in class org.apache.lucene.util.encoding.IntEncoderFilter
close() - Method in class org.apache.lucene.util.encoding.NOnesIntEncoder
close() - Method in class org.apache.lucene.util.encoding.SortingIntEncoder
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.search.FacetsCollector
CollisionMap - Class in org.apache.lucene.facet.taxonomy.writercache.cl2o
  HashMap to store colliding labels.
CollisionMap(CharBlockArray) - Constructor for class org.apache.lucene.facet.taxonomy.writercache.cl2o.CollisionMap
CollisionMap(int, CharBlockArray) - Constructor for class org.apache.lucene.facet.taxonomy.writercache.cl2o.CollisionMap
commit() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
  Calling commit() ensures that all the categories written so far are visible to a reader that is opened (or reopened) after that call.
commit(Map<String, String>) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
  Like commit(), but also store properties with the index.
CompactLabelToOrdinal - Class in org.apache.lucene.facet.taxonomy.writercache.cl2o
  This is a very efficient LabelToOrdinal implementation that uses a CharBlockArray to store all labels and a configurable number of HashArrays to reference the labels.
CompactLabelToOrdinal(int, float, int) - Constructor for class org.apache.lucene.facet.taxonomy.writercache.cl2o.CompactLabelToOrdinal
compareTo(CategoryPath) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Compares this CategoryPath with the other CategoryPath for lexicographic order.
ComplementCountingAggregator - Class in org.apache.lucene.facet.search.aggregator
  A `CountingAggregator` used during complement counting.
ComplementCountingAggregator(int[]) - Constructor for class org.apache.lucene.facet.search.aggregator.ComplementCountingAggregator
contains(int) - Method in class org.apache.lucene.util.collections.IntHashSet
  Checks if a given key exists in the map.
containsKey(K) - Method in class org.apache.lucene.util.collections.ArrayHashMap
  Returns true iff the key exists in the map.
containsKey(float) - Method in class org.apache.lucene.util.collections.FloatToObjectMap
  Checks if a given key exists in the map.
containsKey(int) - Method in class org.apache.lucene.util.collections.IntToDoubleMap
  Checks if a given key exists in the map.
containsKey(int) - Method in class org.apache.lucene.util.collections.IntToIntMap
  Checks if a given key exists in the map.
containsKey(int) - Method in class org.apache.lucene.util.collections.IntToObjectMap
  Checks if a given key exists in the map.
containsKey(K) - Method in class org.apache.lucene.util.collections.ObjectToFloatMap
  Checks if a given key exists in the map.
containsKey(K) - Method in class org.apache.lucene.util.collections.ObjectToIntMap
  Checks if a given key exists in the map.
containsValue(Object) - Method in class org.apache.lucene.util.collections.ArrayHashMap
  Returns true iff the object exists in the map.
containsValue(Object) - Method in class org.apache.lucene.util.collections.FloatToObjectMap
  Checks if the given object exists in the map.
  This method iterates over the collection, trying to find an equal object.
containsValue(double) - Method in class org.apache.lucene.util.collections.IntToDoubleMap
  Checks if the given value exists in the map.
  This method iterates over the collection, trying to find an equal object.
containsValue(int) - Method in class org.apache.lucene.util.collections.IntToIntMap
  Checks if the given object exists in the map.
  This method iterates over the collection, trying to find an equal object.
containsValue(Object) - Method in class org.apache.lucene.util.collections.IntToObjectMap
  Checks if the given object exists in the map.
  This method iterates over the collection, trying to find an equal object.
containsValue(float) - Method in class org.apache.lucene.util.collections.ObjectToFloatMap
  Checks if the given object exists in the map.
  This method iterates over the collection, trying to find an equal object.
containsValue(int) - Method in class org.apache.lucene.util.collections.ObjectToIntMap
  Checks if the given object exists in the map.
  This method iterates over the collection, trying to find an equal object.
convertStreamToByteArray() - Method in class org.apache.lucene.facet.index.CategoryListPayloadStream
  Returns the streamed bytes so far accumulated, as an array of bytes.
copyTo(AttributeImpl) - Method in class org.apache.lucene.facet.index.attributes.CategoryAttributeImpl
copyToCharArray(char[], int, int, char) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Copies the specified number of components from this category path to the specified character array, with the components separated by a given delimiter character.
counter - Variable in class org.apache.lucene.facet.taxonomy.writercache.cl2o.LabelToOrdinal
counterArray - Variable in class org.apache.lucene.facet.search.aggregator.CountingAggregator
CountFacetRequest - Class in org.apache.lucene.facet.search.params
  Facet request for counting facets.
CountFacetRequest(CategoryPath, int) - Constructor for class org.apache.lucene.facet.search.params.CountFacetRequest
  Create a count facet request for a given node in the taxonomy.
CountingAggregator - Class in org.apache.lucene.facet.search.aggregator
  A CountingAggregator updates a counter array with the size of the whole taxonomy, counting the number of times each category appears in the given set of documents.
CountingAggregator(int[]) - Constructor for class org.apache.lucene.facet.search.aggregator.CountingAggregator
CountingListTokenizer - Class in org.apache.lucene.facet.index.streaming
  `CategoryListTokenizer` for facet counting
CountingListTokenizer(TokenStream, FacetIndexingParams) - Constructor for class org.apache.lucene.facet.index.streaming.CountingListTokenizer
create() - Method in class org.apache.lucene.facet.search.FloatArrayAllocator
create() - Method in class org.apache.lucene.facet.search.IntArrayAllocator
create(int, boolean) - Static method in class org.apache.lucene.facet.search.ScoredDocIdCollector
  Creates a new `ScoredDocIdCollector` with the given parameters.
create() - Method in class org.apache.lucene.facet.search.TemporaryObjectAllocator
  Subclasses must override this method to actually create a new object of the desired type.
createAggregator(boolean, FacetArrays, IndexReader, TaxonomyReader) - Method in class org.apache.lucene.facet.search.params.association.AssociationFloatSumFacetRequest
createAggregator(boolean, FacetArrays, IndexReader, TaxonomyReader) - Method in class org.apache.lucene.facet.search.params.association.AssociationIntSumFacetRequest
createAggregator(boolean, FacetArrays, IndexReader, TaxonomyReader) - Method in class org.apache.lucene.facet.search.params.CountFacetRequest
createAggregator(boolean, FacetArrays, IndexReader, TaxonomyReader) - Method in class org.apache.lucene.facet.search.params.FacetRequest
  Create an aggregator for this facet request.
createAggregator(boolean, FacetArrays, IndexReader, TaxonomyReader) - Method in class org.apache.lucene.facet.search.params.ScoreFacetRequest
createAllDocsScoredDocIDs(IndexReader) - Static method in class org.apache.lucene.facet.util.ScoredDocIdsUtils
  Creates a `ScoredDocIDs` which returns document IDs all non-deleted doc ids according to the given reader.
createCategoryListIterator(IndexReader, int) - Method in class org.apache.lucene.facet.index.params.CategoryListParams
  Create the category list iterator for the specified partition.
createCategoryListIterator(IndexReader, TaxonomyReader, FacetSearchParams, int) - Method in class org.apache.lucene.facet.search.params.FacetRequest
  Create the category list iterator for the specified partition.
createEncoder() - Method in class org.apache.lucene.facet.index.params.CategoryListParams
  Allows to override how categories are encoded and decoded.
createFacetResultsHandler(TaxonomyReader) - Method in class org.apache.lucene.facet.search.params.FacetRequest
  Creates a new `FacetResultsHandler` that matches the request logic and current settings, such as `depth`, `limits-mode`, etc, as well as the passed in `TaxonomyReader`.
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.
createMatchingDecoder() - Method in class org.apache.lucene.util.encoding.DGapIntEncoder
createMatchingDecoder() - Method in class org.apache.lucene.util.encoding.EightFlagsIntEncoder
createMatchingDecoder() - Method in class org.apache.lucene.util.encoding.FourFlagsIntEncoder
createMatchingDecoder() - Method in class org.apache.lucene.util.encoding.IntEncoder
  Returns an `IntDecoder` which matches this encoder.
createMatchingDecoder() - Method in class org.apache.lucene.util.encoding.NOnesIntEncoder
createMatchingDecoder() - Method in class org.apache.lucene.util.encoding.SimpleIntEncoder
createMatchingDecoder() - Method in class org.apache.lucene.util.encoding.SortingIntEncoder
createMatchingDecoder() - Method in class org.apache.lucene.util.encoding.UniqueValuesIntEncoder
createMatchingDecoder() - Method in class org.apache.lucene.util.encoding.VInt8IntEncoder
createSample(ScoredDocIDs, int, int) - Method in class org.apache.lucene.facet.search.sampling.RandomSampler
createSample(ScoredDocIDs, int, int) - Method in class org.apache.lucene.facet.search.sampling.RepeatableSampler
createSample(ScoredDocIDs, int, int) - Method in class org.apache.lucene.facet.search.sampling.Sampler
  Create and return a sample of the input set
createScoredDocIds(DocIdSet, int) - Static method in class org.apache.lucene.facet.util.ScoredDocIdsUtils
  Create a ScoredDocIDs out of a given docIdSet and the total number of documents in an index
createScoredDocIDsSubset(ScoredDocIDs, int[]) - Static method in class org.apache.lucene.facet.util.ScoredDocIdsUtils
  Create a subset of an existing ScoredDocIDs object.
createSuitableHeap(FacetRequest) - Static method in class org.apache.lucene.facet.util.ResultSortUtils
  Create a suitable heap according to facet request being served.

## D

decode() - Method in class org.apache.lucene.util.encoding.DGapIntDecoder
decode() - Method in class org.apache.lucene.util.encoding.EightFlagsIntDecoder
decode() - Method in class org.apache.lucene.util.encoding.FourFlagsIntDecoder
decode() - Method in class org.apache.lucene.util.encoding.IntDecoder
  Decodes data received from the input stream, and returns one decoded integer.
decode() - Method in class org.apache.lucene.util.encoding.NOnesIntDecoder
decode() - Method in class org.apache.lucene.util.encoding.SimpleIntDecoder
decode() - Method in class org.apache.lucene.util.encoding.VInt8IntDecoder
decode(byte[], Vint8.Position) - Static method in class org.apache.lucene.util.Vint8
  Decodes a 32-bit integer from `bytes`, beginning at offset `pos.pos`.
decode(InputStream) - Static method in class org.apache.lucene.util.Vint8
  Decodes a 32-bit integer from bytes read from `in`.
decRef() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
  Expert: decreases the refCount of this TaxonomyReader instance.
decRef() - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyReader
  Expert: decreases the refCount of this TaxonomyReader instance.
DEFAULT_CACHE_SIZE - Static variable in class org.apache.lucene.facet.search.TotalFacetCountsCache
  Default size of in memory cache for computed total facet counts.
DEFAULT_COMPLEMENT_THRESHOLD - Static variable in class org.apache.lucene.facet.search.FacetsAccumulator
  Default threshold for using the complements optimization.
DEFAULT_DEPTH - Static variable in class org.apache.lucene.facet.search.params.FacetRequest
  Default depth for facets accumulation.
DEFAULT_FACET_DELIM_CHAR - Static variable in class org.apache.lucene.facet.index.params.DefaultFacetIndexingParams
  delimiter between a categories in a path, e.g.
DEFAULT_MAX_SAMPLE_SIZE - Static variable in class org.apache.lucene.facet.search.sampling.SamplingParams
  Default maximum size of sample.
DEFAULT_MIN_SAMPLE_SIZE - Static variable in class org.apache.lucene.facet.search.sampling.SamplingParams
  Default minimum size of sample.
DEFAULT_MINIMAL_SUBPATH_LENGTH - Variable in class org.apache.lucene.facet.index.categorypolicy.NonTopLevelPathPolicy
  The shortest path length delivered is two components (root + one child).
DEFAULT_OVERSAMPLE_FACTOR - Static variable in class org.apache.lucene.facet.search.sampling.SamplingParams
  Default factor by which more results are requested over the sample set.
DEFAULT_RESULT_MODE - Static variable in class org.apache.lucene.facet.search.params.FacetRequest
  Default result mode
DEFAULT_SAMPLE_RATIO - Static variable in class org.apache.lucene.facet.search.sampling.SamplingParams
  Default ratio between size of sample to original size of document set.
DEFAULT_SAMPLING_THRESHOLD - Static variable in class org.apache.lucene.facet.search.sampling.SamplingParams
  Default sampling threshold, if number of results is less than this number - no sampling will take place
DEFAULT_SCORE - Static variable in interface org.apache.lucene.facet.search.ScoredDocIDsIterator
  Default score used in case scoring is disabled.
DEFAULT_SORT_BY - Static variable in class org.apache.lucene.facet.search.params.FacetRequest
  Default sort mode.
DEFAULT_TERM - Static variable in class org.apache.lucene.facet.index.params.CategoryListParams
  The default term used to store the facets information.
DefaultEnhancementsIndexingParams - Class in org.apache.lucene.facet.enhancements.params
  Default implementation of `EnhancementsIndexingParams`
DefaultEnhancementsIndexingParams(CategoryEnhancement...) - Constructor for class org.apache.lucene.facet.enhancements.params.DefaultEnhancementsIndexingParams
  Construct with a certain `enhancement`
DefaultEnhancementsIndexingParams(CategoryListParams, CategoryEnhancement...) - Constructor for class org.apache.lucene.facet.enhancements.params.DefaultEnhancementsIndexingParams
  Construct with certain `enhancements` and `CategoryListParams`
DefaultFacetIndexingParams - Class in org.apache.lucene.facet.index.params
  Default implementation for `FacetIndexingParams`.
DefaultFacetIndexingParams() - Constructor for class org.apache.lucene.facet.index.params.DefaultFacetIndexingParams
DefaultFacetIndexingParams(CategoryListParams) - Constructor for class org.apache.lucene.facet.index.params.DefaultFacetIndexingParams
DefaultLoadFactor - Static variable in class org.apache.lucene.facet.taxonomy.writercache.cl2o.CompactLabelToOrdinal
DefaultOrdinalPolicy - Class in org.apache.lucene.facet.index.categorypolicy
  This class filters our the ROOT category ID.
DefaultOrdinalPolicy() - Constructor for class org.apache.lucene.facet.index.categorypolicy.DefaultOrdinalPolicy
DefaultPathPolicy - Class in org.apache.lucene.facet.index.categorypolicy
  This class filters our the ROOT category path.
DefaultPathPolicy() - Constructor for class org.apache.lucene.facet.index.categorypolicy.DefaultPathPolicy
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.
deserializeCategoryAttribute(ObjectInputStream) - Method in class org.apache.lucene.facet.index.CategoryContainer
  De-Serialize each of the `CategoryAttribute`s from the given `ObjectInputStream`.
deserializeFromStreamReader(InputStreamReader) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Serializes the content of this CategoryPath to a byte stream, using UTF-8 encoding to convert characters to bytes, and treating the ends as 16-bit characters.
DGapIntDecoder - Class in org.apache.lucene.util.encoding
  An `IntDecoder` which wraps another `IntDecoder` and reverts the d-gap that was encoded by `DGapIntEncoder`.
DGapIntDecoder(IntDecoder) - Constructor for class org.apache.lucene.util.encoding.DGapIntDecoder
DGapIntEncoder - Class in org.apache.lucene.util.encoding
  An `IntEncoderFilter` which encodes the gap between the given values, rather than the values themselves.
DGapIntEncoder(IntEncoder) - Constructor for class org.apache.lucene.util.encoding.DGapIntEncoder
  Initializes with the given encoder.
DirectoryTaxonomyReader - Class in org.apache.lucene.facet.taxonomy.directory
  A `TaxonomyReader` which retrieves stored taxonomy information from a `Directory`.
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, IndexWriterConfig.OpenMode, TaxonomyWriterCache) - Constructor for class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
  Construct a Taxonomy writer.
DirectoryTaxonomyWriter(Directory, IndexWriterConfig.OpenMode) - Constructor for class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
  Creates a new instance with a default cached as defined by `DirectoryTaxonomyWriter.defaultTaxonomyWriterCache()`.
DirectoryTaxonomyWriter(Directory) - Constructor for class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
DirectoryTaxonomyWriter.DiskOrdinalMap - Class in org.apache.lucene.facet.taxonomy.directory
  `DirectoryTaxonomyWriter.OrdinalMap` maintained on file system
DirectoryTaxonomyWriter.DiskOrdinalMap(File) - Constructor for class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.DiskOrdinalMap
DirectoryTaxonomyWriter.MemoryOrdinalMap - Class in org.apache.lucene.facet.taxonomy.directory
  `DirectoryTaxonomyWriter.OrdinalMap` maintained in memory
DirectoryTaxonomyWriter.MemoryOrdinalMap() - Constructor for class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.MemoryOrdinalMap
DirectoryTaxonomyWriter.OrdinalMap - Interface in org.apache.lucene.facet.taxonomy.directory
  Mapping from old ordinal to new ordinals, used when merging indexes wit separate taxonomies.
DISABLE_COMPLEMENT - Static variable in class org.apache.lucene.facet.search.FacetsAccumulator
  Passing this to `FacetsAccumulator.setComplementThreshold(double)` will disable using complement optimization.
docBase - Variable in class org.apache.lucene.facet.search.ScoredDocIdCollector
docids - Variable in class org.apache.lucene.facet.search.sampling.Sampler.SampleResult
docIds - Variable in class org.apache.lucene.facet.search.ScoredDocIdCollector
DoubleIterator - Interface in org.apache.lucene.util.collections
  Iterator interface for primitive double iteration.
DrillDown - Class in org.apache.lucene.facet.search
  Creation of drill down term or query.
DrillDown() - Constructor for class org.apache.lucene.facet.search.DrillDown
drillDownTermText(CategoryPath, char[]) - Method in class org.apache.lucene.facet.index.params.DefaultFacetIndexingParams
drillDownTermText(CategoryPath, char[]) - Method in interface org.apache.lucene.facet.index.params.FacetIndexingParams
  Return the drilldown Term-Text which does not need to do any allocations.

## E

EightFlagsIntDecoder - Class in org.apache.lucene.util.encoding
  Decodes data which was encoded by `EightFlagsIntEncoder`.
EightFlagsIntDecoder() - Constructor for class org.apache.lucene.util.encoding.EightFlagsIntDecoder
EightFlagsIntEncoder - Class in org.apache.lucene.util.encoding
  A `ChunksIntEncoder` which encodes data in chunks of 8.
EightFlagsIntEncoder() - Constructor for class org.apache.lucene.util.encoding.EightFlagsIntEncoder
encode(int) - Method in class org.apache.lucene.util.encoding.DGapIntEncoder
encode(int) - Method in class org.apache.lucene.util.encoding.EightFlagsIntEncoder
encode(int) - Method in class org.apache.lucene.util.encoding.FourFlagsIntEncoder
  Small values (<=3) are stored in the `indicator` while larger values are saved for later encoding in the `ChunksIntEncoder.encodeQueue`.
encode(int) - Method in class org.apache.lucene.util.encoding.IntEncoder
  Encodes an integer to the output stream given in `reInit`
encode(int) - Method in class org.apache.lucene.util.encoding.NOnesIntEncoder
encode(int) - Method in class org.apache.lucene.util.encoding.SimpleIntEncoder
  This method makes sure the value wasn't previously encoded by checking against the Set.
encode(int) - Method in class org.apache.lucene.util.encoding.SortingIntEncoder
encode(int) - Method in class org.apache.lucene.util.encoding.UniqueValuesIntEncoder
encode(int) - Method in class org.apache.lucene.util.encoding.VInt8IntEncoder
encode(int, OutputStream) - Static method in class org.apache.lucene.util.Vint8
  Encodes `number` to `out`.
encode(int, byte[], int) - Static method in class org.apache.lucene.util.Vint8
  Encodes `number` into `dest`, starting at offset `start` from the beginning of the array.
encodeChunk() - Method in class org.apache.lucene.util.encoding.ChunksIntEncoder
  Encodes the values of the current chunk.
encodeQueue - Variable in class org.apache.lucene.util.encoding.ChunksIntEncoder
  Holds the values which must be encoded, outside the indicator.
encodeQueueSize - Variable in class org.apache.lucene.util.encoding.ChunksIntEncoder
encoder - Variable in class org.apache.lucene.util.encoding.ChunksIntEncoder
  Encoder used to encode values outside the indicator.
encoder - Variable in class org.apache.lucene.util.encoding.IntEncoderFilter
ends - Variable in class org.apache.lucene.facet.taxonomy.CategoryPath
enhancementBytes - Variable in class org.apache.lucene.facet.enhancements.EnhancementsCategoryTokenizer
  Buffers for enhancement payload bytes
enhancements - Variable in class org.apache.lucene.facet.enhancements.EnhancementsCategoryTokenizer
  The category enhancements to handle
EnhancementsCategoryTokenizer - Class in org.apache.lucene.facet.enhancements
  A tokenizer which adds to each category token payload according to the `CategoryEnhancement`s defined in the given `EnhancementsIndexingParams`.
EnhancementsCategoryTokenizer(TokenStream, EnhancementsIndexingParams) - Constructor for class org.apache.lucene.facet.enhancements.EnhancementsCategoryTokenizer
  Constructor.
EnhancementsDocumentBuilder - Class in org.apache.lucene.facet.enhancements
  An `EnhancementsDocumentBuilder` is a `CategoryDocumentBuilder` which adds categories to documents according to the list of `CategoryEnhancement`s from `EnhancementsIndexingParams`.
EnhancementsDocumentBuilder(TaxonomyWriter, EnhancementsIndexingParams) - Constructor for class org.apache.lucene.facet.enhancements.EnhancementsDocumentBuilder
EnhancementsIndexingParams - Interface in org.apache.lucene.facet.enhancements.params
  `Facet indexing parameters` for defining `category enhancements`.
EnhancementsPayloadIterator - Class in org.apache.lucene.facet.enhancements
  A `PayloadIterator` for iterating over category posting lists generated using `EnhancementsCategoryTokenizer`.
EnhancementsPayloadIterator(List<CategoryEnhancement>, IndexReader, Term) - Constructor for class org.apache.lucene.facet.enhancements.EnhancementsPayloadIterator
  Constructor.
ensureOpen() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
ensureOpen() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
  Verifies that this instance wasn't closed, or throws `AlreadyClosedException` if it is.
EOS - Static variable in class org.apache.lucene.util.encoding.IntDecoder
  A special long value which is used to indicate end-of-stream has reached.
equals(Object) - Method in class org.apache.lucene.facet.enhancements.association.AssociationEnhancement
equals(Object) - Method in class org.apache.lucene.facet.enhancements.association.AssociationFloatProperty
equals(Object) - Method in class org.apache.lucene.facet.enhancements.association.AssociationIntProperty
equals(Object) - Method in class org.apache.lucene.facet.enhancements.association.AssociationsPayloadIterator
equals(Object) - Method in interface org.apache.lucene.facet.enhancements.CategoryEnhancement
  Category enhancements must override `Object.equals(Object)`, as it is used in `EnhancementsPayloadIterator.getCategoryData(CategoryEnhancement)`.
equals(Object) - Method in class org.apache.lucene.facet.index.attributes.CategoryAttributeImpl
equals(Object) - Method in class org.apache.lucene.facet.index.attributes.OrdinalProperty
equals(Object) - Method in class org.apache.lucene.facet.index.CategoryContainer
equals(Object) - Method in class org.apache.lucene.facet.index.params.CategoryListParams
  Equality is defined by the 'term' that defines this category list.
equals(Object) - Method in class org.apache.lucene.facet.index.params.DefaultFacetIndexingParams
equals(Object) - Method in class org.apache.lucene.facet.search.aggregator.association.AssociationFloatSumAggregator
equals(Object) - Method in class org.apache.lucene.facet.search.aggregator.association.AssociationIntSumAggregator
equals(Object) - Method in class org.apache.lucene.facet.search.aggregator.CountingAggregator
equals(Object) - Method in class org.apache.lucene.facet.search.aggregator.ScoringAggregator
equals(Object) - Method in class org.apache.lucene.facet.search.params.FacetRequest
equals(Object) - Method in class org.apache.lucene.facet.search.PayloadIntDecodingIterator
equals(Object) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Compare the given CategoryPath to another one.
equals(Object) - Method in class org.apache.lucene.util.collections.ArrayHashMap
equals(Object) - Method in class org.apache.lucene.util.collections.FloatToObjectMap
equals(Object) - Method in class org.apache.lucene.util.collections.IntArray
  Equals method.
equals(Object) - Method in class org.apache.lucene.util.collections.IntToDoubleMap
equals(Object) - Method in class org.apache.lucene.util.collections.IntToIntMap
equals(Object) - Method in class org.apache.lucene.util.collections.IntToObjectMap
equals(Object) - Method in class org.apache.lucene.util.collections.ObjectToFloatMap
equals(Object) - Method in class org.apache.lucene.util.collections.ObjectToIntMap
equalsToSerialized(CharSequence, int) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Check whether the current path is identical to the one serialized (with `CategoryPath.serializeAppendTo(Appendable)`) in the given buffer, at the given offset.
equalsToSerialized(int, CharSequence, int) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Just like `CategoryPath.equalsToSerialized(CharSequence, int)`, but compare to a prefix of the CategoryPath, instead of the whole CategoryPath.
extractCategoryTokenData(byte[], int, int) - Method in class org.apache.lucene.facet.enhancements.association.AssociationEnhancement
extractCategoryTokenData(byte[], int, int) - Method in interface org.apache.lucene.facet.enhancements.CategoryEnhancement
  Get the data of this enhancement from a category token payload.

## F

FacetArrays - Class in org.apache.lucene.facet.search
  Provider of arrays used for facet operations such as counting.
FacetArrays(IntArrayAllocator, FloatArrayAllocator) - Constructor for class org.apache.lucene.facet.search.FacetArrays
  Create a FacetArrays with certain array allocators.
FacetException - Exception in org.apache.lucene.facet
  A parent class for exceptions thrown by the Facets code.
FacetException() - Constructor for exception org.apache.lucene.facet.FacetException
FacetException(String) - Constructor for exception org.apache.lucene.facet.FacetException
FacetException(String, Throwable) - Constructor for exception org.apache.lucene.facet.FacetException
FacetException(Throwable) - Constructor for exception org.apache.lucene.facet.FacetException
FacetIndexingParams - Interface in org.apache.lucene.facet.index.params
  Parameters on how facets are to be written to the index.
FacetParamsMissingPropertyException - Exception in org.apache.lucene.facet.index.params
  Thrown when the facets params are missing a property.
FacetParamsMissingPropertyException(String) - Constructor for exception org.apache.lucene.facet.index.params.FacetParamsMissingPropertyException
facetRequest - Variable in class org.apache.lucene.facet.search.FacetResultsHandler
  Facet request served by this handler.
FacetRequest - Class in org.apache.lucene.facet.search.params
  Request to accumulate facet information for a specified facet and possibly also some of its descendants, upto a specified depth.
FacetRequest(CategoryPath, int) - Constructor for class org.apache.lucene.facet.search.params.FacetRequest
  Initialize the request with a given path, and a requested number of facets results.
FacetRequest.ResultMode - Enum in org.apache.lucene.facet.search.params
  Result structure manner of applying request's limits such as `FacetRequest.getNumLabel()` and `FacetRequest.getNumResults()`.
FacetRequest.SortBy - Enum in org.apache.lucene.facet.search.params
  Sort options for facet results.
FacetRequest.SortOrder - Enum in org.apache.lucene.facet.search.params
  Requested sort order for the results.
facetRequests - Variable in class org.apache.lucene.facet.search.params.FacetSearchParams
FacetResult - Class in org.apache.lucene.facet.search.results
  Result of faceted search.
FacetResult(FacetRequest, FacetResultNode, int) - Constructor for class org.apache.lucene.facet.search.results.FacetResult
FacetResultNode - Interface in org.apache.lucene.facet.search.results
  Result of faceted search for a certain taxonomy node.
FacetResultsHandler - Class in org.apache.lucene.facet.search
  Handler for facet results.
FacetResultsHandler(TaxonomyReader, FacetRequest) - Constructor for class org.apache.lucene.facet.search.FacetResultsHandler
  Create a faceted search handler.
FacetsAccumulator - Class in org.apache.lucene.facet.search
  Driver for Accumulating facets of faceted search requests over given documents.
FacetsAccumulator(FacetSearchParams, IndexReader, TaxonomyReader) - Constructor for class org.apache.lucene.facet.search.FacetsAccumulator
facetsAccumulator - Variable in class org.apache.lucene.facet.search.FacetsCollector
FacetsCollector - Class in org.apache.lucene.facet.search
  Collector for facet accumulation.
FacetsCollector(FacetSearchParams, IndexReader, TaxonomyReader) - Constructor for class org.apache.lucene.facet.search.FacetsCollector
  Create a collector for accumulating facets while collecting documents during search.
FacetSearchParams - Class in org.apache.lucene.facet.search.params
  Faceted search parameters indicate for which facets should info be gathered.
FacetSearchParams(FacetIndexingParams) - Constructor for class org.apache.lucene.facet.search.params.FacetSearchParams
  Construct with specific faceted indexing parameters.
FacetSearchParams() - Constructor for class org.apache.lucene.facet.search.params.FacetSearchParams
  Construct with default faceted indexing parameters.
FacetsPayloadProcessorProvider - Class in org.apache.lucene.facet.index
  A `PayloadProcessorProvider` for updating facets ordinal references, based on an ordinal map.
FacetsPayloadProcessorProvider(Directory, int[], FacetIndexingParams) - Constructor for class org.apache.lucene.facet.index.FacetsPayloadProcessorProvider
  Construct FacetsPayloadProcessorProvider with FacetIndexingParams
FacetsPayloadProcessorProvider.FacetsDirPayloadProcessor - Class in org.apache.lucene.facet.index
FacetsPayloadProcessorProvider.FacetsDirPayloadProcessor(FacetIndexingParams, int[]) - Constructor for class org.apache.lucene.facet.index.FacetsPayloadProcessorProvider.FacetsDirPayloadProcessor
  Construct FacetsDirPayloadProcessor with custom FacetIndexingParams
FacetsPayloadProcessorProvider.FacetsPayloadProcessor - Class in org.apache.lucene.facet.index
  A PayloadProcessor for updating facets ordinal references, based on an ordinal map
FacetsPayloadProcessorProvider.FacetsPayloadProcessor(CategoryListParams, int[]) - Constructor for class org.apache.lucene.facet.index.FacetsPayloadProcessorProvider.FacetsPayloadProcessor
fetchPartitionResult(FacetArrays, int) - Method in class org.apache.lucene.facet.search.FacetResultsHandler
  Fetch results of a single partition, given facet arrays for that partition, and based on the matching documents and faceted search parameters.
fetchPartitionResult(FacetArrays, int) - Method in class org.apache.lucene.facet.search.TopKFacetResultsHandler
fetchPartitionResult(FacetArrays, int) - Method in class org.apache.lucene.facet.search.TopKInEachNodeHandler
  Recursively explore all facets that can be potentially included in the `FacetResult` to be generated, and that belong to the given partition, so that values can be examined and collected.
field - Variable in class org.apache.lucene.facet.search.aggregator.association.AssociationFloatSumAggregator
field - Variable in class org.apache.lucene.facet.search.aggregator.association.AssociationIntSumAggregator
fieldList - Variable in class org.apache.lucene.facet.index.CategoryDocumentBuilder
  A list of fields which is filled at ancestors' construction and used during `CategoryDocumentBuilder.build(Document)`.
fillCategoriesMap(Iterable<CategoryAttribute>) - Method in class org.apache.lucene.facet.index.CategoryDocumentBuilder
  Fills the categories mapping between a field name and a list of categories that belongs to it according to this builder's `FacetIndexingParams` object
fillTotalCountsForPartition(int[], int) - Method in class org.apache.lucene.facet.search.TotalFacetCounts
  Fill a partition's array with the TotalCountsArray values.
find(K) - Method in class org.apache.lucene.util.collections.ArrayHashMap
  Returns the index of the given key, or zero if the key wasn't found.
find(float) - Method in class org.apache.lucene.util.collections.FloatToObjectMap
  Find the actual index of a given key.
find(int) - Method in class org.apache.lucene.util.collections.IntHashSet
  Find the actual index of a given key.
find(int) - Method in class org.apache.lucene.util.collections.IntToDoubleMap
  Find the actual index of a given key.
find(int) - Method in class org.apache.lucene.util.collections.IntToIntMap
  Find the actual index of a given key.
find(int) - Method in class org.apache.lucene.util.collections.IntToObjectMap
  Find the actual index of a given key.
find(K) - Method in class org.apache.lucene.util.collections.ObjectToFloatMap
  Find the actual index of a given key.
find(K) - Method in class org.apache.lucene.util.collections.ObjectToIntMap
  Find the actual index of a given key.
findCategory(CategoryPath) - 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.
fixedOrdinalPolicy() - Method in class org.apache.lucene.facet.index.params.DefaultFacetIndexingParams
  "fixed" ordinal policy.
fixedPartitionSize() - Method in class org.apache.lucene.facet.index.params.DefaultFacetIndexingParams
  "fixed" partition size.
fixedPathPolicy() - Method in class org.apache.lucene.facet.index.params.DefaultFacetIndexingParams
  "fixed" path policy.
fixResult(ScoredDocIDs, FacetResult) - Method in interface org.apache.lucene.facet.search.sampling.SampleFixer
  Alter the input result, fixing it to account for the sampling.
FloatArrayAllocator - Class in org.apache.lucene.facet.search
  An FloatArrayAllocator is an object which manages float array objects of a certain size.
FloatArrayAllocator(int, int) - Constructor for class org.apache.lucene.facet.search.FloatArrayAllocator
  Construct an allocator for float arrays of size `size`, keeping around a pool of up to `maxArrays` old arrays.
floatArrayAllocator - Variable in class org.apache.lucene.facet.search.StandardFacetsAccumulator
FloatIterator - Interface in org.apache.lucene.util.collections
  Iterator interface for primitive int iteration.
FloatToObjectMap<T> - Class in org.apache.lucene.util.collections
  An Array-based hashtable which maps primitive float to Objects of generic type T.
  The hashtable is constracted with a given capacity, or 16 as a default.
FloatToObjectMap() - Constructor for class org.apache.lucene.util.collections.FloatToObjectMap
  Constructs a map with default capacity.
FloatToObjectMap(int) - Constructor for class org.apache.lucene.util.collections.FloatToObjectMap
  Constructs a map with given capacity.
FORCE_COMPLEMENT - Static variable in class org.apache.lucene.facet.search.FacetsAccumulator
  Passing this to `FacetsAccumulator.setComplementThreshold(double)` will force using complement optimization.
FourFlagsIntDecoder - Class in org.apache.lucene.util.encoding
  Decodes data which was encoded by `FourFlagsIntEncoder`.
FourFlagsIntDecoder() - Constructor for class org.apache.lucene.util.encoding.FourFlagsIntDecoder
FourFlagsIntEncoder - Class in org.apache.lucene.util.encoding
  A `ChunksIntEncoder` which encodes values in chunks of 4.
FourFlagsIntEncoder() - Constructor for class org.apache.lucene.util.encoding.FourFlagsIntEncoder
free() - Method in class org.apache.lucene.facet.search.FacetArrays
  Notify allocators that they can free arrays allocated on behalf of this FacetArrays object.
free(T) - Method in class org.apache.lucene.facet.search.TemporaryObjectAllocator
  Return a no-longer-needed object back to the pool.

## G

generatesCategoryList() - Method in class org.apache.lucene.facet.enhancements.association.AssociationEnhancement
generatesCategoryList() - Method in interface org.apache.lucene.facet.enhancements.CategoryEnhancement
  Declarative method to indicate whether this enhancement generates separate category list.
get(CategoryListParams) - Method in class org.apache.lucene.facet.search.cache.CategoryListCache
  Fetch the cached `CategoryListData` for a given `CategoryListParams`.
get(CategoryPath) - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.Cl2oTaxonomyWriterCache
get(CategoryPath, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.Cl2oTaxonomyWriterCache
get(CategoryPath, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.CollisionMap
get(CategoryPath, int, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.CollisionMap
get(CategoryPath) - Method in class org.apache.lucene.facet.taxonomy.writercache.lru.LruTaxonomyWriterCache
get(CategoryPath, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.lru.LruTaxonomyWriterCache
get(CategoryPath) - 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(CategoryPath, int) - Method in interface org.apache.lucene.facet.taxonomy.writercache.TaxonomyWriterCache
  Like `TaxonomyWriterCache.get(CategoryPath)`, but for a given prefix of the category path.
get(K) - Method in class org.apache.lucene.util.collections.ArrayHashMap
  Returns the object mapped with the given key, or null if the key wasn't found.
get(float) - Method in class org.apache.lucene.util.collections.FloatToObjectMap
  Returns the object mapped with the given key.
get(int) - Method in class org.apache.lucene.util.collections.IntArray
  Get an element from a specific index.
get(int) - Method in class org.apache.lucene.util.collections.IntToDoubleMap
  Returns the value mapped with the given key.
get(int) - Method in class org.apache.lucene.util.collections.IntToIntMap
  Returns the object mapped with the given key.
get(int) - Method in class org.apache.lucene.util.collections.IntToObjectMap
  Returns the object mapped with the given key.
get(K) - Method in class org.apache.lucene.util.collections.ObjectToFloatMap
  Returns the float mapped with the given key.
get(K) - Method in class org.apache.lucene.util.collections.ObjectToIntMap
  Returns the int mapped with the given key.
getAllCategoryListParams() - Method in class org.apache.lucene.facet.index.params.DefaultFacetIndexingParams
getAllCategoryListParams() - Method in interface org.apache.lucene.facet.index.params.FacetIndexingParams
  Return info about all category lists in the index.
getAllCategoryListParams() - Method in class org.apache.lucene.facet.index.params.PerDimensionIndexingParams
  Get all the categoryListParams, including the default.
getArraysLength() - Method in class org.apache.lucene.facet.search.FacetArrays
  Return the arrays length
getAssociatedOrdinals() - Method in class org.apache.lucene.facet.enhancements.association.AssociationsPayloadIterator
  Get an iterator over the ordinals which has an association for the document set by `AssociationsPayloadIterator.setNextDoc(int)`.
getAssociation() - Method in class org.apache.lucene.facet.enhancements.association.AssociationProperty
  Returns the association value.
getAssociation(int) - Method in class org.apache.lucene.facet.enhancements.association.AssociationsPayloadIterator
  Get int association value for the given ordinal.
getAssociationProperty(CategoryAttribute) - Static method in class org.apache.lucene.facet.enhancements.association.AssociationEnhancement
getBuffer() - Method in class org.apache.lucene.facet.search.PayloadIterator
  Get the buffer with the content of the last read payload.
getCacheMemoryUsage() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
  Returns the number of memory bytes used by the cache.
getCacheSize() - Method in class org.apache.lucene.facet.search.TotalFacetCountsCache
getCategoryAttribute(CategoryPath) - Method in class org.apache.lucene.facet.index.CategoryContainer
  Get the `CategoryAttribute` this container has for a certain category, or `null` if the category is not in the container.
getCategoryData(CategoryEnhancement) - Method in class org.apache.lucene.facet.enhancements.EnhancementsPayloadIterator
  Get the data of the current category and document for a certain enhancement, or `null` if no such enhancement exists.
getCategoryEnhancements() - Method in class org.apache.lucene.facet.enhancements.params.DefaultEnhancementsIndexingParams
getCategoryEnhancements() - Method in interface org.apache.lucene.facet.enhancements.params.EnhancementsIndexingParams
  Get a list of the active category enhancements.
getCategoryListMap(FacetArrays, int) - Method in class org.apache.lucene.facet.search.StandardFacetsAccumulator
  Create an `Aggregator` and a `CategoryListIterator` for each and every `FacetRequest`.
getCategoryListParams(CategoryPath) - Method in class org.apache.lucene.facet.index.params.DefaultFacetIndexingParams
getCategoryListParams(CategoryPath) - Method in interface org.apache.lucene.facet.index.params.FacetIndexingParams
  The name of the category-list to put this category in, or null if this category should not be aggregatable.
getCategoryListParams(CategoryPath) - Method in class org.apache.lucene.facet.index.params.PerDimensionIndexingParams
  Get the CategoryListParams based on the dimension or "zero-th category" of the specified CategoryPath.
getCategoryListTermText() - Method in class org.apache.lucene.facet.enhancements.association.AssociationEnhancement
getCategoryListTermText() - Method in interface org.apache.lucene.facet.enhancements.CategoryEnhancement
  Returns the text of this enhancement's category list term.
getCategoryListTokenizer(TokenStream, EnhancementsIndexingParams, TaxonomyWriter) - Method in class org.apache.lucene.facet.enhancements.association.AssociationEnhancement
getCategoryListTokenizer(TokenStream, EnhancementsIndexingParams, TaxonomyWriter) - Method in interface org.apache.lucene.facet.enhancements.CategoryEnhancement
  Get the `CategoryListTokenizer` which generates the category list for this enhancement.
getCategoryListTokenizer(TokenStream) - Method in class org.apache.lucene.facet.enhancements.EnhancementsDocumentBuilder
getCategoryListTokenizer(TokenStream) - Method in class org.apache.lucene.facet.index.CategoryDocumentBuilder
  Get a category list tokenizer (or a series of such tokenizers) to create the category list tokens.
getCategoryPath() - Method in interface org.apache.lucene.facet.index.attributes.CategoryAttribute
  Returns the value of this attribute: a category path.
getCategoryPath() - Method in class org.apache.lucene.facet.index.attributes.CategoryAttributeImpl
  Returns the category path value.
getCategoryPath() - Method in class org.apache.lucene.facet.search.params.FacetRequest
  The root category of this facet request.
getCategoryTokenBytes(CategoryAttribute) - Method in class org.apache.lucene.facet.enhancements.association.AssociationEnhancement
getCategoryTokenBytes(CategoryAttribute) - Method in interface org.apache.lucene.facet.enhancements.CategoryEnhancement
  Get the bytes to be added to the category token payload for this enhancement.
getCategoryTokenizer(TokenStream) - Method in class org.apache.lucene.facet.enhancements.EnhancementsDocumentBuilder
getCategoryTokenizer(TokenStream) - Method in class org.apache.lucene.facet.index.CategoryDocumentBuilder
  Get a `CategoryTokenizer` to create the category tokens.
getChildrenArrays() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getChildrenArrays() - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyReader
  getChildrenArrays() returns a `TaxonomyReader.ChildrenArrays` object which can be used together to efficiently enumerate the children of any category.
getClCache() - Method in class org.apache.lucene.facet.search.params.FacetSearchParams
getCommitUserData() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getCommitUserData() - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyReader
  Retrieve user committed data.
getComplementSet(ScoredDocIDs, IndexReader) - Static method in class org.apache.lucene.facet.util.ScoredDocIdsUtils
  Create a complement of the input set.
getComplementThreshold() - Method in class org.apache.lucene.facet.search.FacetsAccumulator
getComplementThreshold() - Method in class org.apache.lucene.facet.search.SamplingWrapper
getComponent(int) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Return the i'th component of the path, in a new String object.
getCountingListTokenizer(TokenStream) - Method in class org.apache.lucene.facet.index.CategoryDocumentBuilder
  Get a `CountingListTokenizer` for creating counting list token.
getDefaultScore() - Method in class org.apache.lucene.facet.search.ScoredDocIdCollector
  Returns the default score used when scoring is disabled.
getDepth() - Method in class org.apache.lucene.facet.search.params.FacetRequest
  How deeply to look under the given category.
getDocID() - Method in interface org.apache.lucene.facet.search.ScoredDocIDsIterator
  Returns the ID of the current document.
getDocIDs() - Method in interface org.apache.lucene.facet.search.ScoredDocIDs
  Returns the set of doc IDs.
getFacetDelimChar() - Method in class org.apache.lucene.facet.index.params.DefaultFacetIndexingParams
  Use `DefaultFacetIndexingParams.DEFAULT_FACET_DELIM_CHAR` as the delimiter.
getFacetDelimChar() - Method in interface org.apache.lucene.facet.index.params.FacetIndexingParams
  Get the delimiter character used internally for drill-down terms
getFacetIndexingParams() - Method in class org.apache.lucene.facet.search.params.FacetSearchParams
  A list of `FacetRequest` objects, determining what to count.
getFacetRequest() - Method in class org.apache.lucene.facet.search.FacetResultsHandler
  Return the facet request served by this handler.
getFacetRequest() - Method in class org.apache.lucene.facet.search.results.FacetResult
  Request for which this result was obtained.
getFacetRequest() - Method in interface org.apache.lucene.facet.search.results.IntermediateFacetResult
  Facet request for which this temporary result was created.
getFacetRequest() - Method in class org.apache.lucene.facet.search.TopKInEachNodeHandler.IntermediateFacetResultWithHash
getFacetRequests() - Method in class org.apache.lucene.facet.search.params.FacetSearchParams
  Parameters which controlled the indexing of facets, and which are also needed during search.
getFacetResultNode() - Method in class org.apache.lucene.facet.search.results.FacetResult
  Facet result node matching the root of the `facet request`.
getFacetResults() - Method in class org.apache.lucene.facet.search.FacetsCollector
  Return accumulated facets results (according to faceted search parameters) for collected documents.
getFloatArray() - Method in class org.apache.lucene.facet.search.FacetArrays
  Obtain a float array, e.g.
getFloatAssociation() - Method in class org.apache.lucene.facet.enhancements.association.AssociationFloatProperty
getIntArray() - Method in class org.apache.lucene.facet.search.FacetArrays
  Obtain an int array, e.g.
getLabel() - Method in interface org.apache.lucene.facet.search.results.FacetResultNode
  Category path of the category of this result, or null if not computed, because the application did not request to compute it.
getLabel(TaxonomyReader) - Method in interface org.apache.lucene.facet.search.results.FacetResultNode
  Category path of the category of this result.
getLabel() - Method in class org.apache.lucene.facet.search.results.MutableFacetResultNode
getLabel(TaxonomyReader) - Method in class org.apache.lucene.facet.search.results.MutableFacetResultNode
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.
getMaxOrdinal() - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.LabelToOrdinal
  return the maximal Ordinal assigned so far
getMaxSampleSize() - Method in class org.apache.lucene.facet.search.sampling.SamplingParams
  Return the maxSampleSize.
getMaxSize() - Method in class org.apache.lucene.util.collections.LRUHashMap
  Return the max size
getMemoryUsage() - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.Cl2oTaxonomyWriterCache
  Returns the number of bytes in memory used by this object.
getMinSampleSize() - Method in class org.apache.lucene.facet.search.sampling.SamplingParams
  Return the minSampleSize.
getNextOrdinal() - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.LabelToOrdinal
  Returns the next unassigned ordinal.
getNumLabel() - Method in class org.apache.lucene.facet.search.params.FacetRequest
  If getNumLabel()<getNumResults(), only the first getNumLabel() results will have their category paths calculated, and the rest will only be available as ordinals (category numbers) and will have null paths.
getNumResults() - Method in class org.apache.lucene.facet.search.params.FacetRequest
  The number of sub-categories to return (at most).
getNumSubResults() - Method in interface org.apache.lucene.facet.search.results.FacetResultNode
  Number of sub results
getNumSubResults() - Method in class org.apache.lucene.facet.search.results.MutableFacetResultNode
getNumValidDescendants() - Method in class org.apache.lucene.facet.search.results.FacetResult
  Number of descendants of `root facet result node`, up till the requested depth, which are valid by the `results handler in effect`.
getOlderSiblingArray() - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyReader.ChildrenArrays
  getOlderSiblingArray() returns an int array of size getSize() listing for each category the ordinal of its immediate older sibling (the sibling in the taxonomy tree with the highest ordinal below that of the given ordinal).
getOrdinal() - Method in class org.apache.lucene.facet.index.attributes.OrdinalProperty
getOrdinal() - Method in interface org.apache.lucene.facet.search.results.FacetResultNode
  Ordinal of the category of this result.
getOrdinal() - Method in class org.apache.lucene.facet.search.results.MutableFacetResultNode
getOrdinal(CategoryPath) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getOrdinal(CategoryPath) - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyReader
  getOrdinal() returns the ordinal of the category given as a path.
getOrdinal(CategoryPath) - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.CompactLabelToOrdinal
getOrdinal(CategoryPath, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.CompactLabelToOrdinal
getOrdinal(CategoryPath) - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.LabelToOrdinal
getOrdinal(CategoryPath, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.LabelToOrdinal
getOrdinalPolicy() - Method in class org.apache.lucene.facet.index.params.DefaultFacetIndexingParams
getOrdinalPolicy() - Method in interface org.apache.lucene.facet.index.params.FacetIndexingParams
  Get the policy for indexing category ordinals, used for deciding how "high" to climb in taxonomy from a category when ingesting its ordinals
getOversampleFactor() - Method in class org.apache.lucene.facet.search.sampling.SamplingParams
  Return the oversampleFactor.
getParent(int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getParent(int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
getParent(int) - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyReader
  getParent() returns the ordinal of the parent category of the category with the given ordinal.
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.
getParentArray() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
  getParentArray() returns an int array of size getSize() listing the ordinal of the parent category of each category in the taxonomy.
getParentArray() - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyReader
  getParentArray() returns an int array of size getSize() listing the ordinal of the parent category of each category in the taxonomy.
getParentsStream(CategoryAttributesStream) - Method in class org.apache.lucene.facet.enhancements.EnhancementsDocumentBuilder
getParentsStream(CategoryAttributesStream) - Method in class org.apache.lucene.facet.index.CategoryDocumentBuilder
  Get a stream of categories which includes the parents, according to policies defined in indexing parameters.
getPartitionSize() - Method in class org.apache.lucene.facet.index.params.DefaultFacetIndexingParams
getPartitionSize() - Method in interface org.apache.lucene.facet.index.params.FacetIndexingParams
  Get the partition size.
getPath(int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getPath(int, CategoryPath) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getPath(int) - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyReader
  getPath() returns the path name of the category with the given ordinal.
getPath(int, CategoryPath) - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyReader
  getPath() returns the path name of the category with the given ordinal.
getPathPolicy() - Method in class org.apache.lucene.facet.index.params.DefaultFacetIndexingParams
getPathPolicy() - Method in interface org.apache.lucene.facet.index.params.FacetIndexingParams
  Get the policy for indexing category paths, used for deciding how "high" to climb in taxonomy from a category when ingesting its category paths.
getPayloadLength() - Method in class org.apache.lucene.facet.search.PayloadIterator
  Get the length of the last read payload.
getPayloadStream(CategoryPath, int) - Method in class org.apache.lucene.facet.index.streaming.CountingListTokenizer
getProcessor(Term) - Method in class org.apache.lucene.facet.index.FacetsPayloadProcessorProvider.FacetsDirPayloadProcessor
getProperty(Class<? extends CategoryProperty>) - Method in interface org.apache.lucene.facet.index.attributes.CategoryAttribute
  Get a property of a certain property class.
getProperty(Collection<Class<? extends CategoryProperty>>) - Method in interface org.apache.lucene.facet.index.attributes.CategoryAttribute
  Get a property of one of given property classes.
getProperty(Class<? extends CategoryProperty>) - Method in class org.apache.lucene.facet.index.attributes.CategoryAttributeImpl
getProperty(Collection<Class<? extends CategoryProperty>>) - Method in class org.apache.lucene.facet.index.attributes.CategoryAttributeImpl
getPropertyClasses() - Method in interface org.apache.lucene.facet.index.attributes.CategoryAttribute
  Get all the active property classes.
getPropertyClasses() - Method in class org.apache.lucene.facet.index.attributes.CategoryAttributeImpl
getReaderProcessor(IndexReader) - Method in class org.apache.lucene.facet.index.FacetsPayloadProcessorProvider
getRefCount() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
  Expert: returns the current refCount for this taxonomy reader
getRefCount() - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyReader
  Expert: returns the current refCount for this taxonomy reader
getResidue() - Method in interface org.apache.lucene.facet.search.results.FacetResultNode
  Value of screened out sub results.
getResidue() - Method in class org.apache.lucene.facet.search.results.MutableFacetResultNode
getResultMode() - Method in class org.apache.lucene.facet.search.params.FacetRequest
  Return the requested result mode.
getRetainableProperties() - Method in class org.apache.lucene.facet.enhancements.params.DefaultEnhancementsIndexingParams
getRetainableProperties() - Method in interface org.apache.lucene.facet.enhancements.params.EnhancementsIndexingParams
  Get a list of `CategoryProperty` classes to be retained when creating `CategoryParentsStream`.
getRetainableProperty() - Method in class org.apache.lucene.facet.enhancements.association.AssociationEnhancement
getRetainableProperty() - Method in interface org.apache.lucene.facet.enhancements.CategoryEnhancement
  Get a `CategoryProperty` class to be retained when creating `CategoryParentsStream`.
getSampleFixer(IndexReader, TaxonomyReader, FacetSearchParams) - Method in class org.apache.lucene.facet.search.sampling.Sampler
  Get a fixer of sample facet accumulation results.
getSampler() - Method in class org.apache.lucene.facet.search.AdaptiveFacetsAccumulator
getSampleRatio() - Method in class org.apache.lucene.facet.search.sampling.SamplingParams
getSampleSet(ScoredDocIDs) - Method in class org.apache.lucene.facet.search.sampling.Sampler
  Compute a sample set out of the input set, based on the `SamplingParams.getSampleRatio()` in effect.
getSamplingParams() - Method in class org.apache.lucene.facet.search.sampling.Sampler
  Return the sampling params in effect
getSamplingThreshold() - Method in class org.apache.lucene.facet.search.sampling.SamplingParams
  Return the samplingThreshold.
getScore() - Method in interface org.apache.lucene.facet.search.ScoredDocIDsIterator
  Returns the score of the current document.
getScoredDocIDs() - Method in class org.apache.lucene.facet.search.ScoredDocIdCollector
getSingleton() - Static method in class org.apache.lucene.facet.search.TotalFacetCountsCache
  Get the single instance of this cache
getSize() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getSize() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
  getSize() returns the number of categories in the taxonomy.
getSize() - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyReader
  getSize() 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.
getSortBy() - Method in class org.apache.lucene.facet.search.params.FacetRequest
  Specify how should results be sorted.
getSortOrder() - Method in class org.apache.lucene.facet.search.params.FacetRequest
  Return the requested order of results.
getStartPos() - Method in class org.apache.lucene.util.UnsafeByteArrayOutputStream
  Returns the start position data was written to.
getSubResults() - Method in interface org.apache.lucene.facet.search.results.FacetResultNode
  Contained sub results.
getSubResults() - Method in class org.apache.lucene.facet.search.results.MutableFacetResultNode
getTaxonomyReader() - Method in class org.apache.lucene.facet.search.FacetResultsHandler
  Return taxonomy reader used for current facets accumulation operation.
getTerm() - Method in class org.apache.lucene.facet.index.params.CategoryListParams
  A `Term` who's payload holds the category-list.
getTotalCount(int) - Method in class org.apache.lucene.facet.search.TotalFacetCounts
  Return the total count of an input category
getTotalCounts(IndexReader, TaxonomyReader, FacetIndexingParams, CategoryListCache) - Method in class org.apache.lucene.facet.search.TotalFacetCountsCache
  Get the total facet counts for a reader/taxonomy pair and facet indexing parameters.
getTotalCountsFactor() - Method in class org.apache.lucene.facet.search.sampling.SamplingAccumulator
getTotalCountsFactor() - Method in class org.apache.lucene.facet.search.StandardFacetsAccumulator
  Expert: factor by which counts should be multiplied when initializing the count arrays from total counts.
getValue() - Method in interface org.apache.lucene.facet.search.results.FacetResultNode
  Value of this result - usually either count or a value derived from some computing on the association of it.
getValue() - Method in class org.apache.lucene.facet.search.results.MutableFacetResultNode
getValueOf(FacetArrays, int) - Method in class org.apache.lucene.facet.search.params.association.AssociationFloatSumFacetRequest
getValueOf(FacetArrays, int) - Method in class org.apache.lucene.facet.search.params.association.AssociationIntSumFacetRequest
getValueOf(FacetArrays, int) - Method in class org.apache.lucene.facet.search.params.CountFacetRequest
getValueOf(FacetArrays, int) - Method in class org.apache.lucene.facet.search.params.FacetRequest
  Return the value of a category used for facets computations for this request.
getValueOf(FacetArrays, int) - Method in class org.apache.lucene.facet.search.params.ScoreFacetRequest
getYoungestChildArray() - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyReader.ChildrenArrays
  getYoungestChildArray() returns an int array of size getSize() listing the ordinal of the youngest (highest numbered) child category of each category in the taxonomy.
GROUD - Static variable in class org.apache.lucene.util.collections.IntToIntMap
GROUND - Static variable in class org.apache.lucene.util.collections.IntToDoubleMap
grow() - Method in class org.apache.lucene.util.collections.ArrayHashMap
  Allocates a new map of double the capacity, and fast-insert the old key-value pairs.
grow() - Method in class org.apache.lucene.util.collections.FloatToObjectMap
  Grows the map.
grow() - Method in class org.apache.lucene.util.collections.IntHashSet
  Grows the map.
grow() - Method in class org.apache.lucene.util.collections.IntToDoubleMap
  Grows the map.
grow() - Method in class org.apache.lucene.util.collections.IntToIntMap
  Grows the map.
grow() - Method in class org.apache.lucene.util.collections.IntToObjectMap
  Grows the map.
grow() - Method in class org.apache.lucene.util.collections.ObjectToFloatMap
  Grows the map.
grow() - Method in class org.apache.lucene.util.collections.ObjectToIntMap
  Grows the map.

## H

handleEndOfInput() - Method in class org.apache.lucene.facet.index.streaming.CategoryListTokenizer
  A method invoked once when the input stream ends, for subclass-specific processing.
handleStartOfInput() - Method in class org.apache.lucene.facet.enhancements.association.AssociationListTokenizer
handleStartOfInput() - Method in class org.apache.lucene.facet.index.streaming.CategoryListTokenizer
  A method invoked once when the input stream begins, for subclass-specific processing.
handleStartOfInput() - Method in class org.apache.lucene.facet.index.streaming.CountingListTokenizer
hasBeenSet() - Method in class org.apache.lucene.facet.enhancements.association.AssociationProperty
  Returns whether this attribute has been set (not all categories have an association).
hasBeenSet() - Method in class org.apache.lucene.facet.index.attributes.OrdinalProperty
hashCode() - Method in class org.apache.lucene.facet.enhancements.association.AssociationEnhancement
hashCode() - Method in class org.apache.lucene.facet.enhancements.association.AssociationFloatProperty
hashCode() - Method in class org.apache.lucene.facet.enhancements.association.AssociationIntProperty
hashCode() - Method in class org.apache.lucene.facet.enhancements.association.AssociationsPayloadIterator
hashCode() - Method in class org.apache.lucene.facet.index.attributes.CategoryAttributeImpl
hashCode() - Method in class org.apache.lucene.facet.index.attributes.OrdinalProperty
hashCode() - Method in class org.apache.lucene.facet.index.CategoryContainer
hashCode() - Method in class org.apache.lucene.facet.index.params.CategoryListParams
  Hashcode is similar to `CategoryListParams.equals(Object)`, in that it uses the term that defines this category list to derive the hashcode.
hashCode() - Method in class org.apache.lucene.facet.index.params.DefaultFacetIndexingParams
hashCode() - Method in class org.apache.lucene.facet.search.aggregator.association.AssociationFloatSumAggregator
hashCode() - Method in class org.apache.lucene.facet.search.aggregator.association.AssociationIntSumAggregator
hashCode() - Method in class org.apache.lucene.facet.search.aggregator.CountingAggregator
hashCode() - Method in class org.apache.lucene.facet.search.aggregator.ScoringAggregator
hashCode() - Method in class org.apache.lucene.facet.search.params.FacetRequest
hashCode() - Method in class org.apache.lucene.facet.search.PayloadIntDecodingIterator
hashCode() - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Calculate a hashCode for this path, used when a CategoryPath serves as a hash-table key.
hashCode(int) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Like `CategoryPath.hashCode()`, but find the hash function of a prefix with the given number of components, rather than of the entire path.
hashCode() - Method in class org.apache.lucene.util.collections.ArrayHashMap
hashCode() - Method in class org.apache.lucene.util.collections.FloatToObjectMap
hashCode() - Method in class org.apache.lucene.util.collections.IntArray
  Calculates a hash-code for HashTables
hashCode() - Method in class org.apache.lucene.util.collections.IntToDoubleMap
hashCode() - Method in class org.apache.lucene.util.collections.IntToIntMap
hashCode() - Method in class org.apache.lucene.util.collections.IntToObjectMap
hashCode() - Method in class org.apache.lucene.util.collections.ObjectToFloatMap
hashCode() - Method in class org.apache.lucene.util.collections.ObjectToIntMap
hashCodeOfSerialized(CharSequence, int) - Static method in class org.apache.lucene.facet.taxonomy.CategoryPath
  This method calculates a hash function of a path that has been written to (using `CategoryPath.serializeAppendTo(Appendable)`) a character buffer.
hasNext() - Method in interface org.apache.lucene.util.collections.DoubleIterator
hasNext() - Method in interface org.apache.lucene.util.collections.FloatIterator
hasNext() - Method in interface org.apache.lucene.util.collections.IntIterator
hasRoom(int) - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.Cl2oTaxonomyWriterCache
hasRoom(int) - Method in class org.apache.lucene.facet.taxonomy.writercache.lru.LruTaxonomyWriterCache
hasRoom(int) - Method in interface org.apache.lucene.facet.taxonomy.writercache.TaxonomyWriterCache
  Sometimes the cache is either unlimited in size, or limited by a very big size, and in that case when we add a lot of categories it might make sense to pre-load the cache with all the existing categories.
Heap<T> - Interface in org.apache.lucene.facet.search
  Declares an interface for heap (and heap alike) structures, handling a given type T

## I

in - Variable in class org.apache.lucene.util.encoding.IntDecoder
  Input stream from which the encoded bytes are read
InconsistentTaxonomyException - Exception in org.apache.lucene.facet.taxonomy
  Exception indicating that a certain operation could not be performed on a taxonomy related object because of an inconsistency.
InconsistentTaxonomyException(String) - Constructor for exception org.apache.lucene.facet.taxonomy.InconsistentTaxonomyException
InconsistentTaxonomyException() - Constructor for exception org.apache.lucene.facet.taxonomy.InconsistentTaxonomyException
increaseResidue(double) - Method in class org.apache.lucene.facet.search.results.MutableFacetResultNode
  increase the residue for this result.
increaseValue(double) - Method in class org.apache.lucene.facet.search.results.MutableFacetResultNode
  increase the value for this result.
incRef() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
  Expert: increments the refCount of this TaxonomyReader instance.
incRef() - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyReader
  Expert: increments the refCount of this TaxonomyReader instance.
incrementToken() - Method in class org.apache.lucene.facet.enhancements.association.AssociationListTokenizer
incrementToken() - Method in class org.apache.lucene.facet.index.streaming.CategoryAttributesStream
incrementToken() - Method in class org.apache.lucene.facet.index.streaming.CategoryListTokenizer
incrementToken() - Method in class org.apache.lucene.facet.index.streaming.CategoryParentsStream
incrementToken() - Method in class org.apache.lucene.facet.index.streaming.CategoryTokenizer
incrementToken() - Method in class org.apache.lucene.facet.index.streaming.CategoryTokenizerBase
incrementToken() - Method in class org.apache.lucene.facet.index.streaming.CountingListTokenizer
INDEX_CREATE_TIME - Static variable in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
  Property name of user commit data that contains the creation time of a taxonomy index.
indexingParams - Variable in class org.apache.lucene.facet.index.CategoryDocumentBuilder
  Parameters to be used when indexing categories.
indexingParams - Variable in class org.apache.lucene.facet.index.streaming.CategoryTokenizerBase
  Indexing params for creating term text
indexingParams - Variable in class org.apache.lucene.facet.search.params.FacetSearchParams
indexReader - Variable in class org.apache.lucene.facet.search.FacetsAccumulator
indicator - Variable in class org.apache.lucene.util.encoding.ChunksIntEncoder
  Represents bits flag byte.
init(TaxonomyWriter) - Method in class org.apache.lucene.facet.index.categorypolicy.DefaultOrdinalPolicy
  Implemented as NO-OP as the default is not taxonomy dependent
init(TaxonomyWriter) - Method in class org.apache.lucene.facet.index.categorypolicy.NonTopLevelOrdinalPolicy
init(TaxonomyWriter) - Method in interface org.apache.lucene.facet.index.categorypolicy.OrdinalPolicy
  Initialize the policy with a TaxonomyWriter.
init() - Method in interface org.apache.lucene.facet.search.CategoryListIterator
  Initializes the iterator.
init() - Method in class org.apache.lucene.facet.search.PayloadIntDecodingIterator
init() - Method in class org.apache.lucene.facet.search.PayloadIterator
  (re)initialize the iterator.
init() - Method in class org.apache.lucene.facet.util.MultiCategoryListIterator
  Fails if all given iterators fail to init
initFacetsAccumulator(FacetSearchParams, IndexReader, TaxonomyReader) - Method in class org.apache.lucene.facet.search.FacetsCollector
  Create the `FacetsAccumulator` to be used.
initScoredDocCollector(FacetSearchParams, IndexReader, TaxonomyReader) - Method in class org.apache.lucene.facet.search.FacetsCollector
  Create a `ScoredDocIdCollector` to be used as the first phase of the facet collection.
insertSubResult(FacetResultNode) - Method in class org.apache.lucene.facet.search.results.MutableFacetResultNode
  Insert sub result (as first).
insertWithOverflow(T) - Method in interface org.apache.lucene.facet.search.Heap
  Insert a new value, returning the overflowen object
  NOTE: This method should not be called after invoking `Heap.pop()`
IntArray - Class in org.apache.lucene.util.collections
  A Class wrapper for a grow-able int[] which can be sorted and intersect with other IntArrays.
IntArray() - Constructor for class org.apache.lucene.util.collections.IntArray
  Construct a default IntArray, size 0 and surly a sort should not occur.
IntArrayAllocator - Class in org.apache.lucene.facet.search
  An IntArrayAllocator is an object which manages counter array objects of a certain length.
IntArrayAllocator(int, int) - Constructor for class org.apache.lucene.facet.search.IntArrayAllocator
  Construct an allocator for counter arrays of length `length`, keeping around a pool of up to `maxArrays` old arrays.
intArrayAllocator - Variable in class org.apache.lucene.facet.search.StandardFacetsAccumulator
IntDecoder - Class in org.apache.lucene.util.encoding
  Decodes integers from a set `InputStream`.
IntDecoder() - Constructor for class org.apache.lucene.util.encoding.IntDecoder
IntEncoder - Class in org.apache.lucene.util.encoding
  Encodes integers to a set `OutputStream`.
IntEncoder() - Constructor for class org.apache.lucene.util.encoding.IntEncoder
  Default constructor, provided here for robustness: if in the future a constructor with parameters will be added, this might break custom implementations of this class which call this implicit constructor.
IntEncoderFilter - Class in org.apache.lucene.util.encoding
  An abstract implementation of `IntEncoder` which is served as a filter on the values to encode.
IntEncoderFilter(IntEncoder) - Constructor for class org.apache.lucene.util.encoding.IntEncoderFilter
IntermediateFacetResult - Interface in org.apache.lucene.facet.search.results
  Intermediate `FacetResult` of faceted search.
intersect(IntHashSet) - Method in class org.apache.lucene.util.collections.IntArray
  Intersects the data with a given `IntHashSet`.
intersect(IntArray) - Method in class org.apache.lucene.util.collections.IntArray
  Intersects the data with a given IntArray
IntHashSet - Class in org.apache.lucene.util.collections
  A Set or primitive int.
IntHashSet() - Constructor for class org.apache.lucene.util.collections.IntHashSet
  Constructs a map with default capacity.
IntHashSet(int) - Constructor for class org.apache.lucene.util.collections.IntHashSet
  Constructs a map with given capacity.
IntIterator - Interface in org.apache.lucene.util.collections
  Iterator interface for primitive int iteration.
IntToDoubleMap - Class in org.apache.lucene.util.collections
  An Array-based hashtable which maps primitive int to a primitive double.
  The hashtable is constracted with a given capacity, or 16 as a default.
IntToDoubleMap() - Constructor for class org.apache.lucene.util.collections.IntToDoubleMap
  Constructs a map with default capacity.
IntToDoubleMap(int) - Constructor for class org.apache.lucene.util.collections.IntToDoubleMap
  Constructs a map with given capacity.
IntToIntMap - Class in org.apache.lucene.util.collections
  An Array-based hashtable which maps primitive int to primitive int.
  The hashtable is constracted with a given capacity, or 16 as a default.
IntToIntMap() - Constructor for class org.apache.lucene.util.collections.IntToIntMap
  Constructs a map with default capacity.
IntToIntMap(int) - Constructor for class org.apache.lucene.util.collections.IntToIntMap
  Constructs a map with given capacity.
IntToObjectMap<T> - Class in org.apache.lucene.util.collections
  An Array-based hashtable which maps primitive int to Objects of generic type T.
  The hashtable is constracted with a given capacity, or 16 as a default.
IntToObjectMap() - Constructor for class org.apache.lucene.util.collections.IntToObjectMap
  Constructs a map with default capacity.
IntToObjectMap(int) - Constructor for class org.apache.lucene.util.collections.IntToObjectMap
  Constructs a map with given capacity.
INVALID_ORDINAL - Static variable in interface org.apache.lucene.facet.taxonomy.TaxonomyReader
  Ordinals are always non-negative, so a negative ordinal can be used to signify an error.
InvalidOrdinal - Static variable in class org.apache.lucene.facet.taxonomy.writercache.cl2o.LabelToOrdinal
isAllowLabeling() - Method in class org.apache.lucene.facet.search.FacetsAccumulator
  Check if labeling is allowed for this accumulator.
isAllowLabeling() - Method in class org.apache.lucene.facet.search.SamplingWrapper
isAssociationProperty(Class<? extends CategoryProperty>) - Static method in class org.apache.lucene.facet.enhancements.association.AssociationEnhancement
  For a given class which extends a CategoryProperty, answers whether it is an instance of AssociationProperty (AP) or not.
isDescendantOf(CategoryPath) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Test whether this object is a descendant of another CategoryPath.
isEmpty() - Method in class org.apache.lucene.util.collections.ArrayHashMap
  Returns true iff the map is empty.
isEmpty() - Method in class org.apache.lucene.util.collections.FloatToObjectMap
isEmpty() - Method in class org.apache.lucene.util.collections.IntHashSet
isEmpty() - Method in class org.apache.lucene.util.collections.IntToDoubleMap
isEmpty() - Method in class org.apache.lucene.util.collections.IntToIntMap
isEmpty() - Method in class org.apache.lucene.util.collections.IntToObjectMap
isEmpty() - Method in class org.apache.lucene.util.collections.ObjectToFloatMap
isEmpty() - Method in class org.apache.lucene.util.collections.ObjectToIntMap
isSelfPartition(int, FacetArrays, int) - Method in class org.apache.lucene.facet.search.FacetResultsHandler
  Check if an array contains the partition which contains ordinal
isUsingComplements - Variable in class org.apache.lucene.facet.search.StandardFacetsAccumulator
iterator() - Method in class org.apache.lucene.facet.index.attributes.CategoryAttributesIterable
iterator() - Method in class org.apache.lucene.facet.index.CategoryContainer
iterator(int) - Method in class org.apache.lucene.facet.search.cache.CategoryListData
  Iterate on the category list data for the specified partition.
iterator() - Method in interface org.apache.lucene.facet.search.ScoredDocIDs
  Returns an iterator over the document IDs and their scores.
iterator() - Method in class org.apache.lucene.util.collections.ArrayHashMap
  Returns an iterator on the mapped objects.
iterator() - Method in class org.apache.lucene.util.collections.FloatToObjectMap
  Returns a new iterator for the mapped objects.
iterator() - Method in class org.apache.lucene.util.collections.IntHashSet
  Returns a new iterator for the mapped objects.
iterator() - Method in class org.apache.lucene.util.collections.IntToDoubleMap
  Returns a new iterator for the mapped double values.
iterator() - Method in class org.apache.lucene.util.collections.IntToIntMap
  Returns a new iterator for the mapped objects.
iterator() - Method in class org.apache.lucene.util.collections.IntToObjectMap
  Returns a new iterator for the mapped objects.
iterator() - Method in class org.apache.lucene.util.collections.ObjectToFloatMap
  Returns a new iterator for the mapped floats.
iterator() - Method in class org.apache.lucene.util.collections.ObjectToIntMap
  Returns a new iterator for the mapped objects.

## K

keyIterator() - Method in class org.apache.lucene.util.collections.ArrayHashMap
  Returns an iterator on the map keys.
keyIterator() - Method in class org.apache.lucene.util.collections.FloatToObjectMap
  Returns an iterator on the map keys.
keyIterator() - Method in class org.apache.lucene.util.collections.IntToDoubleMap
  Returns an iterator on the map keys.
keyIterator() - Method in class org.apache.lucene.util.collections.IntToIntMap
  Returns an iterator on the map keys.
keyIterator() - Method in class org.apache.lucene.util.collections.IntToObjectMap
  Returns an iterator on the map keys.
keyIterator() - Method in class org.apache.lucene.util.collections.ObjectToFloatMap
  Returns an iterator on the map keys.
keyIterator() - Method in class org.apache.lucene.util.collections.ObjectToIntMap

## L

labelResult(FacetResult) - Method in class org.apache.lucene.facet.search.FacetResultsHandler
  Label results according to settings in `FacetRequest`, such as `FacetRequest.getNumLabel()`.
labelResult(FacetResult) - Method in class org.apache.lucene.facet.search.TopKFacetResultsHandler
labelResult(FacetResult) - Method in class org.apache.lucene.facet.search.TopKInEachNodeHandler
LabelToOrdinal - Class in org.apache.lucene.facet.taxonomy.writercache.cl2o
  Abstract class for storing Label->Ordinal mappings in a taxonomy.
LabelToOrdinal() - Constructor for class org.apache.lucene.facet.taxonomy.writercache.cl2o.LabelToOrdinal
lastComponent() - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Return the last component of the path, in a new String object.
legalCategory() - Method in class org.apache.lucene.facet.index.streaming.CountingListTokenizer
  A method which allows extending classes to filter the categories going into the counting list.
length() - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Return the number of components in the facet path.
length() - Method in class org.apache.lucene.util.UnsafeByteArrayOutputStream
  Returns the number of relevant bytes.
load(File, IndexReader, TaxonomyReader, FacetIndexingParams) - Method in class org.apache.lucene.facet.search.TotalFacetCountsCache
  Load `TotalFacetCounts` matching input parameters from the provided outputFile and add them into the cache for the provided indexReader, taxonomy, and facetIndexingParams.
loadAndRegister(CategoryListParams, IndexReader, TaxonomyReader, FacetIndexingParams) - Method in class org.apache.lucene.facet.search.cache.CategoryListCache
  Load and register `CategoryListData`.
longHashCode() - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Calculate a 64-bit hash function for this path.
longHashCode(int) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Like `CategoryPath.longHashCode()`, but find the hash function of a prefix with the given number of components, rather than of the entire path.
LRUHashMap<K,V> - Class in org.apache.lucene.util.collections
  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.util.collections.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
  LRU `TaxonomyWriterCache` - good choice for huge taxonomies.
LruTaxonomyWriterCache(int) - Constructor for class org.apache.lucene.facet.taxonomy.writercache.lru.LruTaxonomyWriterCache
LruTaxonomyWriterCache(int, LruTaxonomyWriterCache.LRUType) - Constructor for class org.apache.lucene.facet.taxonomy.writercache.lru.LruTaxonomyWriterCache
LruTaxonomyWriterCache.LRUType - Enum in org.apache.lucene.facet.taxonomy.writercache.lru

## M

map - Variable in class org.apache.lucene.facet.index.CategoryContainer
mapToAACOs - Variable in class org.apache.lucene.facet.search.TopKInEachNodeHandler.IntermediateFacetResultWithHash
mark(int) - Method in class org.apache.lucene.util.UnsafeByteArrayInputStream
markSupported() - Method in class org.apache.lucene.util.UnsafeByteArrayInputStream
MAXIMUM_BYTES_NEEDED - Static variable in class org.apache.lucene.util.Vint8
  The maximum number of bytes needed to encode a number using `Vint8`.
maxPartitions - Variable in class org.apache.lucene.facet.search.StandardFacetsAccumulator
mayComplement() - Method in class org.apache.lucene.facet.search.FacetsAccumulator
  check if all requests are complementable
merge(CategoryProperty) - Method in class org.apache.lucene.facet.enhancements.association.AssociationFloatProperty
merge(CategoryProperty) - Method in class org.apache.lucene.facet.enhancements.association.AssociationIntProperty
merge(CategoryProperty) - Method in interface org.apache.lucene.facet.index.attributes.CategoryProperty
  When adding categories with properties to a certain document, it is possible that the same category will be added more than once with different instances of the same property.
merge(CategoryProperty) - Method in class org.apache.lucene.facet.index.attributes.OrdinalProperty
merge(CategoryContainer) - Method in class org.apache.lucene.facet.index.CategoryContainer
  Add the categories from another `CategoryContainer` to this one.
mergeResults(IntermediateFacetResult...) - Method in class org.apache.lucene.facet.search.FacetResultsHandler
  Merge results of several facet partitions.
mergeResults(IntermediateFacetResult...) - Method in class org.apache.lucene.facet.search.TopKFacetResultsHandler
mergeResults(IntermediateFacetResult...) - Method in class org.apache.lucene.facet.search.TopKInEachNodeHandler
  Merge several partitions' `IntermediateFacetResult`-s into one of the same format
MultiCategoryListIterator - Class in org.apache.lucene.facet.util
  Iterates over multiple `CategoryListIterator`s, consuming the provided iterators in order.
MultiCategoryListIterator(CategoryListIterator...) - Constructor for class org.apache.lucene.facet.util.MultiCategoryListIterator
  Receives the iterators to iterate on
MutableFacetResultNode - Class in org.apache.lucene.facet.search.results
  Mutable implementation for Result of faceted search for a certain taxonomy node.
MutableFacetResultNode(int, double) - Constructor for class org.apache.lucene.facet.search.results.MutableFacetResultNode
  Create a Facet Result Node.
MutableFacetResultNode(int, double, double, CategoryPath, List<FacetResultNode>) - Constructor for class org.apache.lucene.facet.search.results.MutableFacetResultNode
  Create a Facet Result Node.
MutableFacetResultNode(FacetResultNode, boolean) - Constructor for class org.apache.lucene.facet.search.results.MutableFacetResultNode
  Create a mutable facet result node from another result node

## N

NameHashIntCacheLRU - Class in org.apache.lucene.facet.taxonomy.writercache.lru
  An an LRU cache of mapping from name to int.
ncomponents - Variable in class org.apache.lucene.facet.taxonomy.CategoryPath
next() - Method in interface org.apache.lucene.facet.search.ScoredDocIDsIterator
  Iterate to the next document/score pair.
next() - Method in interface org.apache.lucene.util.collections.DoubleIterator
next() - Method in interface org.apache.lucene.util.collections.FloatIterator
next() - Method in interface org.apache.lucene.util.collections.IntIterator
nextCategory() - Method in interface org.apache.lucene.facet.search.CategoryListIterator
  Returns the next category for the current document that is set through `CategoryListIterator.skipTo(int)`, or a number higher than `Integer.MAX_VALUE`.
nextCategory() - Method in class org.apache.lucene.facet.search.PayloadIntDecodingIterator
nextCategory() - Method in class org.apache.lucene.facet.util.MultiCategoryListIterator
  Return a value larger than `Integer.MAX_VALUE` only if all iterators are exhausted
NO_ASSOCIATION - Static variable in class org.apache.lucene.facet.enhancements.association.AssociationsPayloadIterator
  The long-special-value returned for ordinals which have no associated int value.
NOnesIntDecoder - Class in org.apache.lucene.util.encoding
  Decodes data which was encoded by `NOnesIntEncoder`.
NOnesIntDecoder(int) - Constructor for class org.apache.lucene.util.encoding.NOnesIntDecoder
  Constructs a decoder with a given N (Number of consecutive '1's which are translated into a single target value '2'.
NOnesIntEncoder - Class in org.apache.lucene.util.encoding
  A variation of `FourFlagsIntEncoder` which translates the data as follows: Values ≥ 2 are trnalsated to `value+1` (2 ⇒ 3, 3 ⇒ 4 and so forth).
NOnesIntEncoder(int) - Constructor for class org.apache.lucene.util.encoding.NOnesIntEncoder
  Constructs an encoder with a given value of N (N: Number of consecutive '1's to be translated into single target value '2').
NonTopLevelOrdinalPolicy - Class in org.apache.lucene.facet.index.categorypolicy
  Filter out any "top level" category ordinals.
NonTopLevelOrdinalPolicy() - Constructor for class org.apache.lucene.facet.index.categorypolicy.NonTopLevelOrdinalPolicy
  Constructs a new non-top-level-ordinal-filter.
NonTopLevelPathPolicy - Class in org.apache.lucene.facet.index.categorypolicy
  This class filters our the ROOT category, and it's direct descendants.
NonTopLevelPathPolicy() - Constructor for class org.apache.lucene.facet.index.categorypolicy.NonTopLevelPathPolicy
numDocIds - Variable in class org.apache.lucene.facet.search.ScoredDocIdCollector

## O

ObjectToFloatMap<K> - Class in org.apache.lucene.util.collections
  An Array-based hashtable which maps Objects of generic type T to primitive float values.
  The hashtable is constructed with a given capacity, or 16 as a default.
ObjectToFloatMap() - Constructor for class org.apache.lucene.util.collections.ObjectToFloatMap
  Constructs a map with default capacity.
ObjectToFloatMap(int) - Constructor for class org.apache.lucene.util.collections.ObjectToFloatMap
  Constructs a map with given capacity.
ObjectToIntMap<K> - Class in org.apache.lucene.util.collections
  An Array-based hashtable which maps Objects of generic type T to primitive int values.
  The hashtable is constructed with a given capacity, or 16 as a default.
ObjectToIntMap() - Constructor for class org.apache.lucene.util.collections.ObjectToIntMap
  Constructs a map with default capacity.
ObjectToIntMap(int) - Constructor for class org.apache.lucene.util.collections.ObjectToIntMap
  Constructs a map with given capacity.
openIndexReader(Directory) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
openIndexWriter(Directory, IndexWriterConfig) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
  Open internal index writer, which contains the taxonomy data.
openReader() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
  Open an `IndexReader` from the internal `IndexWriter`, by calling `IndexReader.open(IndexWriter, boolean)`.
ordinal - Variable in class org.apache.lucene.facet.index.attributes.OrdinalProperty
ordinal - Variable in class org.apache.lucene.util.encoding.ChunksIntEncoder
  Counts the current ordinal of the encoded value.
OrdinalPolicy - Interface in org.apache.lucene.facet.index.categorypolicy
  Filtering category ordinals in `CategoryParentsStream`, where a given category ordinal is added to the stream, and than its parents are being added one after the other using `TaxonomyWriter.getParent(int)`.
OrdinalProperty - Class in org.apache.lucene.facet.index.attributes
  A `CategoryProperty` holding the ordinal from the taxonomy of the current category in `CategoryAttribute`.
OrdinalProperty() - Constructor for class org.apache.lucene.facet.index.attributes.OrdinalProperty
ordinalProperty - Variable in class org.apache.lucene.facet.index.streaming.CategoryParentsStream
  A category property containing the category ordinal
org.apache.lucene.facet - package org.apache.lucene.facet
  Provides faceted indexing and search capabilities.
org.apache.lucene.facet.enhancements - package org.apache.lucene.facet.enhancements
  Enhanced category features
org.apache.lucene.facet.enhancements.association - package org.apache.lucene.facet.enhancements.association
  Association category enhancements
org.apache.lucene.facet.enhancements.params - package org.apache.lucene.facet.enhancements.params
  Enhanced category features
org.apache.lucene.facet.index - package org.apache.lucene.facet.index
  Indexing of document categories
org.apache.lucene.facet.index.attributes - package org.apache.lucene.facet.index.attributes
  Category attributes and their properties for indexing
org.apache.lucene.facet.index.categorypolicy - package org.apache.lucene.facet.index.categorypolicy
  Policies for indexing categories
org.apache.lucene.facet.index.params - package org.apache.lucene.facet.index.params
  Indexing-time specifications for handling facets
org.apache.lucene.facet.index.streaming - package org.apache.lucene.facet.index.streaming
  Expert: attributes streaming definition for indexing facets
org.apache.lucene.facet.search - package org.apache.lucene.facet.search
  Faceted Search API
org.apache.lucene.facet.search.aggregator - package org.apache.lucene.facet.search.aggregator
  Aggregating Facets during Faceted Search
org.apache.lucene.facet.search.aggregator.association - package org.apache.lucene.facet.search.aggregator.association
  Association-based aggregators.
org.apache.lucene.facet.search.cache - package org.apache.lucene.facet.search.cache
  Caching to speed up facets accumulation.
org.apache.lucene.facet.search.params - package org.apache.lucene.facet.search.params
  Parameters for Faceted Search
org.apache.lucene.facet.search.params.association - package org.apache.lucene.facet.search.params.association
  Association-based Parameters for Faceted Search.
org.apache.lucene.facet.search.results - package org.apache.lucene.facet.search.results
  Results of Faceted Search
org.apache.lucene.facet.search.sampling - package org.apache.lucene.facet.search.sampling
  Sampling for facets accumulation
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 implemented using a Lucene-Index
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
org.apache.lucene.facet.taxonomy.writercache.cl2o - package org.apache.lucene.facet.taxonomy.writercache.cl2o
  Category->Ordinal caching implementation using an optimized data-structures
org.apache.lucene.facet.taxonomy.writercache.lru - package org.apache.lucene.facet.taxonomy.writercache.lru
  An LRU cache implementation for the CategoryPath to Ordinal map
org.apache.lucene.facet.util - package org.apache.lucene.facet.util
  Various utilities for faceted search
org.apache.lucene.util - package org.apache.lucene.util
org.apache.lucene.util.collections - package org.apache.lucene.util.collections
  Various optimized Collections implementations.
org.apache.lucene.util.encoding - package org.apache.lucene.util.encoding
  Offers various encoders and decoders for integers, as well as the mechanisms to create new ones.
out - Variable in class org.apache.lucene.util.encoding.IntEncoder
overSampledSearchParams(FacetSearchParams) - Method in class org.apache.lucene.facet.search.sampling.Sampler
  Over-sampled search params, wrapping each request with an over-sampled one.

## P

partitionName(CategoryListParams, int) - Static method in class org.apache.lucene.facet.util.PartitionsUtils
  Partition name by its number
partitionNameByOrdinal(FacetIndexingParams, CategoryListParams, int) - Static method in class org.apache.lucene.facet.util.PartitionsUtils
  Partition name by category ordinal
partitionNumber(FacetIndexingParams, int) - Static method in class org.apache.lucene.facet.util.PartitionsUtils
  Partition number of an ordinal.
partitionNumber(FacetSearchParams, int) - Static method in class org.apache.lucene.facet.util.PartitionsUtils
partitionOffset(FacetIndexingParams, int, TaxonomyReader) - Static method in class org.apache.lucene.facet.util.PartitionsUtils
  Get the offset for a given partition.
partitionOffset(FacetSearchParams, int, TaxonomyReader) - Static method in class org.apache.lucene.facet.util.PartitionsUtils
partitionSize - Variable in class org.apache.lucene.facet.search.StandardFacetsAccumulator
partitionSize(FacetIndexingParams, TaxonomyReader) - Static method in class org.apache.lucene.facet.util.PartitionsUtils
  Get the partition size in this parameter, or return the size of the taxonomy, which is smaller.
partitionSize(FacetSearchParams, TaxonomyReader) - Static method in class org.apache.lucene.facet.util.PartitionsUtils
PartitionsUtils - Class in org.apache.lucene.facet.util
  Utilities for partitions - sizes and such
PartitionsUtils() - Constructor for class org.apache.lucene.facet.util.PartitionsUtils
PathPolicy - Interface in org.apache.lucene.facet.index.categorypolicy
  Filtering category paths in `CategoryParentsStream`, where a given category is added to the stream, and than all its parents are being added one after the other by successively removing the last component.
payload - Variable in class org.apache.lucene.facet.index.streaming.CategoryTokenizerBase
  The object used for constructing payloads.
payloadAttribute - Variable in class org.apache.lucene.facet.index.streaming.CategoryTokenizerBase
  The stream's payload attribute.
payloadBytes - Variable in class org.apache.lucene.facet.enhancements.EnhancementsCategoryTokenizer
  The data buffer used for payload instance.
PayloadIntDecodingIterator - Class in org.apache.lucene.facet.search
  A payload deserializer comes with its own working space (buffer).
PayloadIntDecodingIterator(IndexReader, Term, IntDecoder) - Constructor for class org.apache.lucene.facet.search.PayloadIntDecodingIterator
PayloadIntDecodingIterator(IndexReader, Term, IntDecoder, byte[]) - Constructor for class org.apache.lucene.facet.search.PayloadIntDecodingIterator
PayloadIterator - Class in org.apache.lucene.facet.search
  A utility class for iterating through a posting list of a given term and retrieving the payload of the first occurrence in every document.
PayloadIterator(IndexReader, Term) - Constructor for class org.apache.lucene.facet.search.PayloadIterator
PayloadIterator(IndexReader, Term, byte[]) - Constructor for class org.apache.lucene.facet.search.PayloadIterator
payloadLength() - Method in class org.apache.lucene.facet.index.FacetsPayloadProcessorProvider.FacetsPayloadProcessor
payloadLength - Variable in class org.apache.lucene.facet.search.PayloadIterator
payloadStream - Variable in class org.apache.lucene.facet.enhancements.association.AssociationListTokenizer
payloadStreamIterator - Variable in class org.apache.lucene.facet.index.streaming.CountingListTokenizer
  An iterator over the payload streams
payloadStreamsByName - Variable in class org.apache.lucene.facet.index.streaming.CountingListTokenizer
  A table for retrieving payload streams by category-list name.
PerDimensionIndexingParams - Class in org.apache.lucene.facet.index.params
  A FacetIndexingParams that utilizes different category lists, defined by the dimension specified CategoryPaths (see `PerDimensionIndexingParams.addCategoryListParams(CategoryPath, CategoryListParams)`
PerDimensionIndexingParams() - Constructor for class org.apache.lucene.facet.index.params.PerDimensionIndexingParams
  Construct with the default `CategoryListParams` as the default CategoryListParams for unspecified CategoryPaths.
PerDimensionIndexingParams(CategoryListParams) - Constructor for class org.apache.lucene.facet.index.params.PerDimensionIndexingParams
  Construct with the included categoryListParams as the default CategoryListParams for unspecified CategoryPaths.
pop() - Method in interface org.apache.lucene.facet.search.Heap
  Get and remove the top of the Heap
  NOTE: Once `Heap.pop()` is called no other `Heap.add(Object)` or `Heap.insertWithOverflow(Object)` should be called.
pos - Variable in class org.apache.lucene.util.Vint8.Position
  The value passed by reference.
prepareCommit() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
  prepare most of the work needed for a two-phase commit.
prepareCommit(Map<String, String>) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
  Like above, and also prepares to store user data with the index.
printBaseHash() - Method in class org.apache.lucene.util.collections.IntHashSet
  Prints the baseHash array, used for debug purposes.
processPayload(byte[], int, int) - Method in class org.apache.lucene.facet.index.FacetsPayloadProcessorProvider.FacetsPayloadProcessor
properties - Variable in class org.apache.lucene.facet.index.attributes.CategoryAttributeImpl
  A map of properties associated to the current category path.
put(CategoryPath, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.Cl2oTaxonomyWriterCache
put(CategoryPath, int, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.Cl2oTaxonomyWriterCache
put(CategoryPath, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.lru.LruTaxonomyWriterCache
put(CategoryPath, int, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.lru.LruTaxonomyWriterCache
put(CategoryPath, 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(CategoryPath, int, int) - Method in interface org.apache.lucene.facet.taxonomy.writercache.TaxonomyWriterCache
  Like `TaxonomyWriterCache.put(CategoryPath, int)`, but for a given prefix of the category path.
put(K, V) - Method in class org.apache.lucene.util.collections.ArrayHashMap
  Inserts the <key,value> pair into the map.
put(float, T) - Method in class org.apache.lucene.util.collections.FloatToObjectMap
  Inserts the <key,value> pair into the map.
put(int, double) - Method in class org.apache.lucene.util.collections.IntToDoubleMap
  Inserts the <key,value> pair into the map.
put(int, int) - Method in class org.apache.lucene.util.collections.IntToIntMap
  Inserts the <key,value> pair into the map.
put(int, T) - Method in class org.apache.lucene.util.collections.IntToObjectMap
  Inserts the <key,value> pair into the map.
put(K, float) - Method in class org.apache.lucene.util.collections.ObjectToFloatMap
  Inserts the <key,value> pair into the map.
put(K, int) - Method in class org.apache.lucene.util.collections.ObjectToIntMap
  Inserts the <key,value> pair into the map.

## Q

query(FacetIndexingParams, CategoryPath...) - Static method in class org.apache.lucene.facet.search.DrillDown
  Return a query for drilling down into all given categories (AND).
query(FacetSearchParams, CategoryPath...) - Static method in class org.apache.lucene.facet.search.DrillDown
  Return a query for drilling down into all given categories (AND).
query(FacetIndexingParams, Query, CategoryPath...) - Static method in class org.apache.lucene.facet.search.DrillDown
  Turn a base query into a drilling-down query for all given category paths (AND).
query(FacetSearchParams, Query, CategoryPath...) - Static method in class org.apache.lucene.facet.search.DrillDown
  Turn a base query into a drilling-down query for all given category paths (AND).
query(Query, CategoryPath...) - Static method in class org.apache.lucene.facet.search.DrillDown
  Turn a base query into a drilling-down query using the default `FacetSearchParams`

## R

RandomSampler - Class in org.apache.lucene.facet.search.sampling
  Simple random sampler
RandomSampler() - Constructor for class org.apache.lucene.facet.search.sampling.RandomSampler
RandomSampler(SamplingParams, Random) - Constructor for class org.apache.lucene.facet.search.sampling.RandomSampler
read() - Method in class org.apache.lucene.util.UnsafeByteArrayInputStream
  Read a byte.
rearrangeFacetResult(FacetResult) - Method in class org.apache.lucene.facet.search.FacetResultsHandler
  Perform any rearrangement as required on a facet result that has changed after it was rendered.
rearrangeFacetResult(FacetResult) - Method in class org.apache.lucene.facet.search.TopKFacetResultsHandler
rearrangeFacetResult(FacetResult) - Method in class org.apache.lucene.facet.search.TopKInEachNodeHandler
refresh() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
refresh() - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyReader
  refresh() re-reads the taxonomy information if there were any changes to the taxonomy since this instance was opened or last refreshed.
register(CategoryListParams, CategoryListData) - Method in class org.apache.lucene.facet.search.cache.CategoryListCache
  Register a pre-computed `CategoryListData`.
reInit(OutputStream) - Method in class org.apache.lucene.util.encoding.ChunksIntEncoder
reInit(InputStream) - Method in class org.apache.lucene.util.encoding.DGapIntDecoder
reInit(OutputStream) - Method in class org.apache.lucene.util.encoding.DGapIntEncoder
reInit(InputStream) - Method in class org.apache.lucene.util.encoding.EightFlagsIntDecoder
reInit(InputStream) - Method in class org.apache.lucene.util.encoding.FourFlagsIntDecoder
reInit(InputStream) - Method in class org.apache.lucene.util.encoding.IntDecoder
  Sets the input stream from which the encoded data is read.
reInit(OutputStream) - Method in class org.apache.lucene.util.encoding.IntEncoder
  Reinitializes the encoder with the give `OutputStream`.
reInit(OutputStream) - Method in class org.apache.lucene.util.encoding.IntEncoderFilter
reInit(InputStream) - Method in class org.apache.lucene.util.encoding.NOnesIntDecoder
reInit(OutputStream) - Method in class org.apache.lucene.util.encoding.NOnesIntEncoder
reInit(OutputStream) - Method in class org.apache.lucene.util.encoding.SortingIntEncoder
reInit(OutputStream) - Method in class org.apache.lucene.util.encoding.UniqueValuesIntEncoder
reInit(byte[]) - Method in class org.apache.lucene.util.UnsafeByteArrayInputStream
  Initialize the stream with a given buffer, using the default limits of [0, buffer.length)
reInit(byte[], int, int) - Method in class org.apache.lucene.util.UnsafeByteArrayInputStream
  Initialize the stream with a given byte array as the source of the stream, at the specific range: [startPos, endPos)
reInit(byte[], int) - Method in class org.apache.lucene.util.UnsafeByteArrayOutputStream
  For reuse-ability, this stream object can be re-initialized with another given buffer and starting position.
reInit(byte[]) - Method in class org.apache.lucene.util.UnsafeByteArrayOutputStream
  For reuse-ability, this stream object can be re-initialized with another given buffer, using 0 as default starting position.
remove(Class<? extends CategoryProperty>) - Method in interface org.apache.lucene.facet.index.attributes.CategoryAttribute
  Remove an property of a certain property class.
remove(Class<? extends CategoryProperty>) - Method in class org.apache.lucene.facet.index.attributes.CategoryAttributeImpl
remove(K) - Method in class org.apache.lucene.util.collections.ArrayHashMap
  Removes a <key,value> pair from the map and returns the mapped value, or null if the none existed.
remove() - Method in interface org.apache.lucene.util.collections.DoubleIterator
remove() - Method in interface org.apache.lucene.util.collections.FloatIterator
remove(float) - Method in class org.apache.lucene.util.collections.FloatToObjectMap
  Removes a <key,value> pair from the map and returns the mapped value, or null if the none existed.
remove(int) - Method in class org.apache.lucene.util.collections.IntHashSet
  Remove a pair from the map, specified by it's key.
remove() - Method in interface org.apache.lucene.util.collections.IntIterator
remove(int) - Method in class org.apache.lucene.util.collections.IntToDoubleMap
  Removes a <key,value> pair from the map and returns the mapped value, or `Double.NaN` if the none existed.
remove(int) - Method in class org.apache.lucene.util.collections.IntToIntMap
  Removes a <key,value> pair from the map and returns the mapped value, or 0 if the none existed.
remove(int) - Method in class org.apache.lucene.util.collections.IntToObjectMap
  Removes a <key,value> pair from the map and returns the mapped value, or null if the none existed.
remove(K) - Method in class org.apache.lucene.util.collections.ObjectToFloatMap
  Removes a <key,value> pair from the map and returns the mapped value, or `Float.NaN` if the none existed.
remove(K) - Method in class org.apache.lucene.util.collections.ObjectToIntMap
  Removes a <key,value> pair from the map and returns the mapped value, or 0 if the none existed.
removeEldestEntry(Map.Entry<K, V>) - Method in class org.apache.lucene.util.collections.LRUHashMap
renderFacetResult(IntermediateFacetResult) - Method in class org.apache.lucene.facet.search.FacetResultsHandler
  Create a facet result from the temporary result.
renderFacetResult(IntermediateFacetResult) - Method in class org.apache.lucene.facet.search.TopKFacetResultsHandler
renderFacetResult(IntermediateFacetResult) - Method in class org.apache.lucene.facet.search.TopKInEachNodeHandler
RepeatableSampler - Class in org.apache.lucene.facet.search.sampling
  Take random samples of large collections.
RepeatableSampler(SamplingParams) - Constructor for class org.apache.lucene.facet.search.sampling.RepeatableSampler
requireDocumentScore() - Method in class org.apache.lucene.facet.search.params.association.AssociationFloatSumFacetRequest
requireDocumentScore() - Method in class org.apache.lucene.facet.search.params.association.AssociationIntSumFacetRequest
requireDocumentScore() - Method in class org.apache.lucene.facet.search.params.CountFacetRequest
requireDocumentScore() - Method in class org.apache.lucene.facet.search.params.FacetRequest
  Indicates whether the results of this request depends on each result document's score
requireDocumentScore() - Method in class org.apache.lucene.facet.search.params.ScoreFacetRequest
reset() - Method in class org.apache.lucene.facet.index.CategoryListPayloadStream
  Resets this stream to begin building a new payload.
reset() - Method in class org.apache.lucene.facet.index.streaming.CategoryAttributesStream
reset() - Method in class org.apache.lucene.facet.index.streaming.CategoryListTokenizer
reset(int, double) - Method in class org.apache.lucene.facet.search.results.MutableFacetResultNode
  Reset a facet Result Node.
reset() - Method in class org.apache.lucene.util.UnsafeByteArrayInputStream
  Resets the stream back to its original state.
ResultSortUtils - Class in org.apache.lucene.facet.util
  Utilities for generating facet results sorted as required
ResultSortUtils() - Constructor for class org.apache.lucene.facet.util.ResultSortUtils
rollback() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
  Rollback changes to the taxonomy writer and closes the instance.
ROOT_ORDINAL - Static variable in interface 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

SampleFixer - Interface in org.apache.lucene.facet.search.sampling
  Fixer of sample facet accumulation results
Sampler - Class in org.apache.lucene.facet.search.sampling
  Sampling definition for facets accumulation
Sampler() - Constructor for class org.apache.lucene.facet.search.sampling.Sampler
  Construct with `SamplingParams`
Sampler(SamplingParams) - Constructor for class org.apache.lucene.facet.search.sampling.Sampler
  Construct with certain `SamplingParams`
Sampler.SampleResult - Class in org.apache.lucene.facet.search.sampling
  Result of sample computation
Sampler.SampleResult(ScoredDocIDs, double) - Constructor for class org.apache.lucene.facet.search.sampling.Sampler.SampleResult
SamplingAccumulator - Class in org.apache.lucene.facet.search.sampling
  Facets accumulation with sampling.
SamplingAccumulator(Sampler, FacetSearchParams, IndexReader, TaxonomyReader, IntArrayAllocator, FloatArrayAllocator) - Constructor for class org.apache.lucene.facet.search.sampling.SamplingAccumulator
  Constructor...
SamplingAccumulator(Sampler, FacetSearchParams, IndexReader, TaxonomyReader) - Constructor for class org.apache.lucene.facet.search.sampling.SamplingAccumulator
  Constructor...
samplingParams - Variable in class org.apache.lucene.facet.search.sampling.Sampler
SamplingParams - Class in org.apache.lucene.facet.search.sampling
  Parameters for sampling, dictating whether sampling is to take place and how.
SamplingParams() - Constructor for class org.apache.lucene.facet.search.sampling.SamplingParams
SamplingWrapper - Class in org.apache.lucene.facet.search
  Wrap any Facets Accumulator with sampling.
SamplingWrapper(FacetsAccumulator, Sampler) - Constructor for class org.apache.lucene.facet.search.SamplingWrapper
ScoredDocIdCollector - Class in org.apache.lucene.facet.search
  A `Collector` which stores all docIDs and their scores in a `ScoredDocIDs` instance.
ScoredDocIDs - Interface in org.apache.lucene.facet.search
  Document IDs with scores for each, driving facets accumulation.
scoredDocIdsIterator() - Method in class org.apache.lucene.facet.search.ScoredDocIdCollector
ScoredDocIDsIterator - Interface in org.apache.lucene.facet.search
  Iterator over document IDs and their scores.
ScoredDocIdsUtils - Class in org.apache.lucene.facet.util
  Utility methods for Scored Doc IDs.
ScoredDocIdsUtils() - Constructor for class org.apache.lucene.facet.util.ScoredDocIdsUtils
ScoreFacetRequest - Class in org.apache.lucene.facet.search.params
  Facet request for weighting facets according to document scores.
ScoreFacetRequest(CategoryPath, int) - Constructor for class org.apache.lucene.facet.search.params.ScoreFacetRequest
  Create a score facet request for a given node in the taxonomy.
ScoringAggregator - Class in org.apache.lucene.facet.search.aggregator
  An `Aggregator` which updates the weight of a category according to the scores of the documents it was found in.
ScoringAggregator(float[]) - Constructor for class org.apache.lucene.facet.search.aggregator.ScoringAggregator
searchParams - Variable in class org.apache.lucene.facet.search.FacetsAccumulator
serializeAppendTo(Appendable) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Write out a serialized (as a character sequence) representation of the path to a given Appendable (e.g., a StringBuilder, CharBuffer, Writer, or something similar.
serializeAppendTo(int, Appendable) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Just like `CategoryPath.serializeAppendTo(Appendable)`, but writes only a prefix of the CategoryPath.
serializeCategoryAttribute(ObjectOutputStream, CategoryAttribute) - Method in class org.apache.lucene.facet.index.CategoryContainer
  Serialize each of the `CategoryAttribute`s to the given `ObjectOutputStream`.
  NOTE: `CategoryProperty`s are `Serializable`, but do not assume that Lucene's `Attribute`s are as well
serializeToStreamWriter(OutputStreamWriter) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Serializes the content of this CategoryPath to a byte stream, using UTF-8 encoding to convert characters to bytes, and treating the ends as 16-bit characters.
set(CategoryAttribute) - Method in interface org.apache.lucene.facet.index.attributes.CategoryAttribute
  Set the content of this `CategoryAttribute` from another `CategoryAttribute` object.
set(CategoryAttribute) - Method in class org.apache.lucene.facet.index.attributes.CategoryAttributeImpl
set(int, int) - Method in class org.apache.lucene.util.collections.IntArray
setAllowLabeling(boolean) - Method in class org.apache.lucene.facet.search.FacetsAccumulator
  Set whether labeling is allowed for this accumulator.
setAllowLabeling(boolean) - Method in class org.apache.lucene.facet.search.SamplingWrapper
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.search.TotalFacetCountsCache
  Set the number of TotalFacetCounts arrays that will remain 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(CategoryPath)`.
setCategories(Iterable<CategoryAttribute>) - Method in class org.apache.lucene.facet.index.CategoryDocumentBuilder
  Set the categories of the document builder from an `Iterable` of `CategoryAttribute` objects.
setCategoryPath(CategoryPath) - Method in interface org.apache.lucene.facet.index.attributes.CategoryAttribute
  Sets the category path value of this attribute.
setCategoryPath(CategoryPath) - Method in class org.apache.lucene.facet.index.attributes.CategoryAttributeImpl
setCategoryPaths(Iterable<CategoryPath>) - Method in class org.apache.lucene.facet.index.CategoryDocumentBuilder
  Set the categories of the document builder from an `Iterable` of `CategoryPath` objects.
setClCache(CategoryListCache) - Method in class org.apache.lucene.facet.search.params.FacetSearchParams
  Set Cached Category Lists data to be used in Faceted search.
setComplementThreshold(double) - Method in class org.apache.lucene.facet.search.FacetsAccumulator
  Set the complement threshold.
setComplementThreshold(double) - Method in class org.apache.lucene.facet.search.SamplingWrapper
setDefaultScore(float) - Method in class org.apache.lucene.facet.search.ScoredDocIdCollector
  Set the default score.
setDelimiter(char) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
  setDelimiter changes the character that the taxonomy uses in its internal storage as a delimiter between category components.
setDelimiter(char) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
  setDelimiter changes the character that the taxonomy uses in its internal storage as a delimiter between category components.
setDepth(int) - Method in class org.apache.lucene.facet.search.params.FacetRequest
setdoc(int) - Method in class org.apache.lucene.facet.enhancements.EnhancementsPayloadIterator
setdoc(int) - Method in class org.apache.lucene.facet.search.PayloadIterator
  Skip forward to document docId.
setFromSerialized(CharSequence, int) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Set a CategoryPath from a character-sequence representation written by `CategoryPath.serializeAppendTo(Appendable)`.
setLabel(CategoryPath) - Method in class org.apache.lucene.facet.search.results.MutableFacetResultNode
  Set the label of the category of this result.
setMaxSampleSize(int) - Method in class org.apache.lucene.facet.search.sampling.SamplingParams
setMaxSize(int) - Method in class org.apache.lucene.util.collections.LRUHashMap
  setMaxSize() allows changing the map's maximal number of elements which was defined at construction time.
setMinSampleSize(int) - Method in class org.apache.lucene.facet.search.sampling.SamplingParams
setNextDoc(int) - Method in class org.apache.lucene.facet.enhancements.association.AssociationsPayloadIterator
  Skipping to the next document, fetching its associations & populating the map.
setNextDoc(int, float) - Method in interface org.apache.lucene.facet.search.aggregator.Aggregator
  Specify the document (and its score in the search) that the following `Aggregator.aggregate(int)` calls will pertain to.
setNextDoc(int, float) - Method in class org.apache.lucene.facet.search.aggregator.association.AssociationFloatSumAggregator
setNextDoc(int, float) - Method in class org.apache.lucene.facet.search.aggregator.association.AssociationIntSumAggregator
setNextDoc(int, float) - Method in class org.apache.lucene.facet.search.aggregator.CountingAggregator
setNextDoc(int, float) - Method in class org.apache.lucene.facet.search.aggregator.ScoringAggregator
setNextReader(IndexReader, int) - Method in class org.apache.lucene.facet.search.FacetsCollector
setNextReader(IndexReader, int) - Method in class org.apache.lucene.facet.search.ScoredDocIdCollector
setNumLabel(int) - Method in class org.apache.lucene.facet.search.params.FacetRequest
setOrdinal(int) - Method in class org.apache.lucene.facet.index.attributes.OrdinalProperty
setOversampleFactor(double) - Method in class org.apache.lucene.facet.search.sampling.SamplingParams
setPayload() - Method in class org.apache.lucene.facet.enhancements.EnhancementsCategoryTokenizer
setPayload() - Method in class org.apache.lucene.facet.index.streaming.CategoryTokenizer
  Set the payload of the current category token.
setResidue(double) - Method in class org.apache.lucene.facet.search.results.MutableFacetResultNode
  Set the residue.
setResultMode(FacetRequest.ResultMode) - Method in class org.apache.lucene.facet.search.params.FacetRequest
setSampingThreshold(int) - Method in class org.apache.lucene.facet.search.sampling.SamplingParams
  Set a sampling-threshold
setSampler(Sampler) - Method in class org.apache.lucene.facet.search.AdaptiveFacetsAccumulator
  Set the sampler.
setSampleRatio(double) - Method in class org.apache.lucene.facet.search.sampling.SamplingParams
setScorer(Scorer) - Method in class org.apache.lucene.facet.search.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.
setSortBy(FacetRequest.SortBy) - Method in class org.apache.lucene.facet.search.params.FacetRequest
setSortOrder(FacetRequest.SortOrder) - Method in class org.apache.lucene.facet.search.params.FacetRequest
setSubResults(List<FacetResultNode>) - Method in class org.apache.lucene.facet.search.results.MutableFacetResultNode
  Set the sub results.
setValue(double) - Method in interface org.apache.lucene.facet.search.results.FacetResultNode
  Expert: Set a new value for this result node.
setValue(double) - Method in class org.apache.lucene.facet.search.results.MutableFacetResultNode
  Set the value of this result.
shouldAdd(int) - Method in class org.apache.lucene.facet.index.categorypolicy.DefaultOrdinalPolicy
  Filters out (returns false) ordinals equal or less than `TaxonomyReader.ROOT_ORDINAL`.
shouldAdd(CategoryPath) - Method in class org.apache.lucene.facet.index.categorypolicy.DefaultPathPolicy
  Filters out (returns false) CategoryPaths equal or less than `TaxonomyReader.ROOT_ORDINAL`.
shouldAdd(int) - Method in class org.apache.lucene.facet.index.categorypolicy.NonTopLevelOrdinalPolicy
  Filters out ordinal which are ROOT or who's parent is ROOT.
shouldAdd(CategoryPath) - Method in class org.apache.lucene.facet.index.categorypolicy.NonTopLevelPathPolicy
  Filters out (returns false) CategoryPaths equal or less than `TaxonomyReader.ROOT_ORDINAL`.
shouldAdd(int) - Method in interface org.apache.lucene.facet.index.categorypolicy.OrdinalPolicy
  Check whether a given category ordinal should be added to the stream.
shouldAdd(CategoryPath) - Method in interface org.apache.lucene.facet.index.categorypolicy.PathPolicy
  Check whether a given category path should be added to the stream.
shouldComplement(ScoredDocIDs) - Method in class org.apache.lucene.facet.search.StandardFacetsAccumulator
  Check if it is worth to use complements
shouldSample(ScoredDocIDs) - Method in class org.apache.lucene.facet.search.sampling.Sampler
  Check if this sampler would complement for the input docIds
SimpleIntDecoder - Class in org.apache.lucene.util.encoding
  A simple stream decoder which can decode values encoded with `SimpleIntEncoder`.
SimpleIntDecoder() - Constructor for class org.apache.lucene.util.encoding.SimpleIntDecoder
SimpleIntEncoder - Class in org.apache.lucene.util.encoding
  A simple `IntEncoder`, writing an integer as 4 raw bytes.
SimpleIntEncoder() - Constructor for class org.apache.lucene.util.encoding.SimpleIntEncoder
size() - Method in class org.apache.lucene.facet.index.CategoryContainer
  Get the number of categories in the container.
size() - Method in interface org.apache.lucene.facet.search.Heap
  Return the amount of objects currently in the heap
size() - Method in interface org.apache.lucene.facet.search.ScoredDocIDs
  Returns the number of scored documents.
size() - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.CollisionMap
size() - Method in class org.apache.lucene.util.collections.ArrayHashMap
  Returns number of pairs currently in the map.
size() - Method in class org.apache.lucene.util.collections.FloatToObjectMap
size() - Method in class org.apache.lucene.util.collections.IntArray
  Return the size of the Array.
size() - Method in class org.apache.lucene.util.collections.IntHashSet
size() - Method in class org.apache.lucene.util.collections.IntToDoubleMap
size() - Method in class org.apache.lucene.util.collections.IntToIntMap
size() - Method in class org.apache.lucene.util.collections.IntToObjectMap
size() - Method in class org.apache.lucene.util.collections.ObjectToFloatMap
size() - Method in class org.apache.lucene.util.collections.ObjectToIntMap
sizeOfMap() - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.CompactLabelToOrdinal
skipTo(int) - Method in interface org.apache.lucene.facet.search.CategoryListIterator
  Skips forward to document docId.
skipTo(int) - Method in class org.apache.lucene.facet.search.PayloadIntDecodingIterator
skipTo(int) - Method in class org.apache.lucene.facet.util.MultiCategoryListIterator
  Fails only if skipTo on all the provided iterators returned `false`
sort() - Method in class org.apache.lucene.util.collections.IntArray
  Sorts the data.
SortingIntEncoder - Class in org.apache.lucene.util.encoding
  An `IntEncoderFilter` which sorts the values to encode in ascending order before encoding them.
SortingIntEncoder(IntEncoder) - Constructor for class org.apache.lucene.util.encoding.SortingIntEncoder
  Initializes with the given encoder.
StandardFacetsAccumulator - Class in org.apache.lucene.facet.search
  Standard implementation for `FacetsAccumulator`, utilizing partitions to save on memory.
StandardFacetsAccumulator(FacetSearchParams, IndexReader, TaxonomyReader, IntArrayAllocator, FloatArrayAllocator) - Constructor for class org.apache.lucene.facet.search.StandardFacetsAccumulator
StandardFacetsAccumulator(FacetSearchParams, IndexReader, TaxonomyReader) - Constructor for class org.apache.lucene.facet.search.StandardFacetsAccumulator
store(File, IndexReader, TaxonomyReader, FacetIndexingParams, CategoryListCache) - Method in class org.apache.lucene.facet.search.TotalFacetCountsCache
  Store the `TotalFacetCounts` matching input parameters into the provided outputFile, making them available for a later call to `TotalFacetCountsCache.load(File, IndexReader, TaxonomyReader, FacetIndexingParams)`.
sumArray - Variable in class org.apache.lucene.facet.search.aggregator.association.AssociationFloatSumAggregator
sumArray - Variable in class org.apache.lucene.facet.search.aggregator.association.AssociationIntSumAggregator
supportsComplements() - Method in class org.apache.lucene.facet.search.params.association.AssociationFloatSumFacetRequest
supportsComplements() - Method in class org.apache.lucene.facet.search.params.association.AssociationIntSumFacetRequest
supportsComplements() - Method in class org.apache.lucene.facet.search.params.CountFacetRequest
supportsComplements() - Method in class org.apache.lucene.facet.search.params.FacetRequest
  Indicates whether this facet request is eligible for applying the complements optimization.
supportsComplements() - Method in class org.apache.lucene.facet.search.params.ScoreFacetRequest

## T

taxonomyReader - Variable in class org.apache.lucene.facet.search.FacetResultsHandler
  Taxonomy for which facets are handled
taxonomyReader - Variable in class org.apache.lucene.facet.search.FacetsAccumulator
TaxonomyReader - Interface 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.ChildrenArrays - Interface in org.apache.lucene.facet.taxonomy
  Equivalent representations of the taxonomy's parent info, used internally for efficient computation of facet results: "youngest child" and "oldest sibling"
taxonomyWriter - Variable in class org.apache.lucene.facet.index.CategoryDocumentBuilder
  A `TaxonomyWriter` for adding categories and retrieving their ordinals.
taxonomyWriter - Variable in class org.apache.lucene.facet.index.streaming.CategoryParentsStream
  A `TaxonomyWriter` for adding categories and retrieving their ordinals.
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`).
TemporaryObjectAllocator<T> - Class in org.apache.lucene.facet.search
  An TemporaryObjectAllocator is an object which manages large, reusable, temporary objects needed during multiple concurrent computations.
TemporaryObjectAllocator(int) - Constructor for class org.apache.lucene.facet.search.TemporaryObjectAllocator
  Construct an allocator for objects of a certain type, keeping around a pool of up to `maxObjects` old objects.
term(FacetSearchParams, CategoryPath) - Static method in class org.apache.lucene.facet.search.DrillDown
term(FacetIndexingParams, CategoryPath) - Static method in class org.apache.lucene.facet.search.DrillDown
  Return a term for drilling down into a category.
termAttribute - Variable in class org.apache.lucene.facet.index.streaming.CategoryTokenizerBase
  The stream's term attribute.
toArray() - Method in class org.apache.lucene.util.collections.ArrayHashMap
  Translates the mapped pairs' values into an array of Objects
toArray(V[]) - Method in class org.apache.lucene.util.collections.ArrayHashMap
  Translates the mapped pairs' values into an array of V
toArray() - Method in class org.apache.lucene.util.collections.FloatToObjectMap
  Translates the mapped pairs' values into an array of Objects
toArray(T[]) - Method in class org.apache.lucene.util.collections.FloatToObjectMap
  Translates the mapped pairs' values into an array of T
toArray() - Method in class org.apache.lucene.util.collections.IntHashSet
  Translates the mapped pairs' values into an array of Objects
toArray(int[]) - Method in class org.apache.lucene.util.collections.IntHashSet
  Translates the mapped pairs' values into an array of ints
toArray() - Method in class org.apache.lucene.util.collections.IntToDoubleMap
  Translates the mapped pairs' values into an array of Objects
toArray(double[]) - Method in class org.apache.lucene.util.collections.IntToDoubleMap
  Translates the mapped pairs' values into an array of T
toArray() - Method in class org.apache.lucene.util.collections.IntToIntMap
  Translates the mapped pairs' values into an array of Objects
toArray(int[]) - Method in class org.apache.lucene.util.collections.IntToIntMap
  Translates the mapped pairs' values into an array of ints
toArray() - Method in class org.apache.lucene.util.collections.IntToObjectMap
  Translates the mapped pairs' values into an array of Objects
toArray(T[]) - Method in class org.apache.lucene.util.collections.IntToObjectMap
  Translates the mapped pairs' values into an array of T
toArray() - Method in class org.apache.lucene.util.collections.ObjectToFloatMap
  Translates the mapped pairs' values into an array of Objects
toArray(float[]) - Method in class org.apache.lucene.util.collections.ObjectToFloatMap
  Translates the mapped pairs' values into an array of T
toArray() - Method in class org.apache.lucene.util.collections.ObjectToIntMap
  Translates the mapped pairs' values into an array of Objects
toArray(int[]) - Method in class org.apache.lucene.util.collections.ObjectToIntMap
  Translates the mapped pairs' values into an array of T
toByteArray() - Method in class org.apache.lucene.util.UnsafeByteArrayOutputStream
  Returns the byte array saved within the buffer AS IS.
toHashString() - Method in class org.apache.lucene.util.collections.IntHashSet
toImpl(FacetResultNode) - Static method in class org.apache.lucene.facet.search.results.MutableFacetResultNode
  Internal utility: turn a result node into an implementation class with richer API that allows modifying it.
top() - Method in interface org.apache.lucene.facet.search.Heap
  Get (But not remove) the top of the Heap
TopKFacetResultsHandler - Class in org.apache.lucene.facet.search
  Generate Top-K results for a particular FacetRequest.
TopKFacetResultsHandler(TaxonomyReader, FacetRequest) - Constructor for class org.apache.lucene.facet.search.TopKFacetResultsHandler
  Construct top-K results handler.
TopKInEachNodeHandler - Class in org.apache.lucene.facet.search
  Generates `FacetResult` from the count arrays aggregated for a particular `FacetRequest`.
TopKInEachNodeHandler(TaxonomyReader, FacetRequest) - Constructor for class org.apache.lucene.facet.search.TopKInEachNodeHandler
TopKInEachNodeHandler.IntermediateFacetResultWithHash - Class in org.apache.lucene.facet.search
  Intermediate result to hold counts from one or more partitions processed thus far.
TopKInEachNodeHandler.IntermediateFacetResultWithHash(FacetRequest, IntToObjectMap<TopKInEachNodeHandler.AACO>) - Constructor for class org.apache.lucene.facet.search.TopKInEachNodeHandler.IntermediateFacetResultWithHash
toString() - Method in class org.apache.lucene.facet.enhancements.association.AssociationFloatProperty
toString() - Method in class org.apache.lucene.facet.enhancements.association.AssociationProperty
toString() - Method in class org.apache.lucene.facet.index.CategoryContainer
toString() - Method in class org.apache.lucene.facet.search.params.FacetRequest
toString() - Method in class org.apache.lucene.facet.search.params.FacetSearchParams
toString(String) - Method in class org.apache.lucene.facet.search.results.FacetResult
  String representation of this facet result.
toString() - Method in class org.apache.lucene.facet.search.results.FacetResult
toString(String) - Method in interface org.apache.lucene.facet.search.results.FacetResultNode
  String representation of this facet result node.
toString() - Method in class org.apache.lucene.facet.search.results.MutableFacetResultNode
toString(String) - Method in class org.apache.lucene.facet.search.results.MutableFacetResultNode
toString(char) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Build a string representation of the path, with its components separated by the given delimiter character.
toString() - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  This method, an implementation of the `Object.toString()` interface, is to allow simple printing of a CategoryPath, for debugging purposes.
toString(char, int) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  like `CategoryPath.toString(char)`, but takes only a prefix with a given number of components, rather than the whole path.
toString(char, int, int) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  like `CategoryPath.toString(char)`, but takes only a part of the path, rather than the whole path.
toString(int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
toString() - Method in class org.apache.lucene.util.collections.ArrayHashMap
toString() - Method in class org.apache.lucene.util.collections.FloatToObjectMap
toString() - Method in class org.apache.lucene.util.collections.IntArray
  toString or not toString.
toString() - Method in class org.apache.lucene.util.collections.IntHashSet
  I have no idea why would anyone call it - but for debug purposes.
  Prints the entire map, including the index, key, object, next and prev.
toString() - Method in class org.apache.lucene.util.collections.IntToDoubleMap
toString() - Method in class org.apache.lucene.util.collections.IntToIntMap
toString() - Method in class org.apache.lucene.util.collections.IntToObjectMap
toString() - Method in class org.apache.lucene.util.collections.ObjectToFloatMap
toString() - Method in class org.apache.lucene.util.collections.ObjectToIntMap
toString() - Method in class org.apache.lucene.util.encoding.DGapIntDecoder
toString() - Method in class org.apache.lucene.util.encoding.DGapIntEncoder
toString() - Method in class org.apache.lucene.util.encoding.EightFlagsIntDecoder
toString() - Method in class org.apache.lucene.util.encoding.EightFlagsIntEncoder
toString() - Method in class org.apache.lucene.util.encoding.FourFlagsIntDecoder
toString() - Method in class org.apache.lucene.util.encoding.FourFlagsIntEncoder
toString() - Method in class org.apache.lucene.util.encoding.NOnesIntDecoder
toString() - Method in class org.apache.lucene.util.encoding.NOnesIntEncoder
toString() - Method in class org.apache.lucene.util.encoding.SimpleIntDecoder
toString() - Method in class org.apache.lucene.util.encoding.SimpleIntEncoder
toString() - Method in class org.apache.lucene.util.encoding.SortingIntEncoder
toString() - Method in class org.apache.lucene.util.encoding.UniqueValuesIntEncoder
toString() - Method in class org.apache.lucene.util.encoding.VInt8IntDecoder
toString() - Method in class org.apache.lucene.util.encoding.VInt8IntEncoder
TotalFacetCounts - Class in org.apache.lucene.facet.search
  Maintain Total Facet Counts per partition, for given parameters: Index reader of an index Taxonomy index reader Facet indexing params (and particularly the category list params) The total facet counts are maintained as an array of arrays of integers, where a separate array is kept for each partition.
TotalFacetCountsCache - Class in org.apache.lucene.facet.search
  Manage an LRU cache for `TotalFacetCounts` per index, taxonomy, and facet indexing params.
trim(int) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
  Trim the last components from the path.
trimResult(FacetResult) - Method in class org.apache.lucene.facet.search.sampling.Sampler
  Trim the input facet result.
  Note: It is only valid to call this method with result obtained for a facet request created through `Sampler.overSampledSearchParams(FacetSearchParams)`.
trimSubResults(int) - Method in class org.apache.lucene.facet.search.results.MutableFacetResultNode
  Trim sub results to a given size.

## U

UniqueValuesIntEncoder - Class in org.apache.lucene.util.encoding
  An `IntEncoderFilter` which ensures only unique values are encoded.
UniqueValuesIntEncoder(IntEncoder) - Constructor for class org.apache.lucene.util.encoding.UniqueValuesIntEncoder
  Constructs a new instance with the given encoder.
unlock(Directory) - Static method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
  Forcibly unlocks the taxonomy in the named directory.
UnsafeByteArrayInputStream - Class in org.apache.lucene.util
  This class, much like `ByteArrayInputStream` uses a given buffer as a source of an InputStream.
UnsafeByteArrayInputStream() - Constructor for class org.apache.lucene.util.UnsafeByteArrayInputStream
  Creates a new instance by not using any byte[] up front.
UnsafeByteArrayInputStream(byte[]) - Constructor for class org.apache.lucene.util.UnsafeByteArrayInputStream
  Creates an UnsafeByteArrayInputStream which uses a given byte array as the source of the stream.
UnsafeByteArrayInputStream(byte[], int, int) - Constructor for class org.apache.lucene.util.UnsafeByteArrayInputStream
  Creates an UnsafeByteArrayInputStream which uses a given byte array as the source of the stream, at the specific range: [startPos, endPos)
UnsafeByteArrayOutputStream - Class in org.apache.lucene.util
  This class is used as a wrapper to a byte array, extending `OutputStream`.
UnsafeByteArrayOutputStream() - Constructor for class org.apache.lucene.util.UnsafeByteArrayOutputStream
  Constructs a new output stream, with a default allocated buffer which can later be obtained via `UnsafeByteArrayOutputStream.toByteArray()`.
UnsafeByteArrayOutputStream(byte[]) - Constructor for class org.apache.lucene.util.UnsafeByteArrayOutputStream
  Constructs a new output stream, with a given buffer.
UnsafeByteArrayOutputStream(byte[], int) - Constructor for class org.apache.lucene.util.UnsafeByteArrayOutputStream
  Constructs a new output stream, with a given buffer.

## V

validate() - Method in class org.apache.lucene.facet.search.sampling.SamplingParams
  Check validity of sampling settings, making sure that `minSampleSize <= maxSampleSize <= samplingThreshold` `0 < samplingRatio <= 1`
valueOf(String) - Static method in enum org.apache.lucene.facet.search.params.FacetRequest.ResultMode
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.lucene.facet.search.params.FacetRequest.SortBy
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.lucene.facet.search.params.FacetRequest.SortOrder
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.lucene.facet.taxonomy.writercache.lru.LruTaxonomyWriterCache.LRUType
  Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.lucene.facet.search.params.FacetRequest.ResultMode
  Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum org.apache.lucene.facet.search.params.FacetRequest.SortBy
  Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum org.apache.lucene.facet.search.params.FacetRequest.SortOrder
  Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum org.apache.lucene.facet.taxonomy.writercache.lru.LruTaxonomyWriterCache.LRUType
  Returns an array containing the constants of this enum type, in the order they're declared.
Vint8 - Class in org.apache.lucene.util
  Variable-length encoding of 32-bit integers, into 8-bit bytes.
Vint8.Position - Class in org.apache.lucene.util
  Because Java lacks call-by-reference, this class boxes the decoding position, which is initially set by the caller, and returned after decoding, incremented by the number of bytes processed.
Vint8.Position() - Constructor for class org.apache.lucene.util.Vint8.Position
  Creates a position value set to zero.
Vint8.Position(int) - Constructor for class org.apache.lucene.util.Vint8.Position
  Creates a position set to `initialPosition`.
VInt8IntDecoder - Class in org.apache.lucene.util.encoding
  An `IntDecoder` which can decode values encoded by `VInt8IntEncoder`.
VInt8IntDecoder() - Constructor for class org.apache.lucene.util.encoding.VInt8IntDecoder
VInt8IntEncoder - Class in org.apache.lucene.util.encoding
  An `IntEncoder` which implements variable length encoding.
VInt8IntEncoder() - Constructor for class org.apache.lucene.util.encoding.VInt8IntEncoder

## W

write(int) - Method in class org.apache.lucene.util.UnsafeByteArrayOutputStream
  writes a given byte(at the form of an int) to the buffer.
write(byte[], int, int) - Method in class org.apache.lucene.util.UnsafeByteArrayOutputStream
  writes a given byte[], with offset and length to the buffer.

A B C D E F G H I K L M N O P Q R S T U V W