Index (Lucene 4.3.0 API)

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

A

accumulate(ScoredDocIDs) - Method in class org.apache.lucene.facet.sampling.SamplingAccumulator
accumulate(ScoredDocIDs) - Method in class org.apache.lucene.facet.sampling.SamplingWrapper
accumulate(ScoredDocIDs) - Method in class org.apache.lucene.facet.search.AdaptiveFacetsAccumulator
accumulate(List<FacetsCollector.MatchingDocs>) - Method in class org.apache.lucene.facet.search.FacetsAccumulator: Used by FacetsCollector to build the list of facet results that match the facet requests that were given in the constructor.
accumulate(ScoredDocIDs) - Method in class org.apache.lucene.facet.search.StandardFacetsAccumulator
accumulate(List<FacetsCollector.MatchingDocs>) - Method in class org.apache.lucene.facet.search.StandardFacetsAccumulator
accumulate(List<FacetsCollector.MatchingDocs>) - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesAccumulator
actualDocsToAccumulate(ScoredDocIDs) - Method in class org.apache.lucene.facet.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.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, FacetArrays) - Constructor for class org.apache.lucene.facet.search.AdaptiveFacetsAccumulator: Create an AdaptiveFacetsAccumulator
add(int) - Method in class org.apache.lucene.facet.collections.IntHashSet: Add a mapping int key -> int value.
add(CategoryPath...) - Method in class org.apache.lucene.facet.search.DrillDownQuery: Adds one dimension of drill downs; if you pass multiple values they are OR'd, and then the entire dimension is AND'd against the base query.
add(T) - Method in interface org.apache.lucene.facet.search.Heap: Add a new value to the heap, return the new top().
addAdditionalAttributes(CategoryPath, boolean) - Method in class org.apache.lucene.facet.associations.AssociationsDrillDownStream
addAdditionalAttributes(CategoryPath, boolean) - Method in class org.apache.lucene.facet.index.DrillDownStream
addBinaryField(FieldInfo, Iterable<BytesRef>) - Method in class org.apache.lucene.facet.codecs.facet42.Facet42DocValuesConsumer
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.
addCountingListData(Document, Map<String, BytesRef>, String) - Method in class org.apache.lucene.facet.index.FacetFields: Add the counting list data to the document under the given field.
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.
addFields(Document, Iterable<CategoryPath>) - Method in class org.apache.lucene.facet.associations.AssociationsFacetFields
addFields(Document, Iterable<CategoryPath>) - Method in class org.apache.lucene.facet.index.FacetFields: Adds the needed facet fields to the document.
addFields(Document, Iterable<CategoryPath>) - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetFields
addLabel(CategoryPath, 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) - 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
addNumericField(FieldInfo, Iterable<Number>) - Method in class org.apache.lucene.facet.codecs.facet42.Facet42DocValuesConsumer
addSiblings(int, int[], ArrayList<FacetResultNode>) - Method in class org.apache.lucene.facet.search.DepthOneFacetResultsHandler: Add the siblings of ordinal to the given list.
addSiblings(int, int[], PriorityQueue<FacetResultNode>) - Method in class org.apache.lucene.facet.search.DepthOneFacetResultsHandler: Add the siblings of ordinal to the given PriorityQueue.
addSiblings(int, int[], PriorityQueue<FacetResultNode>) - Method in class org.apache.lucene.facet.search.FloatFacetResultsHandler
addSiblings(int, int[], ArrayList<FacetResultNode>) - Method in class org.apache.lucene.facet.search.FloatFacetResultsHandler
addSiblings(int, int[], PriorityQueue<FacetResultNode>) - Method in class org.apache.lucene.facet.search.IntFacetResultsHandler
addSiblings(int, int[], ArrayList<FacetResultNode>) - Method in class org.apache.lucene.facet.search.IntFacetResultsHandler
addSortedField(FieldInfo, Iterable<BytesRef>, Iterable<Number>) - Method in class org.apache.lucene.facet.codecs.facet42.Facet42DocValuesConsumer
addSortedSetField(FieldInfo, Iterable<BytesRef>, Iterable<Number>, Iterable<Number>) - Method in class org.apache.lucene.facet.codecs.facet42.Facet42DocValuesConsumer
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.facet.collections.IntArray: Adds a value to the array.
aggregate(FacetsCollector.MatchingDocs, CategoryListParams, FacetArrays) - Method in class org.apache.lucene.facet.associations.MultiAssociationsFacetsAggregator
aggregate(FacetsCollector.MatchingDocs, CategoryListParams, FacetArrays) - Method in class org.apache.lucene.facet.associations.SumFloatAssociationFacetsAggregator
aggregate(FacetsCollector.MatchingDocs, CategoryListParams, FacetArrays) - Method in class org.apache.lucene.facet.associations.SumIntAssociationFacetsAggregator
aggregate(int, float, IntsRef) - Method in class org.apache.lucene.facet.complements.ComplementCountingAggregator
aggregate(int, float, IntsRef) - Method in interface org.apache.lucene.facet.search.Aggregator: Aggregate the ordinals of the given document ID (and its score).
aggregate(FacetsCollector.MatchingDocs, CategoryListParams, FacetArrays) - Method in class org.apache.lucene.facet.search.CachedOrdsCountingFacetsAggregator
aggregate(int, float, IntsRef) - Method in class org.apache.lucene.facet.search.CountingAggregator
aggregate(FacetsCollector.MatchingDocs, CategoryListParams, FacetArrays) - Method in class org.apache.lucene.facet.search.CountingFacetsAggregator
aggregate(FacetsCollector.MatchingDocs, CategoryListParams, FacetArrays) - Method in interface org.apache.lucene.facet.search.FacetsAggregator: Aggregate the facets found in the given matching documents.
aggregate(FacetsCollector.MatchingDocs, CategoryListParams, FacetArrays) - Method in class org.apache.lucene.facet.search.FastCountingFacetsAggregator
aggregate(FacetsCollector.MatchingDocs, CategoryListParams, FacetArrays) - Method in class org.apache.lucene.facet.search.IntRollupFacetsAggregator
aggregate(FacetsCollector.MatchingDocs, CategoryListParams, FacetArrays) - Method in class org.apache.lucene.facet.search.PerCategoryListAggregator
aggregate(int, float, IntsRef) - Method in class org.apache.lucene.facet.search.ScoringAggregator
aggregate(FacetsCollector.MatchingDocs, CategoryListParams, FacetArrays) - Method in class org.apache.lucene.facet.search.SumScoreFacetsAggregator
Aggregator - Interface in org.apache.lucene.facet.search: Aggregates the categories of documents given to Aggregator.aggregate(int, float, IntsRef).
allocateFloatArray() - Method in class org.apache.lucene.facet.search.ArraysPool: Allocates a new float[].
allocateIntArray() - Method in class org.apache.lucene.facet.search.ArraysPool: Allocates a new int[].
ArrayHashMap<K,V> - Class in org.apache.lucene.facet.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.facet.collections.ArrayHashMap: Constructs a map with default capacity.
ArrayHashMap(int) - Constructor for class org.apache.lucene.facet.collections.ArrayHashMap: Constructs a map with given capacity.
arrayLength - Variable in class org.apache.lucene.facet.search.ArraysPool
arrayLength - Variable in class org.apache.lucene.facet.search.FacetArrays
ArraysPool - Class in org.apache.lucene.facet.search: A thread-safe pool of int[] and float[] arrays.
ArraysPool(int, int) - Constructor for class org.apache.lucene.facet.search.ArraysPool: Specifies the max number of arrays to pool, as well as the length of each array to allocate.
ASSOCIATION_LIST_ID - Static variable in class org.apache.lucene.facet.associations.CategoryFloatAssociation
ASSOCIATION_LIST_ID - Static variable in class org.apache.lucene.facet.associations.CategoryIntAssociation
AssociationFloatSumFacetRequest - Class in org.apache.lucene.facet.associations: A FacetRequest for weighting facets according to their float association by summing the association values.
AssociationFloatSumFacetRequest(CategoryPath, int) - Constructor for class org.apache.lucene.facet.associations.AssociationFloatSumFacetRequest: Create a float association facet request for a given node in the taxonomy.
AssociationIntSumFacetRequest - Class in org.apache.lucene.facet.associations: A FacetRequest for weighting facets according to their integer association by summing the association values.
AssociationIntSumFacetRequest(CategoryPath, int) - Constructor for class org.apache.lucene.facet.associations.AssociationIntSumFacetRequest: Create an integer association facet request for a given node in the taxonomy.
AssociationsDrillDownStream - Class in org.apache.lucene.facet.associations: A DrillDownStream which adds to each drill-down token a payload according to the CategoryAssociation defined in the CategoryAssociationsContainer.
AssociationsDrillDownStream(CategoryAssociationsContainer, FacetIndexingParams) - Constructor for class org.apache.lucene.facet.associations.AssociationsDrillDownStream
AssociationsFacetFields - Class in org.apache.lucene.facet.associations: A utility class for adding facet fields to a document.
AssociationsFacetFields(TaxonomyWriter) - Constructor for class org.apache.lucene.facet.associations.AssociationsFacetFields: Constructs a new instance with the default facet indexing params.
AssociationsFacetFields(TaxonomyWriter, FacetIndexingParams) - Constructor for class org.apache.lucene.facet.associations.AssociationsFacetFields: Constructs a new instance with the given facet indexing params.
AssociationsListBuilder - Class in org.apache.lucene.facet.associations: A AssociationsListBuilder which encodes category-association value pairs.
AssociationsListBuilder(CategoryAssociationsContainer) - Constructor for class org.apache.lucene.facet.associations.AssociationsListBuilder

B

bits - Variable in class org.apache.lucene.facet.search.FacetsCollector.MatchingDocs
build(IntsRef, Iterable<CategoryPath>) - Method in class org.apache.lucene.facet.associations.AssociationsListBuilder
build(IntsRef, Iterable<CategoryPath>) - Method in interface org.apache.lucene.facet.index.CategoryListBuilder: Returns the encoded ordinals data.
build(IntsRef, Iterable<CategoryPath>) - Method in class org.apache.lucene.facet.index.CountingListBuilder: Every returned BytesRef corresponds to a single partition (as defined by FacetIndexingParams.getPartitionSize()) and the key denotes the partition ID.
buildFieldTermsMap(Directory, FacetIndexingParams) - Static method in class org.apache.lucene.facet.util.FacetsPayloadMigrationReader: A utility method for building the field-to-Term map, given the FacetIndexingParams and the directory of the index to migrate.

C

CachedOrdsCountingFacetsAggregator - Class in org.apache.lucene.facet.search: A FacetsAggregator which updates categories values by counting their occurrences in matching documents.
CachedOrdsCountingFacetsAggregator() - Constructor for class org.apache.lucene.facet.search.CachedOrdsCountingFacetsAggregator
calcBaseHashIndex(K) - Method in class org.apache.lucene.facet.collections.ArrayHashMap: Calculating the baseHash index using the internal internal hashFactor.
calcBaseHashIndex(float) - Method in class org.apache.lucene.facet.collections.FloatToObjectMap: Calculating the baseHash index using the internal hashFactor.
calcBaseHashIndex(int) - Method in class org.apache.lucene.facet.collections.IntHashSet: Calculating the baseHash index using the internal hashFactor .
calcBaseHashIndex(int) - Method in class org.apache.lucene.facet.collections.IntToDoubleMap: Calculating the baseHash index using the internal hashFactor .
calcBaseHashIndex(int) - Method in class org.apache.lucene.facet.collections.IntToFloatMap: Calculating the baseHash index using the internal hashFactor .
calcBaseHashIndex(int) - Method in class org.apache.lucene.facet.collections.IntToIntMap: Calculating the baseHash index using the internal hashFactor.
calcBaseHashIndex(int) - Method in class org.apache.lucene.facet.collections.IntToObjectMap: Calculating the baseHash index using the internal hashFactor.
calcBaseHashIndex(K) - Method in class org.apache.lucene.facet.collections.ObjectToFloatMap: Calculating the baseHash index using the internal hashFactor.
calcBaseHashIndex(K) - Method in class org.apache.lucene.facet.collections.ObjectToIntMap: Calculating the baseHash index using the internal hashFactor.
capacity() - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.CollisionMap
CategoryAssociation - Interface in org.apache.lucene.facet.associations: Allows associating an arbitrary value with a CategoryPath.
CategoryAssociationsContainer - Class in org.apache.lucene.facet.associations: Holds CategoryAssociation per CategoryPath.
CategoryAssociationsContainer() - Constructor for class org.apache.lucene.facet.associations.CategoryAssociationsContainer
CategoryFloatAssociation - Class in org.apache.lucene.facet.associations: A CategoryAssociation that associates a float with a category.
CategoryFloatAssociation() - Constructor for class org.apache.lucene.facet.associations.CategoryFloatAssociation
CategoryFloatAssociation(float) - Constructor for class org.apache.lucene.facet.associations.CategoryFloatAssociation
CategoryIntAssociation - Class in org.apache.lucene.facet.associations: A CategoryAssociation that associates an integer with a category.
CategoryIntAssociation() - Constructor for class org.apache.lucene.facet.associations.CategoryIntAssociation
CategoryIntAssociation(int) - Constructor for class org.apache.lucene.facet.associations.CategoryIntAssociation
CategoryListBuilder - Interface in org.apache.lucene.facet.index: Builds a category list data by encoding the appropriate information for every category and ordinal given to CategoryListBuilder.build(IntsRef, Iterable).
CategoryListIterator - Interface in org.apache.lucene.facet.search: An interface for obtaining the category ordinals of documents.
CategoryListParams - Class in org.apache.lucene.facet.params: Contains parameters for a category list *
CategoryListParams() - Constructor for class org.apache.lucene.facet.params.CategoryListParams: Constructs a default category list parameters object, using CategoryListParams.DEFAULT_FIELD.
CategoryListParams(String) - Constructor for class org.apache.lucene.facet.params.CategoryListParams: Constructs a category list parameters object, using the given field.
CategoryListParams.OrdinalPolicy - Enum in org.apache.lucene.facet.params: Defines which category ordinals are encoded for every document.
categoryPath - Variable in class org.apache.lucene.facet.search.FacetRequest
CategoryPath - Class in org.apache.lucene.facet.taxonomy: Holds a sequence of string components, specifying the hierarchical name of a category.
CategoryPath(String...) - Constructor for class org.apache.lucene.facet.taxonomy.CategoryPath: Construct from the given path components.
CategoryPath(String, char) - Constructor for class org.apache.lucene.facet.taxonomy.CategoryPath: Construct from a given path, separating path components with delimiter.
children() - Method in class org.apache.lucene.facet.taxonomy.ParallelTaxonomyArrays: Returns the children array, where children[i] denotes a child of category ordinal i.
ChunksIntEncoder - Class in org.apache.lucene.facet.encoding: An IntEncoder which encodes values in chunks.
ChunksIntEncoder(int) - Constructor for class org.apache.lucene.facet.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 class org.apache.lucene.facet.associations.CategoryAssociationsContainer: Clears all category associations.
clear() - Method in class org.apache.lucene.facet.collections.ArrayHashMap: Empties the map.
clear() - Method in class org.apache.lucene.facet.collections.FloatToObjectMap: Empties the map.
clear(boolean) - Method in class org.apache.lucene.facet.collections.IntArray: Clear the IntArray (set all elements to zero).
clear() - Method in class org.apache.lucene.facet.collections.IntHashSet: Empties the map.
clear() - Method in class org.apache.lucene.facet.collections.IntToDoubleMap: Empties the map.
clear() - Method in class org.apache.lucene.facet.collections.IntToFloatMap: Empties the map.
clear() - Method in class org.apache.lucene.facet.collections.IntToIntMap: Empties the map.
clear() - Method in class org.apache.lucene.facet.collections.IntToObjectMap: Empties the map.
clear() - Method in class org.apache.lucene.facet.collections.ObjectToFloatMap: Empties the map.
clear() - Method in class org.apache.lucene.facet.collections.ObjectToIntMap: Empties the map.
clear() - Method in class org.apache.lucene.facet.complements.TotalFacetCountsCache: Clear the cache.
clear() - Method in interface org.apache.lucene.facet.search.Heap: Clear the heap
clear() - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.Cl2oTaxonomyWriterCache
clear() - Method in class org.apache.lucene.facet.taxonomy.writercache.lru.LruTaxonomyWriterCache
clear() - Method in interface org.apache.lucene.facet.taxonomy.writercache.TaxonomyWriterCache: Clears the content of the cache.
clone() - Method in class org.apache.lucene.facet.collections.LRUHashMap
clone() - Method in class org.apache.lucene.facet.search.DrillDownQuery
close() - Method in class org.apache.lucene.facet.codecs.facet42.Facet42DocValuesConsumer
close() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Frees used resources as well as closes the underlying IndexWriter, which commits whatever changes made to it to the underlying Directory.
close() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader
close() - Method in class org.apache.lucene.facet.taxonomy.writercache.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.
closeResources() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: A hook for extending classes to close additional resources that were used.
clParams - Variable in class org.apache.lucene.facet.params.FacetIndexingParams
CODEC - Static variable in class org.apache.lucene.facet.codecs.facet42.Facet42DocValuesFormat
CollisionMap - Class in org.apache.lucene.facet.taxonomy.writercache.cl2o: HashMap to store colliding labels.
commit() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
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 path with another CategoryPath for lexicographic order.
ComplementCountingAggregator - Class in org.apache.lucene.facet.complements: A CountingAggregator used during complement counting.
ComplementCountingAggregator(int[]) - Constructor for class org.apache.lucene.facet.complements.ComplementCountingAggregator
components - Variable in class org.apache.lucene.facet.taxonomy.CategoryPath: The components of this CategoryPath.
compute() - Method in class org.apache.lucene.facet.partitions.PartitionsFacetResultsHandler
compute() - Method in class org.apache.lucene.facet.search.DepthOneFacetResultsHandler
compute() - Method in class org.apache.lucene.facet.search.FacetResultsHandler: Computes the FacetResult for the given FacetArrays.
contains(int) - Method in class org.apache.lucene.facet.collections.IntHashSet: Checks if a given key exists in the map.
containsKey(K) - Method in class org.apache.lucene.facet.collections.ArrayHashMap: Returns true iff the key exists in the map.
containsKey(float) - Method in class org.apache.lucene.facet.collections.FloatToObjectMap: Checks if a given key exists in the map.
containsKey(int) - Method in class org.apache.lucene.facet.collections.IntToDoubleMap: Checks if a given key exists in the map.
containsKey(int) - Method in class org.apache.lucene.facet.collections.IntToFloatMap: Checks if a given key exists in the map.
containsKey(int) - Method in class org.apache.lucene.facet.collections.IntToIntMap: Checks if a given key exists in the map.
containsKey(int) - Method in class org.apache.lucene.facet.collections.IntToObjectMap: Checks if a given key exists in the map.
containsKey(K) - Method in class org.apache.lucene.facet.collections.ObjectToFloatMap: Checks if a given key exists in the map.
containsKey(K) - Method in class org.apache.lucene.facet.collections.ObjectToIntMap: Checks if a given key exists in the map.
containsValue(Object) - Method in class org.apache.lucene.facet.collections.ArrayHashMap: Returns true iff the object exists in the map.
containsValue(Object) - Method in class org.apache.lucene.facet.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.facet.collections.IntToDoubleMap: Checks if the given value exists in the map.
This method iterates over the collection, trying to find an equal object.
containsValue(float) - Method in class org.apache.lucene.facet.collections.IntToFloatMap: 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.facet.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.facet.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.facet.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.facet.collections.ObjectToIntMap: Checks if the given object exists in the map.
This method iterates over the collection, trying to find an equal object.
context - Variable in class org.apache.lucene.facet.search.FacetsCollector.MatchingDocs
copyFullPath(char[], int, char) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath: Copies the path components to the given char[], starting at index start.
counter - Variable in class org.apache.lucene.facet.taxonomy.writercache.cl2o.LabelToOrdinal
counterArray - Variable in class org.apache.lucene.facet.search.CountingAggregator
CountFacetRequest - Class in org.apache.lucene.facet.search: Facet request for counting facets.
CountFacetRequest(CategoryPath, int) - Constructor for class org.apache.lucene.facet.search.CountFacetRequest
CountingAggregator - Class in org.apache.lucene.facet.search: 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.CountingAggregator
CountingFacetsAggregator - Class in org.apache.lucene.facet.search: A FacetsAggregator which counts the number of times each category appears in the given set of documents.
CountingFacetsAggregator() - Constructor for class org.apache.lucene.facet.search.CountingFacetsAggregator
CountingListBuilder - Class in org.apache.lucene.facet.index: A CategoryListBuilder which builds a counting list data by encoding the category ordinals into one or more BytesRef.
CountingListBuilder(CategoryListParams, FacetIndexingParams, TaxonomyWriter) - Constructor for class org.apache.lucene.facet.index.CountingListBuilder
create(FacetSearchParams, IndexReader, TaxonomyReader) - Static method in class org.apache.lucene.facet.search.FacetsAccumulator: Creates an appropriate FacetsAccumulator, returning FacetsAccumulator when all requests are CountFacetRequest and only one partition is in use, otherwise StandardFacetsAccumulator.
create(FacetSearchParams, IndexReader, TaxonomyReader) - Static method in class org.apache.lucene.facet.search.FacetsCollector: Creates a FacetsCollector using the FacetsAccumulator from FacetsAccumulator.create(org.apache.lucene.facet.params.FacetSearchParams, org.apache.lucene.index.IndexReader, org.apache.lucene.facet.taxonomy.TaxonomyReader).
create(FacetsAccumulator) - Static method in class org.apache.lucene.facet.search.FacetsCollector: Creates a FacetsCollector that satisfies the requirements of the given FacetsAccumulator.
createAggregator(boolean, FacetArrays, TaxonomyReader) - Method in class org.apache.lucene.facet.search.CountFacetRequest
createAggregator(boolean, FacetArrays, TaxonomyReader) - Method in class org.apache.lucene.facet.search.FacetRequest: Create an aggregator for this facet request.
createAggregator(boolean, FacetArrays, TaxonomyReader) - Method in class org.apache.lucene.facet.search.SumScoreFacetRequest
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(int) - Method in class org.apache.lucene.facet.params.CategoryListParams: Create the CategoryListIterator for the specified partition.
createCategoryListMapping(Iterable<CategoryPath>) - Method in class org.apache.lucene.facet.associations.AssociationsFacetFields
createCategoryListMapping(Iterable<CategoryPath>) - Method in class org.apache.lucene.facet.index.FacetFields: Creates a mapping between a CategoryListParams and all categories that are associated with it.
createEncoder() - Method in class org.apache.lucene.facet.params.CategoryListParams: Allows to override how categories are encoded and decoded.
createFacetResultsHandler(FacetRequest) - Method in class org.apache.lucene.facet.search.FacetsAccumulator: Creates a FacetResultsHandler that matches the given FacetRequest.
createFacetResultsHandler(FacetRequest) - Method in class org.apache.lucene.facet.search.StandardFacetsAccumulator
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.facet.encoding.DGapIntEncoder
createMatchingDecoder() - Method in class org.apache.lucene.facet.encoding.DGapVInt8IntEncoder
createMatchingDecoder() - Method in class org.apache.lucene.facet.encoding.EightFlagsIntEncoder
createMatchingDecoder() - Method in class org.apache.lucene.facet.encoding.FourFlagsIntEncoder
createMatchingDecoder() - Method in class org.apache.lucene.facet.encoding.IntEncoder: Returns an IntDecoder which can decode the values that were encoded with this encoder.
createMatchingDecoder() - Method in class org.apache.lucene.facet.encoding.NOnesIntEncoder
createMatchingDecoder() - Method in class org.apache.lucene.facet.encoding.SimpleIntEncoder
createMatchingDecoder() - Method in class org.apache.lucene.facet.encoding.SortingIntEncoder
createMatchingDecoder() - Method in class org.apache.lucene.facet.encoding.UniqueValuesIntEncoder
createMatchingDecoder() - Method in class org.apache.lucene.facet.encoding.VInt8IntEncoder
createSample(ScoredDocIDs, int, int) - Method in class org.apache.lucene.facet.sampling.RandomSampler
createSample(ScoredDocIDs, int, int) - Method in class org.apache.lucene.facet.sampling.RepeatableSampler
createSample(ScoredDocIDs, int, int) - Method in class org.apache.lucene.facet.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(BytesRef, IntsRef) - Method in class org.apache.lucene.facet.encoding.DGapIntDecoder
decode(BytesRef, IntsRef) - Method in class org.apache.lucene.facet.encoding.DGapVInt8IntDecoder
decode(BytesRef, IntsRef) - Method in class org.apache.lucene.facet.encoding.EightFlagsIntDecoder
decode(BytesRef, IntsRef) - Method in class org.apache.lucene.facet.encoding.FourFlagsIntDecoder
decode(BytesRef, IntsRef) - Method in class org.apache.lucene.facet.encoding.IntDecoder: Decodes the values from the buffer into the given IntsRef.
decode(BytesRef, IntsRef) - Method in class org.apache.lucene.facet.encoding.NOnesIntDecoder
decode(BytesRef, IntsRef) - Method in class org.apache.lucene.facet.encoding.SimpleIntDecoder
decode(BytesRef, IntsRef) - Method in class org.apache.lucene.facet.encoding.VInt8IntDecoder
decRef(SearcherTaxonomyManager.SearcherAndTaxonomy) - Method in class org.apache.lucene.facet.search.SearcherTaxonomyManager
decRef() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Expert: decreases the refCount of this TaxonomyReader instance.
DEFAULT - Static variable in class org.apache.lucene.facet.params.FacetIndexingParams: A FacetIndexingParams which fixes a single CategoryListParams with CategoryListParams.DEFAULT_ORDINAL_POLICY.
DEFAULT_CACHE_SIZE - Static variable in class org.apache.lucene.facet.complements.TotalFacetCountsCache: Default size of in memory cache for computed total facet counts.
DEFAULT_CATEGORY_LIST_PARAMS - Static variable in class org.apache.lucene.facet.params.FacetIndexingParams
DEFAULT_COMPLEMENT_THRESHOLD - Static variable in class org.apache.lucene.facet.search.StandardFacetsAccumulator: Default threshold for using the complements optimization.
DEFAULT_DEPTH - Static variable in class org.apache.lucene.facet.search.FacetRequest: Default depth for facets accumulation.
DEFAULT_FACET_DELIM_CHAR - Static variable in class org.apache.lucene.facet.params.FacetIndexingParams: The default delimiter with which CategoryPath.components are concatenated when written to the index, e.g.
DEFAULT_FIELD - Static variable in class org.apache.lucene.facet.params.CategoryListParams: The default field used to store the facets information.
DEFAULT_MAX_SAMPLE_SIZE - Static variable in class org.apache.lucene.facet.sampling.SamplingParams: Default maximum size of sample.
DEFAULT_MIN_SAMPLE_SIZE - Static variable in class org.apache.lucene.facet.sampling.SamplingParams: Default minimum size of sample.
DEFAULT_ORDINAL_POLICY - Static variable in class org.apache.lucene.facet.params.CategoryListParams: The default CategoryListParams.OrdinalPolicy that's used when encoding a document's category ordinals.
DEFAULT_OVERSAMPLE_FACTOR - Static variable in class org.apache.lucene.facet.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.FacetRequest: Default result mode
DEFAULT_SAMPLE_RATIO - Static variable in class org.apache.lucene.facet.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.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.
DefaultLoadFactor - Static variable in class org.apache.lucene.facet.taxonomy.writercache.cl2o.CompactLabelToOrdinal
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.
DepthOneFacetResultsHandler - Class in org.apache.lucene.facet.search: A FacetResultsHandler which counts the top-K facets at depth 1 only and always labels all result categories.
DepthOneFacetResultsHandler(TaxonomyReader, FacetRequest, FacetArrays) - Constructor for class org.apache.lucene.facet.search.DepthOneFacetResultsHandler
deserialize(ByteArrayDataInput) - Method in interface org.apache.lucene.facet.associations.CategoryAssociation: Deserializes the association value from the given DataInput.
deserialize(ByteArrayDataInput) - Method in class org.apache.lucene.facet.associations.CategoryFloatAssociation
deserialize(ByteArrayDataInput) - Method in class org.apache.lucene.facet.associations.CategoryIntAssociation
DGapIntDecoder - Class in org.apache.lucene.facet.encoding: An IntDecoder which wraps another decoder and reverts the d-gap that was encoded by DGapIntEncoder.
DGapIntDecoder(IntDecoder) - Constructor for class org.apache.lucene.facet.encoding.DGapIntDecoder
DGapIntEncoder - Class in org.apache.lucene.facet.encoding: An IntEncoderFilter which encodes the gap between the given values, rather than the values themselves.
DGapIntEncoder(IntEncoder) - Constructor for class org.apache.lucene.facet.encoding.DGapIntEncoder: Initializes with the given encoder.
DGapVInt8IntDecoder - Class in org.apache.lucene.facet.encoding: Decodes values encoded by DGapVInt8IntDecoder.
DGapVInt8IntDecoder() - Constructor for class org.apache.lucene.facet.encoding.DGapVInt8IntDecoder
DGapVInt8IntEncoder - Class in org.apache.lucene.facet.encoding: An IntEncoder which implements variable length encoding for the gap between values.
DGapVInt8IntEncoder() - Constructor for class org.apache.lucene.facet.encoding.DGapVInt8IntEncoder
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.
DirectoryTaxonomyReader(DirectoryTaxonomyWriter) - Constructor for class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader: Opens a DirectoryTaxonomyReader over the given DirectoryTaxonomyWriter (for NRT).
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 cache 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.StandardFacetsAccumulator: Passing this to StandardFacetsAccumulator.setComplementThreshold(double) will disable using complement optimization.
docids - Variable in class org.apache.lucene.facet.sampling.Sampler.SampleResult
doClose() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
doClose() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: performs the actual task of closing the resources that are used by the taxonomy reader.
DocValuesCategoryListIterator - Class in org.apache.lucene.facet.search: A CategoryListIterator which reads the ordinals from a BinaryDocValues.
DocValuesCategoryListIterator(String, IntDecoder) - Constructor for class org.apache.lucene.facet.search.DocValuesCategoryListIterator: Constructs a new DocValuesCategoryListIterator.
doFree(float[], int[]) - Method in class org.apache.lucene.facet.search.FacetArrays
doFree(float[], int[]) - Method in class org.apache.lucene.facet.search.ReusingFacetArrays
doOpenIfChanged() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader: Implements the opening of a new DirectoryTaxonomyReader instance if the taxonomy has changed.
doOpenIfChanged() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Implements the actual opening of a new TaxonomyReader instance if the taxonomy has changed.
doSetNextReader(AtomicReaderContext) - Method in class org.apache.lucene.facet.search.FacetsCollector: Performs the actual work of FacetsCollector.setNextReader(AtomicReaderContext).
DoubleIterator - Interface in org.apache.lucene.facet.collections: Iterator interface for primitive double iteration.
drillDownFieldType() - Method in class org.apache.lucene.facet.associations.AssociationsFacetFields
drillDownFieldType() - Method in class org.apache.lucene.facet.index.FacetFields: Returns the FieldType with which the drill-down terms should be indexed.
DrillDownQuery - Class in org.apache.lucene.facet.search: A Query for drill-down over categories.
DrillDownQuery(FacetIndexingParams) - Constructor for class org.apache.lucene.facet.search.DrillDownQuery: Creates a new DrillDownQuery without a base query, to perform a pure browsing query (equivalent to using MatchAllDocsQuery as base).
DrillDownQuery(FacetIndexingParams, Query) - Constructor for class org.apache.lucene.facet.search.DrillDownQuery: Creates a new DrillDownQuery over the given base query.
DrillDownStream - Class in org.apache.lucene.facet.index: A TokenStream which creates category drill-down terms.
DrillDownStream(Iterable<CategoryPath>, FacetIndexingParams) - Constructor for class org.apache.lucene.facet.index.DrillDownStream
drillDownTermText(CategoryPath, char[]) - Method in class org.apache.lucene.facet.params.FacetIndexingParams: Copies the text required to execute a drill-down query on the given category to the given char[], and returns the number of characters that were written.
DrillSideways - Class in org.apache.lucene.facet.search: Computes drill down and sideways counts for the provided DrillDownQuery.
DrillSideways(IndexSearcher, TaxonomyReader) - Constructor for class org.apache.lucene.facet.search.DrillSideways: Create a new DrillSideways instance.
DrillSideways.DrillSidewaysResult - Class in org.apache.lucene.facet.search: Represents the returned result from a drill sideways search.

E

EightFlagsIntDecoder - Class in org.apache.lucene.facet.encoding: Decodes values encoded with EightFlagsIntEncoder.
EightFlagsIntDecoder() - Constructor for class org.apache.lucene.facet.encoding.EightFlagsIntDecoder
EightFlagsIntEncoder - Class in org.apache.lucene.facet.encoding: A ChunksIntEncoder which encodes data in chunks of 8.
EightFlagsIntEncoder() - Constructor for class org.apache.lucene.facet.encoding.EightFlagsIntEncoder
EMPTY - Static variable in class org.apache.lucene.facet.taxonomy.CategoryPath: An empty CategoryPath
EMPTY_SUB_RESULTS - Static variable in class org.apache.lucene.facet.search.FacetResultNode
emptyResult(int, FacetRequest) - Static method in class org.apache.lucene.facet.search.FacetsAccumulator: Returns an empty FacetResult.
encode(IntsRef, BytesRef) - Method in class org.apache.lucene.facet.encoding.DGapIntEncoder
encode(IntsRef, BytesRef) - Method in class org.apache.lucene.facet.encoding.DGapVInt8IntEncoder
encode(IntsRef, BytesRef) - Method in class org.apache.lucene.facet.encoding.EightFlagsIntEncoder
encode(IntsRef, BytesRef) - Method in class org.apache.lucene.facet.encoding.FourFlagsIntEncoder
encode(IntsRef, BytesRef) - Method in class org.apache.lucene.facet.encoding.IntEncoder: Encodes the values to the given buffer.
encode(IntsRef, BytesRef) - Method in class org.apache.lucene.facet.encoding.NOnesIntEncoder
encode(IntsRef, BytesRef) - Method in class org.apache.lucene.facet.encoding.SimpleIntEncoder
encode(IntsRef, BytesRef) - Method in class org.apache.lucene.facet.encoding.SortingIntEncoder
encode(IntsRef, BytesRef) - Method in class org.apache.lucene.facet.encoding.UniqueValuesIntEncoder
encode(IntsRef, BytesRef) - Method in class org.apache.lucene.facet.encoding.VInt8IntEncoder
encodeChunk(BytesRef) - Method in class org.apache.lucene.facet.encoding.ChunksIntEncoder: Encodes the values of the current chunk.
encodeQueue - Variable in class org.apache.lucene.facet.encoding.ChunksIntEncoder: Holds the values which must be encoded, outside the indicator.
encoder - Variable in class org.apache.lucene.facet.encoding.IntEncoderFilter
ensureOpen() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Verifies that this instance wasn't closed, or throws AlreadyClosedException if it is.
ensureOpen() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader
equals(Object) - Method in class org.apache.lucene.facet.collections.ArrayHashMap
equals(Object) - Method in class org.apache.lucene.facet.collections.FloatToObjectMap
equals(Object) - Method in class org.apache.lucene.facet.collections.IntArray: Equals method.
equals(Object) - Method in class org.apache.lucene.facet.collections.IntToDoubleMap
equals(Object) - Method in class org.apache.lucene.facet.collections.IntToFloatMap
equals(Object) - Method in class org.apache.lucene.facet.collections.IntToIntMap
equals(Object) - Method in class org.apache.lucene.facet.collections.IntToObjectMap
equals(Object) - Method in class org.apache.lucene.facet.collections.ObjectToFloatMap
equals(Object) - Method in class org.apache.lucene.facet.collections.ObjectToIntMap
equals(Object) - Method in class org.apache.lucene.facet.params.CategoryListParams
equals(Object) - Method in class org.apache.lucene.facet.params.FacetIndexingParams
equals(Object) - Method in class org.apache.lucene.facet.search.CountingAggregator
equals(Object) - Method in class org.apache.lucene.facet.search.DocValuesCategoryListIterator
equals(Object) - Method in class org.apache.lucene.facet.search.DrillDownQuery
equals(Object) - Method in class org.apache.lucene.facet.search.FacetRequest
equals(Object) - Method in class org.apache.lucene.facet.search.ScoringAggregator
equals(Object) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
EXTENSION - Static variable in class org.apache.lucene.facet.codecs.facet42.Facet42DocValuesFormat

F

Facet42Codec - Class in org.apache.lucene.facet.codecs.facet42: Same as Lucene42Codec except it uses Facet42DocValuesFormat for facet fields (faster-but-more-RAM-consuming doc values).
Facet42Codec() - Constructor for class org.apache.lucene.facet.codecs.facet42.Facet42Codec: Default constructor, uses FacetIndexingParams.DEFAULT.
Facet42Codec(FacetIndexingParams) - Constructor for class org.apache.lucene.facet.codecs.facet42.Facet42Codec: Initializes with the given FacetIndexingParams.
Facet42DocValuesConsumer - Class in org.apache.lucene.facet.codecs.facet42: Writer for Facet42DocValuesFormat.
Facet42DocValuesConsumer(SegmentWriteState) - Constructor for class org.apache.lucene.facet.codecs.facet42.Facet42DocValuesConsumer
Facet42DocValuesConsumer(SegmentWriteState, float) - Constructor for class org.apache.lucene.facet.codecs.facet42.Facet42DocValuesConsumer
Facet42DocValuesFormat - Class in org.apache.lucene.facet.codecs.facet42: DocValues format that only handles binary doc values and is optimized for usage with facets.
Facet42DocValuesFormat() - Constructor for class org.apache.lucene.facet.codecs.facet42.Facet42DocValuesFormat
FACET_FIELD_EXTENSION - Static variable in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Extension added to CategoryListParams.field to determin which field to read/write facet ordinals from/to.
FacetArrays - Class in org.apache.lucene.facet.search: Provider of arrays used for facets aggregation.
FacetArrays(int) - Constructor for class org.apache.lucene.facet.search.FacetArrays: Arrays will be allocated at the specified length.
facetArrays - Variable in class org.apache.lucene.facet.search.FacetResultsHandler
facetArrays - Variable in class org.apache.lucene.facet.search.FacetsAccumulator
FacetFields - Class in org.apache.lucene.facet.index: A utility class for adding facet fields to a document.
FacetFields(TaxonomyWriter) - Constructor for class org.apache.lucene.facet.index.FacetFields: Constructs a new instance with the default facet indexing params.
FacetFields(TaxonomyWriter, FacetIndexingParams) - Constructor for class org.apache.lucene.facet.index.FacetFields: Constructs a new instance with the given facet indexing params.
FacetIndexingParams - Class in org.apache.lucene.facet.params: Defines parameters that are needed for facets indexing.
FacetIndexingParams() - Constructor for class org.apache.lucene.facet.params.FacetIndexingParams: Initializes new default params.
FacetIndexingParams(CategoryListParams) - Constructor for class org.apache.lucene.facet.params.FacetIndexingParams: Initializes new params with the given CategoryListParams.
FacetPackage - Class in org.apache.lucene.facet: Required so that userguide files are copied as part of javadocs generation.
FacetRequest - Class in org.apache.lucene.facet.search: 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.FacetRequest: Initialize the request with a given path, and a requested number of facets results.
facetRequest - Variable in class org.apache.lucene.facet.search.FacetResultsHandler
FacetRequest.FacetArraysSource - Enum in org.apache.lucene.facet.search: Specifies which array of FacetArrays should be used to resolve values.
FacetRequest.ResultMode - Enum in org.apache.lucene.facet.search: Result structure manner of applying request's limits such as FacetRequest.getNumLabel() and FacetRequest.numResults.
FacetRequest.SortOrder - Enum in org.apache.lucene.facet.search: Requested sort order for the results.
facetRequests - Variable in class org.apache.lucene.facet.params.FacetSearchParams
FacetResult - Class in org.apache.lucene.facet.search: Result of faceted search.
FacetResult(FacetRequest, FacetResultNode, int) - Constructor for class org.apache.lucene.facet.search.FacetResult
FacetResultNode - Class in org.apache.lucene.facet.search: Result of faceted search for a certain taxonomy node.
FacetResultNode(int, double) - Constructor for class org.apache.lucene.facet.search.FacetResultNode
facetResults - Variable in class org.apache.lucene.facet.search.DrillSideways.DrillSidewaysResult: Combined drill down & sideways results.
FacetResultsHandler - Class in org.apache.lucene.facet.search: Computes the top categories for a given FacetRequest.
FacetResultsHandler(TaxonomyReader, FacetRequest, FacetArrays) - Constructor for class org.apache.lucene.facet.search.FacetResultsHandler
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: Initializes the accumulator with the given search params, index reader and taxonomy reader.
FacetsAccumulator(FacetSearchParams, IndexReader, TaxonomyReader, FacetArrays) - Constructor for class org.apache.lucene.facet.search.FacetsAccumulator: Initializes the accumulator with the given parameters as well as FacetArrays.
FacetsAggregator - Interface in org.apache.lucene.facet.search: Aggregates categories that were found in result documents (specified by FacetsCollector.MatchingDocs).
FacetsCollector - Class in org.apache.lucene.facet.search: A Collector which executes faceted search and computes the weight of requested facets.
FacetsCollector(FacetsAccumulator) - Constructor for class org.apache.lucene.facet.search.FacetsCollector
FacetsCollector.MatchingDocs - Class in org.apache.lucene.facet.search: Holds the documents that were matched in the AtomicReaderContext.
FacetsCollector.MatchingDocs(AtomicReaderContext, FixedBitSet, int, float[]) - Constructor for class org.apache.lucene.facet.search.FacetsCollector.MatchingDocs
FacetSearchParams - Class in org.apache.lucene.facet.params: Defines parameters that are needed for faceted search.
FacetSearchParams(FacetRequest...) - Constructor for class org.apache.lucene.facet.params.FacetSearchParams: Initializes with the given requests and default FacetIndexingParams.DEFAULT.
FacetSearchParams(List<FacetRequest>) - Constructor for class org.apache.lucene.facet.params.FacetSearchParams: Initializes with the given requests and default FacetIndexingParams.DEFAULT.
FacetSearchParams(FacetIndexingParams, FacetRequest...) - Constructor for class org.apache.lucene.facet.params.FacetSearchParams: Initializes with the given requests and FacetIndexingParams.
FacetSearchParams(FacetIndexingParams, List<FacetRequest>) - Constructor for class org.apache.lucene.facet.params.FacetSearchParams: Initializes with the given requests and FacetIndexingParams.
FacetsPayloadMigrationReader - Class in org.apache.lucene.facet.util: A FilterAtomicReader for migrating a facets index which encodes category ordinals in a payload to BinaryDocValues.
FacetsPayloadMigrationReader(AtomicReader, Map<String, Term>) - Constructor for class org.apache.lucene.facet.util.FacetsPayloadMigrationReader: Wraps an AtomicReader and migrates the payload to BinaryDocValues fields by using the given mapping.
FastCountingFacetsAggregator - Class in org.apache.lucene.facet.search: A FacetsAggregator which counts the number of times each category appears in the given set of documents.
FastCountingFacetsAggregator() - Constructor for class org.apache.lucene.facet.search.FastCountingFacetsAggregator
fetchPartitionResult(int) - Method in class org.apache.lucene.facet.partitions.PartitionsFacetResultsHandler: Fetch results of a single partition, given facet arrays for that partition, and based on the matching documents and faceted search parameters.
fetchPartitionResult(int) - Method in class org.apache.lucene.facet.search.TopKFacetResultsHandler
fetchPartitionResult(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.params.CategoryListParams
fieldsConsumer(SegmentWriteState) - Method in class org.apache.lucene.facet.codecs.facet42.Facet42DocValuesFormat
fieldsProducer(SegmentReadState) - Method in class org.apache.lucene.facet.codecs.facet42.Facet42DocValuesFormat
fillTotalCountsForPartition(int[], int) - Method in class org.apache.lucene.facet.complements.TotalFacetCounts: Fill a partition's array with the TotalCountsArray values.
find(K) - Method in class org.apache.lucene.facet.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.facet.collections.FloatToObjectMap: Find the actual index of a given key.
find(int) - Method in class org.apache.lucene.facet.collections.IntHashSet: Find the actual index of a given key.
find(int) - Method in class org.apache.lucene.facet.collections.IntToDoubleMap: Find the actual index of a given key.
find(int) - Method in class org.apache.lucene.facet.collections.IntToFloatMap: Find the actual index of a given key.
find(int) - Method in class org.apache.lucene.facet.collections.IntToIntMap: Find the actual index of a given key.
find(int) - Method in class org.apache.lucene.facet.collections.IntToObjectMap: Find the actual index of a given key.
find(K) - Method in class org.apache.lucene.facet.collections.ObjectToFloatMap: Find the actual index of a given key.
find(K) - Method in class org.apache.lucene.facet.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.
finish() - Method in class org.apache.lucene.facet.search.FacetsCollector: Called when the Collector has finished, so that the last FacetsCollector.MatchingDocs can be added.
fixResult(ScoredDocIDs, FacetResult) - Method in interface org.apache.lucene.facet.sampling.SampleFixer: Alter the input result, fixing it to account for the sampling.
FloatFacetResultsHandler - Class in org.apache.lucene.facet.search: A DepthOneFacetResultsHandler which fills the categories values from FacetArrays.getFloatArray().
FloatFacetResultsHandler(TaxonomyReader, FacetRequest, FacetArrays) - Constructor for class org.apache.lucene.facet.search.FloatFacetResultsHandler
FloatIterator - Interface in org.apache.lucene.facet.collections: Iterator interface for primitive int iteration.
FloatToObjectMap<T> - Class in org.apache.lucene.facet.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.facet.collections.FloatToObjectMap: Constructs a map with default capacity.
FloatToObjectMap(int) - Constructor for class org.apache.lucene.facet.collections.FloatToObjectMap: Constructs a map with given capacity.
FORCE_COMPLEMENT - Static variable in class org.apache.lucene.facet.search.StandardFacetsAccumulator: Passing this to StandardFacetsAccumulator.setComplementThreshold(double) will force using complement optimization.
FourFlagsIntDecoder - Class in org.apache.lucene.facet.encoding: Decodes values encoded with FourFlagsIntEncoder.
FourFlagsIntDecoder() - Constructor for class org.apache.lucene.facet.encoding.FourFlagsIntDecoder
FourFlagsIntEncoder - Class in org.apache.lucene.facet.encoding: A ChunksIntEncoder which encodes values in chunks of 4.
FourFlagsIntEncoder() - Constructor for class org.apache.lucene.facet.encoding.FourFlagsIntEncoder
free(int[]) - Method in class org.apache.lucene.facet.search.ArraysPool: Frees a no-longer-needed array.
free(float[]) - Method in class org.apache.lucene.facet.search.ArraysPool: Frees a no-longer-needed array.
free() - Method in class org.apache.lucene.facet.search.FacetArrays: Notifies that the arrays obtained from FacetArrays.getIntArray() or FacetArrays.getFloatArray() are no longer needed and can be freed.
fullPathLength() - Method in class org.apache.lucene.facet.taxonomy.CategoryPath: Returns the number of characters needed to represent the path, including delimiter characters, for using with CategoryPath.copyFullPath(char[], int, char).

G

get(K) - Method in class org.apache.lucene.facet.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.facet.collections.FloatToObjectMap: Returns the object mapped with the given key.
get(int) - Method in class org.apache.lucene.facet.collections.IntArray: Get an element from a specific index.
get(int) - Method in class org.apache.lucene.facet.collections.IntToDoubleMap: Returns the value mapped with the given key.
get(int) - Method in class org.apache.lucene.facet.collections.IntToFloatMap: Returns the value mapped with the given key.
get(int) - Method in class org.apache.lucene.facet.collections.IntToIntMap: Returns the object mapped with the given key.
get(int) - Method in class org.apache.lucene.facet.collections.IntToObjectMap: Returns the object mapped with the given key.
get(K) - Method in class org.apache.lucene.facet.collections.ObjectToFloatMap: Returns the float mapped with the given key.
get(K) - Method in class org.apache.lucene.facet.collections.ObjectToIntMap: Returns the int mapped with the given key.
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.CollisionMap
get(CategoryPath) - 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.
getAggregator() - Method in class org.apache.lucene.facet.search.FacetsAccumulator: Returns the FacetsAggregator to use for aggregating the categories found in the result documents.
getAggregator() - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesAccumulator
getAllCategoryListParams() - Method in class org.apache.lucene.facet.params.FacetIndexingParams: Returns a list of all categoryListParams that are used for facets indexing.
getAllCategoryListParams() - Method in class org.apache.lucene.facet.params.PerDimensionIndexingParams
getAssociation(CategoryPath) - Method in class org.apache.lucene.facet.associations.CategoryAssociationsContainer: Returns the CategoryAssociation that was set for the category, or null if none was defined.
getBinaryDocValues(String) - Method in class org.apache.lucene.facet.util.FacetsPayloadMigrationReader
getBinaryDocValues(String) - Method in class org.apache.lucene.facet.util.OrdinalMappingAtomicReader
getCachedOrds(AtomicReaderContext, CategoryListParams) - Static method in class org.apache.lucene.facet.search.OrdinalsCache: Returns the OrdinalsCache.CachedOrds relevant to the given AtomicReaderContext, or null if there is no BinaryDocValues in this reader for the requested CategoryListParams.field.
getCacheSize() - Method in class org.apache.lucene.facet.complements.TotalFacetCountsCache
getCategoryListData(CategoryListParams, IntsRef, Iterable<CategoryPath>) - Method in class org.apache.lucene.facet.associations.AssociationsFacetFields
getCategoryListData(CategoryListParams, IntsRef, Iterable<CategoryPath>) - Method in class org.apache.lucene.facet.index.FacetFields: Returns the category list data, as a mapping from key to BytesRef which includes the encoded data.
getCategoryListID() - Method in interface org.apache.lucene.facet.associations.CategoryAssociation: Returns the ID of the category association.
getCategoryListID() - Method in class org.apache.lucene.facet.associations.CategoryFloatAssociation
getCategoryListID() - Method in class org.apache.lucene.facet.associations.CategoryIntAssociation
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.params.FacetIndexingParams: Returns the CategoryListParams for this CategoryPath.
getCategoryListParams(CategoryPath) - Method in class org.apache.lucene.facet.params.PerDimensionIndexingParams: Returns the CategoryListParams for the corresponding dimension which is returned by category.getComponent(0).
getCategoryLists() - Method in class org.apache.lucene.facet.search.FacetsAccumulator
getChildren(int) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Returns an iterator over the children of the given ordinal.
getCommitData() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
getCommitData() - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyWriter: Returns the commit user data map that was set on TaxonomyWriter.setCommitData(Map).
getCommitUserData() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getCommitUserData() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Retrieve user committed data.
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.sampling.SamplingWrapper
getComplementThreshold() - Method in class org.apache.lucene.facet.search.StandardFacetsAccumulator: Returns the complement threshold.
getDepth() - Method in class org.apache.lucene.facet.search.FacetRequest: How deeply to look under the given category.
getDirectory() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Returns the Directory of this taxonomy writer.
getDocID() - Method in interface org.apache.lucene.facet.search.ScoredDocIDsIterator: Returns the ID of the current document.
getDocIDs() - Method in class org.apache.lucene.facet.search.MatchingDocsAsScoredDocIDs
getDocIDs() - Method in interface org.apache.lucene.facet.search.ScoredDocIDs: Returns the set of doc IDs.
getDocValuesFormatForField(String) - Method in class org.apache.lucene.facet.codecs.facet42.Facet42Codec
getDrillDownAccumulator(FacetSearchParams) - Method in class org.apache.lucene.facet.search.DrillSideways: Override this to use a custom drill-down FacetsAccumulator.
getDrillDownStream(Iterable<CategoryPath>) - Method in class org.apache.lucene.facet.associations.AssociationsFacetFields
getDrillDownStream(Iterable<CategoryPath>) - Method in class org.apache.lucene.facet.index.FacetFields: Returns a DrillDownStream for writing the categories drill-down terms.
getDrillSidewaysAccumulator(String, FacetSearchParams) - Method in class org.apache.lucene.facet.search.DrillSideways: Override this to use a custom drill-sideways FacetsAccumulator.
getFacetArraysSource() - Method in class org.apache.lucene.facet.associations.AssociationFloatSumFacetRequest
getFacetArraysSource() - Method in class org.apache.lucene.facet.associations.AssociationIntSumFacetRequest
getFacetArraysSource() - Method in class org.apache.lucene.facet.search.CountFacetRequest
getFacetArraysSource() - Method in class org.apache.lucene.facet.search.FacetRequest: Returns the FacetRequest.FacetArraysSource this FacetRequest uses in FacetRequest.getValueOf(FacetArrays, int).
getFacetArraysSource() - Method in class org.apache.lucene.facet.search.SumScoreFacetRequest
getFacetDelimChar() - Method in class org.apache.lucene.facet.params.FacetIndexingParams: Returns the delimiter character used internally for concatenating category path components, e.g.
getFacetRequest() - Method in interface org.apache.lucene.facet.partitions.IntermediateFacetResult: Facet request for which this temporary result was created.
getFacetRequest() - Method in class org.apache.lucene.facet.search.FacetResult: Request for which this result was obtained.
getFacetRequest() - Method in class org.apache.lucene.facet.search.TopKInEachNodeHandler.IntermediateFacetResultWithHash
getFacetResultNode() - Method in class org.apache.lucene.facet.search.FacetResult: Facet result node matching the root of the facet request.
getFacetResults() - Method in class org.apache.lucene.facet.search.FacetsCollector: Returns a FacetResult per FacetRequest set in FacetSearchParams.
getFieldInfos() - Method in class org.apache.lucene.facet.util.FacetsPayloadMigrationReader
getFloatArray() - Method in class org.apache.lucene.facet.search.FacetArrays
getIntArray() - Method in class org.apache.lucene.facet.search.FacetArrays
getMap() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.DiskOrdinalMap
getMap() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.MemoryOrdinalMap
getMap() - Method in interface org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.OrdinalMap: Return the map from the taxonomy's original (consecutive) ordinals to the new taxonomy's ordinals.
getMatchingDocs() - Method in class org.apache.lucene.facet.search.FacetsCollector: Returns the documents matched by the query, one FacetsCollector.MatchingDocs per visited segment.
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.sampling.SamplingParams: Return the maxSampleSize.
getMaxSize() - Method in class org.apache.lucene.facet.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.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.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.
getNumValidDescendants() - Method in class org.apache.lucene.facet.search.FacetResult: Number of descendants of root facet result node, up till the requested depth.
getOrdinal(CategoryPath) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getOrdinal(CategoryPath) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: 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) - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.LabelToOrdinal
getOrdinalPolicy(String) - Method in class org.apache.lucene.facet.params.CategoryListParams: Returns the CategoryListParams.OrdinalPolicy to use for the given dimension.
getOrdinalPolicy(String) - Method in class org.apache.lucene.facet.params.PerDimensionOrdinalPolicy
getOrdinals(int, IntsRef) - Method in interface org.apache.lucene.facet.search.CategoryListIterator: Stores the category ordinals of the given document ID in the given IntsRef, starting at position 0 upto IntsRef.length.
getOrdinals(int, IntsRef) - Method in class org.apache.lucene.facet.search.DocValuesCategoryListIterator
getOrdinals(int, IntsRef) - Method in class org.apache.lucene.facet.util.MultiCategoryListIterator
getOversampleFactor() - Method in class org.apache.lucene.facet.sampling.SamplingParams: Return the oversampleFactor.
getParallelTaxonomyArrays() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getParallelTaxonomyArrays() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Returns a ParallelTaxonomyArrays object which can be used to efficiently traverse the taxonomy tree.
getParent(int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
getParent(int) - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyWriter: getParent() returns the ordinal of the parent category of the category with the given ordinal.
getPartitionSize() - Method in class org.apache.lucene.facet.params.FacetIndexingParams: Returns the size of a partition.
getPath(int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getPath(int) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Returns the path name of the category with the given ordinal.
getRefCount() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Returns the current refCount for this taxonomy reader.
getResultMode() - Method in class org.apache.lucene.facet.search.FacetRequest: Return the requested result mode.
getSampleFixer(IndexReader, TaxonomyReader, FacetSearchParams) - Method in class org.apache.lucene.facet.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.sampling.SamplingParams
getSampleSet(ScoredDocIDs) - Method in class org.apache.lucene.facet.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.sampling.Sampler: Return the sampling params in effect
getSamplingThreshold() - Method in class org.apache.lucene.facet.sampling.SamplingParams: Return the samplingThreshold.
getScore() - Method in interface org.apache.lucene.facet.search.ScoredDocIDsIterator: Returns the score of the current document.
getSingleton() - Static method in class org.apache.lucene.facet.complements.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() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Returns the number of categories in the taxonomy.
getSize() - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyWriter: getSize() returns the number of categories in the taxonomy.
getSortOrder() - Method in class org.apache.lucene.facet.search.FacetRequest: Return the requested order of results.
getTaxonomyEpoch() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Expert: returns current index epoch, if this is a near-real-time reader.
getTotalCount(int) - Method in class org.apache.lucene.facet.complements.TotalFacetCounts: Return the total count of an input category
getTotalCounts(IndexReader, TaxonomyReader, FacetIndexingParams) - Method in class org.apache.lucene.facet.complements.TotalFacetCountsCache: Get the total facet counts for a reader/taxonomy pair and facet indexing parameters.
getTotalCountsFactor() - Method in class org.apache.lucene.facet.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 class org.apache.lucene.facet.associations.CategoryFloatAssociation: Returns the value associated with a category.
getValue() - Method in class org.apache.lucene.facet.associations.CategoryIntAssociation: Returns the value associated with a category.
getValueOf(FacetArrays, int) - Method in class org.apache.lucene.facet.associations.AssociationFloatSumFacetRequest
getValueOf(FacetArrays, int) - Method in class org.apache.lucene.facet.associations.AssociationIntSumFacetRequest
getValueOf(FacetArrays, int) - Method in class org.apache.lucene.facet.search.CountFacetRequest
getValueOf(FacetArrays, int) - Method in class org.apache.lucene.facet.search.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.SumScoreFacetRequest
GROUD - Static variable in class org.apache.lucene.facet.collections.IntToIntMap
GROUND - Static variable in class org.apache.lucene.facet.collections.IntToDoubleMap
GROUND - Static variable in class org.apache.lucene.facet.collections.IntToFloatMap
grow() - Method in class org.apache.lucene.facet.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.facet.collections.FloatToObjectMap: Grows the map.
grow() - Method in class org.apache.lucene.facet.collections.IntHashSet: Grows the map.
grow() - Method in class org.apache.lucene.facet.collections.IntToDoubleMap: Grows the map.
grow() - Method in class org.apache.lucene.facet.collections.IntToFloatMap: Grows the map.
grow() - Method in class org.apache.lucene.facet.collections.IntToIntMap: Grows the map.
grow() - Method in class org.apache.lucene.facet.collections.IntToObjectMap: Grows the map.
grow() - Method in class org.apache.lucene.facet.collections.ObjectToFloatMap: Grows the map.
grow() - Method in class org.apache.lucene.facet.collections.ObjectToIntMap: Grows the map.

H

hashCode() - Method in class org.apache.lucene.facet.collections.ArrayHashMap
hashCode() - Method in class org.apache.lucene.facet.collections.FloatToObjectMap
hashCode() - Method in class org.apache.lucene.facet.collections.IntArray: Calculates a hash-code for HashTables
hashCode() - Method in class org.apache.lucene.facet.collections.IntToDoubleMap
hashCode() - Method in class org.apache.lucene.facet.collections.IntToFloatMap
hashCode() - Method in class org.apache.lucene.facet.collections.IntToIntMap
hashCode() - Method in class org.apache.lucene.facet.collections.IntToObjectMap
hashCode() - Method in class org.apache.lucene.facet.collections.ObjectToFloatMap
hashCode() - Method in class org.apache.lucene.facet.collections.ObjectToIntMap
hashCode() - Method in class org.apache.lucene.facet.params.CategoryListParams
hashCode() - Method in class org.apache.lucene.facet.params.FacetIndexingParams
hashCode() - Method in class org.apache.lucene.facet.search.CountingAggregator
hashCode() - Method in class org.apache.lucene.facet.search.DocValuesCategoryListIterator
hashCode() - Method in class org.apache.lucene.facet.search.DrillDownQuery
hashCode() - Method in class org.apache.lucene.facet.search.FacetRequest
hashCode() - Method in class org.apache.lucene.facet.search.ScoringAggregator
hashCode() - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
hasNext() - Method in interface org.apache.lucene.facet.collections.DoubleIterator
hasNext() - Method in interface org.apache.lucene.facet.collections.FloatIterator
hasNext() - Method in interface org.apache.lucene.facet.collections.IntIterator
Heap<T> - Interface in org.apache.lucene.facet.search: Declares an interface for heap (and heap alike) structures, handling a given type T
hits - Variable in class org.apache.lucene.facet.search.DrillSideways.DrillSidewaysResult: Hits.

I

incRef() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Expert: increments the refCount of this TaxonomyReader instance.
incrementToken() - Method in class org.apache.lucene.facet.index.DrillDownStream
INDEX_EPOCH - Static variable in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Property name of user commit data that contains the index epoch.
indexingParams - Variable in class org.apache.lucene.facet.index.FacetFields
indexingParams - Variable in class org.apache.lucene.facet.params.FacetSearchParams
indexReader - Variable in class org.apache.lucene.facet.search.FacetsAccumulator
indicator - Variable in class org.apache.lucene.facet.encoding.ChunksIntEncoder: Represents bits flag byte.
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.facet.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.facet.collections.IntArray: Construct a default IntArray, size 0 and surly a sort should not occur.
IntDecoder - Class in org.apache.lucene.facet.encoding: Decodes integers from a set BytesRef.
IntDecoder() - Constructor for class org.apache.lucene.facet.encoding.IntDecoder
IntEncoder - Class in org.apache.lucene.facet.encoding: Encodes integers to a set BytesRef.
IntEncoder() - Constructor for class org.apache.lucene.facet.encoding.IntEncoder
IntEncoderFilter - Class in org.apache.lucene.facet.encoding: An abstract implementation of IntEncoder which wraps another encoder.
IntEncoderFilter(IntEncoder) - Constructor for class org.apache.lucene.facet.encoding.IntEncoderFilter
IntermediateFacetResult - Interface in org.apache.lucene.facet.partitions: Intermediate FacetResult of faceted search.
intersect(IntHashSet) - Method in class org.apache.lucene.facet.collections.IntArray: Intersects the data with a given IntHashSet.
intersect(IntArray) - Method in class org.apache.lucene.facet.collections.IntArray: Intersects the data with a given IntArray
IntFacetResultsHandler - Class in org.apache.lucene.facet.search: A DepthOneFacetResultsHandler which fills the categories values from FacetArrays.getIntArray().
IntFacetResultsHandler(TaxonomyReader, FacetRequest, FacetArrays) - Constructor for class org.apache.lucene.facet.search.IntFacetResultsHandler
IntHashSet - Class in org.apache.lucene.facet.collections: A Set or primitive int.
IntHashSet() - Constructor for class org.apache.lucene.facet.collections.IntHashSet: Constructs a map with default capacity.
IntHashSet(int) - Constructor for class org.apache.lucene.facet.collections.IntHashSet: Constructs a map with given capacity.
IntIterator - Interface in org.apache.lucene.facet.collections: Iterator interface for primitive int iteration.
IntRollupFacetsAggregator - Class in org.apache.lucene.facet.search: A FacetsAggregator which implements IntRollupFacetsAggregator.rollupValues(FacetRequest, int, int[], int[], FacetArrays) by summing the values from FacetArrays.getIntArray().
IntRollupFacetsAggregator() - Constructor for class org.apache.lucene.facet.search.IntRollupFacetsAggregator
IntToDoubleMap - Class in org.apache.lucene.facet.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.facet.collections.IntToDoubleMap: Constructs a map with default capacity.
IntToDoubleMap(int) - Constructor for class org.apache.lucene.facet.collections.IntToDoubleMap: Constructs a map with given capacity.
IntToFloatMap - Class in org.apache.lucene.facet.collections: An Array-based hashtable which maps primitive int to a primitive float.
The hashtable is constracted with a given capacity, or 16 as a default.
IntToFloatMap() - Constructor for class org.apache.lucene.facet.collections.IntToFloatMap: Constructs a map with default capacity.
IntToFloatMap(int) - Constructor for class org.apache.lucene.facet.collections.IntToFloatMap: Constructs a map with given capacity.
IntToIntMap - Class in org.apache.lucene.facet.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.facet.collections.IntToIntMap: Constructs a map with default capacity.
IntToIntMap(int) - Constructor for class org.apache.lucene.facet.collections.IntToIntMap: Constructs a map with given capacity.
IntToObjectMap<T> - Class in org.apache.lucene.facet.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.facet.collections.IntToObjectMap: Constructs a map with default capacity.
IntToObjectMap(int) - Constructor for class org.apache.lucene.facet.collections.IntToObjectMap: Constructs a map with given capacity.
INVALID_ORDINAL - Static variable in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Ordinals are always non-negative, so a negative ordinal can be used to signify an error.
INVALID_ORDINAL - Static variable in class org.apache.lucene.facet.taxonomy.writercache.cl2o.LabelToOrdinal
isEmpty() - Method in class org.apache.lucene.facet.collections.ArrayHashMap: Returns true iff the map is empty.
isEmpty() - Method in class org.apache.lucene.facet.collections.FloatToObjectMap
isEmpty() - Method in class org.apache.lucene.facet.collections.IntHashSet
isEmpty() - Method in class org.apache.lucene.facet.collections.IntToDoubleMap
isEmpty() - Method in class org.apache.lucene.facet.collections.IntToFloatMap
isEmpty() - Method in class org.apache.lucene.facet.collections.IntToIntMap
isEmpty() - Method in class org.apache.lucene.facet.collections.IntToObjectMap
isEmpty() - Method in class org.apache.lucene.facet.collections.ObjectToFloatMap
isEmpty() - Method in class org.apache.lucene.facet.collections.ObjectToIntMap
isFull() - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.Cl2oTaxonomyWriterCache
isFull() - Method in class org.apache.lucene.facet.taxonomy.writercache.lru.LruTaxonomyWriterCache
isFull() - Method in interface org.apache.lucene.facet.taxonomy.writercache.TaxonomyWriterCache: Returns true if the cache is full, such that the next TaxonomyWriterCache.put(org.apache.lucene.facet.taxonomy.CategoryPath, int) will evict entries from it, false otherwise.
isSelfPartition(int, FacetArrays, int) - Method in class org.apache.lucene.facet.partitions.PartitionsFacetResultsHandler: Check if an array contains the partition which contains ordinal
isUsingComplements - Variable in class org.apache.lucene.facet.search.StandardFacetsAccumulator
isUsingComplements() - Method in class org.apache.lucene.facet.search.StandardFacetsAccumulator: Returns true if complements are enabled.
iterator() - Method in class org.apache.lucene.facet.associations.CategoryAssociationsContainer
iterator() - Method in class org.apache.lucene.facet.collections.ArrayHashMap: Returns an iterator on the mapped objects.
iterator() - Method in class org.apache.lucene.facet.collections.FloatToObjectMap: Returns a new iterator for the mapped objects.
iterator() - Method in class org.apache.lucene.facet.collections.IntHashSet: Returns a new iterator for the mapped objects.
iterator() - Method in class org.apache.lucene.facet.collections.IntToDoubleMap: Returns a new iterator for the mapped double values.
iterator() - Method in class org.apache.lucene.facet.collections.IntToFloatMap: Returns a new iterator for the mapped float values.
iterator() - Method in class org.apache.lucene.facet.collections.IntToIntMap: Returns a new iterator for the mapped objects.
iterator() - Method in class org.apache.lucene.facet.collections.IntToObjectMap: Returns a new iterator for the mapped objects.
iterator() - Method in class org.apache.lucene.facet.collections.ObjectToFloatMap: Returns a new iterator for the mapped floats.
iterator() - Method in class org.apache.lucene.facet.collections.ObjectToIntMap: Returns a new iterator for the mapped objects.
iterator() - Method in class org.apache.lucene.facet.search.MatchingDocsAsScoredDocIDs
iterator() - Method in interface org.apache.lucene.facet.search.ScoredDocIDs: Returns an iterator over the document IDs and their scores.

K

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

L

label - Variable in class org.apache.lucene.facet.search.FacetResultNode: The label of this result.
labelResult(FacetResult) - Method in class org.apache.lucene.facet.partitions.PartitionsFacetResultsHandler: 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
length - Variable in class org.apache.lucene.facet.taxonomy.CategoryPath: The number of components of this CategoryPath.
load(File, IndexReader, TaxonomyReader, FacetIndexingParams) - Method in class org.apache.lucene.facet.complements.TotalFacetCountsCache: Load TotalFacetCounts matching input parameters from the provided outputFile and add them into the cache for the provided indexReader, taxonomy, and facetIndexingParams.
longHashCode() - Method in class org.apache.lucene.facet.taxonomy.CategoryPath: Calculate a 64-bit hash function for this path.
LRUHashMap<K,V> - Class in org.apache.lucene.facet.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.facet.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: Determines cache type.

M

main(String[]) - Static method in class org.apache.lucene.facet.util.PrintTaxonomyStats
mapToAACOs - Variable in class org.apache.lucene.facet.search.TopKInEachNodeHandler.IntermediateFacetResultWithHash
matchingDocs - Variable in class org.apache.lucene.facet.search.FacetsCollector
MatchingDocsAsScoredDocIDs - Class in org.apache.lucene.facet.search: Represents FacetsCollector.MatchingDocs as ScoredDocIDs.
MatchingDocsAsScoredDocIDs(List<FacetsCollector.MatchingDocs>) - Constructor for class org.apache.lucene.facet.search.MatchingDocsAsScoredDocIDs
maxBytesNeeded() - Method in interface org.apache.lucene.facet.associations.CategoryAssociation: Returns the maximum bytes needed to encode the association value.
maxBytesNeeded() - Method in class org.apache.lucene.facet.associations.CategoryFloatAssociation
maxBytesNeeded() - Method in class org.apache.lucene.facet.associations.CategoryIntAssociation
maxPartitions - Variable in class org.apache.lucene.facet.search.StandardFacetsAccumulator
mayComplement() - Method in class org.apache.lucene.facet.search.StandardFacetsAccumulator: check if all requests are complementable
merge(Directory, Directory, DirectoryTaxonomyWriter.OrdinalMap, IndexWriter, DirectoryTaxonomyWriter, FacetIndexingParams) - Static method in class org.apache.lucene.facet.util.TaxonomyMergeUtils: Merges the given taxonomy and index directories and commits the changes to the given writers.
mergeResults(IntermediateFacetResult...) - Method in class org.apache.lucene.facet.partitions.PartitionsFacetResultsHandler: 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
MultiAssociationsFacetsAggregator - Class in org.apache.lucene.facet.associations: A FacetsAggregator which chains multiple aggregators for aggregating the association values of categories that belong to the same category list.
MultiAssociationsFacetsAggregator(Map<CategoryPath, FacetsAggregator>) - Constructor for class org.apache.lucene.facet.associations.MultiAssociationsFacetsAggregator: Creates a new MultiAssociationsFacetsAggregator over the given aggregators.
MultiCategoryListIterator - Class in org.apache.lucene.facet.util: Iterates over multiple CategoryListIterators, consuming the provided iterators in order.
MultiCategoryListIterator(CategoryListIterator...) - Constructor for class org.apache.lucene.facet.util.MultiCategoryListIterator: Receives the iterators to iterate on

N

NameHashIntCacheLRU - Class in org.apache.lucene.facet.taxonomy.writercache.lru: An an LRU cache of mapping from name to int.
newFloatArray() - Method in class org.apache.lucene.facet.search.FacetArrays
newFloatArray() - Method in class org.apache.lucene.facet.search.ReusingFacetArrays
newIntArray() - Method in class org.apache.lucene.facet.search.FacetArrays
newIntArray() - Method in class org.apache.lucene.facet.search.ReusingFacetArrays
next() - Method in interface org.apache.lucene.facet.collections.DoubleIterator
next() - Method in interface org.apache.lucene.facet.collections.FloatIterator
next() - Method in interface org.apache.lucene.facet.collections.IntIterator
next() - Method in interface org.apache.lucene.facet.search.ScoredDocIDsIterator: Iterate to the next document/score pair.
next() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader.ChildrenIterator: Return the next child ordinal, or TaxonomyReader.INVALID_ORDINAL if no more children.
NOnesIntDecoder - Class in org.apache.lucene.facet.encoding: Decodes values encoded encoded with NOnesIntEncoder.
NOnesIntDecoder(int) - Constructor for class org.apache.lucene.facet.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.facet.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.facet.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').
numResults - Variable in class org.apache.lucene.facet.search.FacetRequest

O

ObjectToFloatMap<K> - Class in org.apache.lucene.facet.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.facet.collections.ObjectToFloatMap: Constructs a map with default capacity.
ObjectToFloatMap(int) - Constructor for class org.apache.lucene.facet.collections.ObjectToFloatMap: Constructs a map with given capacity.
ObjectToIntMap<K> - Class in org.apache.lucene.facet.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.facet.collections.ObjectToIntMap: Constructs a map with default capacity.
ObjectToIntMap(int) - Constructor for class org.apache.lucene.facet.collections.ObjectToIntMap: Constructs a map with given capacity.
offsets - Variable in class org.apache.lucene.facet.search.OrdinalsCache.CachedOrds
openIfChanged(T) - Static method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: If the taxonomy has changed since the provided reader was opened, open and return a new TaxonomyReader; else, return null.
openIndexReader(Directory) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
openIndexReader(IndexWriter) - 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.
ordinal - Variable in class org.apache.lucene.facet.encoding.ChunksIntEncoder: Counts the current ordinal of the encoded value.
ordinal - Variable in class org.apache.lucene.facet.search.FacetResultNode: The category ordinal of this node.
OrdinalMappingAtomicReader - Class in org.apache.lucene.facet.util: A FilterAtomicReader for updating facets ordinal references, based on an ordinal map.
OrdinalMappingAtomicReader(AtomicReader, int[]) - Constructor for class org.apache.lucene.facet.util.OrdinalMappingAtomicReader: Wraps an AtomicReader, mapping ordinals according to the ordinalMap.
OrdinalMappingAtomicReader(AtomicReader, int[], FacetIndexingParams) - Constructor for class org.apache.lucene.facet.util.OrdinalMappingAtomicReader: Wraps an AtomicReader, mapping ordinals according to the ordinalMap, using the provided indexingParams.
ordinals - Variable in class org.apache.lucene.facet.search.OrdinalsCache.CachedOrds
OrdinalsCache - Class in org.apache.lucene.facet.search: A per-segment cache of documents' category ordinals.
OrdinalsCache() - Constructor for class org.apache.lucene.facet.search.OrdinalsCache
OrdinalsCache.CachedOrds - Class in org.apache.lucene.facet.search: Holds the cached ordinals in two paralel int[] arrays.
OrdinalsCache.CachedOrds(BinaryDocValues, int, CategoryListParams) - Constructor for class org.apache.lucene.facet.search.OrdinalsCache.CachedOrds: Creates a new OrdinalsCache.CachedOrds from the BinaryDocValues.
org.apache.lucene.facet - package org.apache.lucene.facet: faceted search
org.apache.lucene.facet.associations - package org.apache.lucene.facet.associations: Allows associating arbitrary values with a category.
org.apache.lucene.facet.codecs.facet42 - package org.apache.lucene.facet.codecs.facet42: Codec + DocValuesFormat that are optimized for facets.
org.apache.lucene.facet.collections - package org.apache.lucene.facet.collections: Various optimized Collections implementations.
org.apache.lucene.facet.complements - package org.apache.lucene.facet.complements: Allows to cache the total counts of categories, so that during search which returns a large number of results (>60% of segment size), the complement set of matching documents is counted.
org.apache.lucene.facet.encoding - package org.apache.lucene.facet.encoding: Offers various encoders and decoders for category ordinals.
org.apache.lucene.facet.index - package org.apache.lucene.facet.index: Facets indexing code.
org.apache.lucene.facet.params - package org.apache.lucene.facet.params: Facets indexing and search parameters.
org.apache.lucene.facet.partitions - package org.apache.lucene.facet.partitions: Category Partitions
org.apache.lucene.facet.sampling - package org.apache.lucene.facet.sampling: Facets sampling.
org.apache.lucene.facet.search - package org.apache.lucene.facet.search: Facets search code.
org.apache.lucene.facet.sortedset - package org.apache.lucene.facet.sortedset: Classes to perform faceting without a separate taxonomy index, using on SortedSetDocValuesField.
org.apache.lucene.facet.taxonomy - package org.apache.lucene.facet.taxonomy: Taxonomy of Categories
org.apache.lucene.facet.taxonomy.directory - package org.apache.lucene.facet.taxonomy.directory: Taxonomy index implementation using on top of a Directory.
org.apache.lucene.facet.taxonomy.writercache - package org.apache.lucene.facet.taxonomy.writercache: Improves indexing time by caching a map of CategoryPath to their Ordinal.
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
overSampledSearchParams(FacetSearchParams) - Method in class org.apache.lucene.facet.sampling.Sampler: Over-sampled search params, wrapping each request with an over-sampled one.

P

ParallelTaxonomyArrays - Class in org.apache.lucene.facet.taxonomy: Returns 3 arrays for traversing the taxonomy: parents: parents[i] denotes the parent of category ordinal i. children: children[i] denotes a child of category ordinal i. siblings: siblings[i] denotes the sibling of category ordinal i. To traverse the taxonomy tree, you typically start with children[0] (ordinal 0 is reserved for ROOT), and then depends if you want to do DFS or BFS, you call children[children[0]] or siblings[children[0]] and so forth, respectively.
ParallelTaxonomyArrays() - Constructor for class org.apache.lucene.facet.taxonomy.ParallelTaxonomyArrays
parents() - Method in class org.apache.lucene.facet.taxonomy.ParallelTaxonomyArrays: Returns the parents array, where parents[i] denotes the parent of category ordinal i.
PART_NAME_PREFIX - Static variable in class org.apache.lucene.facet.util.PartitionsUtils: The prefix that is added to the name of the partition.
partitionName(int) - Static method in class org.apache.lucene.facet.util.PartitionsUtils: Partition name by its number
partitionNameByOrdinal(FacetIndexingParams, 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.
PartitionsFacetResultsHandler - Class in org.apache.lucene.facet.partitions: A FacetResultsHandler designed to work with facet partitions.
PartitionsFacetResultsHandler(TaxonomyReader, FacetRequest, FacetArrays) - Constructor for class org.apache.lucene.facet.partitions.PartitionsFacetResultsHandler
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.
PartitionsUtils - Class in org.apache.lucene.facet.util: Utilities for partitions - sizes and such
PartitionsUtils() - Constructor for class org.apache.lucene.facet.util.PartitionsUtils
PAYLOAD_TERM_TEXT - Static variable in class org.apache.lucene.facet.util.FacetsPayloadMigrationReader: The Term text of the ordinals payload.
PerCategoryListAggregator - Class in org.apache.lucene.facet.search: A FacetsAggregator which invokes the proper aggregator per CategoryListParams.
PerCategoryListAggregator(Map<CategoryListParams, FacetsAggregator>, FacetIndexingParams) - Constructor for class org.apache.lucene.facet.search.PerCategoryListAggregator
PerDimensionIndexingParams - Class in org.apache.lucene.facet.params: A FacetIndexingParams that utilizes different category lists, defined by the dimension specified by a category (see PerDimensionIndexingParams.PerDimensionIndexingParams(Map, CategoryListParams).
PerDimensionIndexingParams(Map<CategoryPath, CategoryListParams>) - Constructor for class org.apache.lucene.facet.params.PerDimensionIndexingParams: Initializes a new instance with the given dimension-to-params mapping.
PerDimensionIndexingParams(Map<CategoryPath, CategoryListParams>, CategoryListParams) - Constructor for class org.apache.lucene.facet.params.PerDimensionIndexingParams: Same as PerDimensionIndexingParams.PerDimensionIndexingParams(Map), only the given CategoryListParams will be used for any dimension that is not specified in the given mapping.
PerDimensionOrdinalPolicy - Class in org.apache.lucene.facet.params: A CategoryListParams which allow controlling the CategoryListParams.OrdinalPolicy used for each dimension.
PerDimensionOrdinalPolicy(Map<String, CategoryListParams.OrdinalPolicy>) - Constructor for class org.apache.lucene.facet.params.PerDimensionOrdinalPolicy
PerDimensionOrdinalPolicy(Map<String, CategoryListParams.OrdinalPolicy>, CategoryListParams.OrdinalPolicy) - Constructor for class org.apache.lucene.facet.params.PerDimensionOrdinalPolicy
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.
prepareCommit() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: prepare most of the work needed for a two-phase commit.
printStats(TaxonomyReader, PrintStream, boolean) - Static method in class org.apache.lucene.facet.util.PrintTaxonomyStats
PrintTaxonomyStats - Class in org.apache.lucene.facet.util: Prints how many ords are under each dimension.
PrintTaxonomyStats() - Constructor for class org.apache.lucene.facet.util.PrintTaxonomyStats
put(K, V) - Method in class org.apache.lucene.facet.collections.ArrayHashMap: Inserts the <key,value> pair into the map.
put(float, T) - Method in class org.apache.lucene.facet.collections.FloatToObjectMap: Inserts the <key,value> pair into the map.
put(int, double) - Method in class org.apache.lucene.facet.collections.IntToDoubleMap: Inserts the <key,value> pair into the map.
put(int, float) - Method in class org.apache.lucene.facet.collections.IntToFloatMap: Inserts the <key,value> pair into the map.
put(int, int) - Method in class org.apache.lucene.facet.collections.IntToIntMap: Inserts the <key,value> pair into the map.
put(int, T) - Method in class org.apache.lucene.facet.collections.IntToObjectMap: Inserts the <key,value> pair into the map.
put(K, float) - Method in class org.apache.lucene.facet.collections.ObjectToFloatMap: Inserts the <key,value> pair into the map.
put(K, int) - Method in class org.apache.lucene.facet.collections.ObjectToIntMap: Inserts the <key,value> pair into the map.
put(CategoryPath, 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) - Method in interface org.apache.lucene.facet.taxonomy.writercache.TaxonomyWriterCache: Add a category to the cache, with the given ordinal as the value.

R

RandomSampler - Class in org.apache.lucene.facet.sampling: Simple random sampler
RandomSampler() - Constructor for class org.apache.lucene.facet.sampling.RandomSampler
RandomSampler(SamplingParams, Random) - Constructor for class org.apache.lucene.facet.sampling.RandomSampler
rearrangeFacetResult(FacetResult) - Method in class org.apache.lucene.facet.partitions.PartitionsFacetResultsHandler: 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
refreshIfNeeded(SearcherTaxonomyManager.SearcherAndTaxonomy) - Method in class org.apache.lucene.facet.search.SearcherTaxonomyManager
remove(K) - Method in class org.apache.lucene.facet.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.facet.collections.DoubleIterator
remove() - Method in interface org.apache.lucene.facet.collections.FloatIterator
remove(float) - Method in class org.apache.lucene.facet.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.facet.collections.IntHashSet: Remove a pair from the map, specified by it's key.
remove() - Method in interface org.apache.lucene.facet.collections.IntIterator
remove(int) - Method in class org.apache.lucene.facet.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.facet.collections.IntToFloatMap: Removes a <key,value> pair from the map and returns the mapped value, or Float.NaN if the none existed.
remove(int) - Method in class org.apache.lucene.facet.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.facet.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.facet.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.facet.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.facet.collections.LRUHashMap
renderFacetResult(IntermediateFacetResult) - Method in class org.apache.lucene.facet.partitions.PartitionsFacetResultsHandler: 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.sampling: Take random samples of large collections.
RepeatableSampler(SamplingParams) - Constructor for class org.apache.lucene.facet.sampling.RepeatableSampler
replaceTaxonomy(Directory) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Replaces the current taxonomy with the given one.
requiresDocScores() - Method in class org.apache.lucene.facet.associations.MultiAssociationsFacetsAggregator
requiresDocScores() - Method in class org.apache.lucene.facet.associations.SumFloatAssociationFacetsAggregator
requiresDocScores() - Method in class org.apache.lucene.facet.associations.SumIntAssociationFacetsAggregator
requiresDocScores() - Method in interface org.apache.lucene.facet.search.FacetsAggregator: Returns true if this aggregator requires document scores.
requiresDocScores() - Method in class org.apache.lucene.facet.search.IntRollupFacetsAggregator
requiresDocScores() - Method in class org.apache.lucene.facet.search.PerCategoryListAggregator
requiresDocScores() - Method in class org.apache.lucene.facet.search.SumScoreFacetsAggregator
reset() - Method in class org.apache.lucene.facet.index.DrillDownStream
reset() - Method in class org.apache.lucene.facet.search.FacetsCollector: Allows to reuse the collector between search requests.
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
ReusingFacetArrays - Class in org.apache.lucene.facet.search: A FacetArrays which uses the ArraysPool to allocate new arrays and pool them on FacetArrays.free().
ReusingFacetArrays(ArraysPool) - Constructor for class org.apache.lucene.facet.search.ReusingFacetArrays
rewrite(IndexReader) - Method in class org.apache.lucene.facet.search.DrillDownQuery
rollback() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Rollback changes to the taxonomy writer and closes the instance.
rollupValues(FacetRequest, int, int[], int[], FacetArrays) - Method in class org.apache.lucene.facet.associations.MultiAssociationsFacetsAggregator
rollupValues(FacetRequest, int, int[], int[], FacetArrays) - Method in class org.apache.lucene.facet.associations.SumFloatAssociationFacetsAggregator
rollupValues(FacetRequest, int, int[], int[], FacetArrays) - Method in class org.apache.lucene.facet.associations.SumIntAssociationFacetsAggregator
rollupValues(FacetRequest, int, int[], int[], FacetArrays) - Method in interface org.apache.lucene.facet.search.FacetsAggregator: Rollup the values of the given ordinal.
rollupValues(FacetRequest, int, int[], int[], FacetArrays) - Method in class org.apache.lucene.facet.search.IntRollupFacetsAggregator
rollupValues(FacetRequest, int, int[], int[], FacetArrays) - Method in class org.apache.lucene.facet.search.PerCategoryListAggregator
rollupValues(FacetRequest, int, int[], int[], FacetArrays) - Method in class org.apache.lucene.facet.search.SumScoreFacetsAggregator
ROOT_ORDINAL - Static variable in class org.apache.lucene.facet.taxonomy.TaxonomyReader: The root category (the category with the empty path) always has the ordinal 0, to which we give a name ROOT_ORDINAL.

S

SampleFixer - Interface in org.apache.lucene.facet.sampling: Fixer of sample facet accumulation results
Sampler - Class in org.apache.lucene.facet.sampling: Sampling definition for facets accumulation
Sampler() - Constructor for class org.apache.lucene.facet.sampling.Sampler: Construct with SamplingParams
Sampler(SamplingParams) - Constructor for class org.apache.lucene.facet.sampling.Sampler: Construct with certain SamplingParams
Sampler.SampleResult - Class in org.apache.lucene.facet.sampling: Result of sample computation
Sampler.SampleResult(ScoredDocIDs, double) - Constructor for class org.apache.lucene.facet.sampling.Sampler.SampleResult
SamplingAccumulator - Class in org.apache.lucene.facet.sampling: Facets accumulation with sampling.
SamplingAccumulator(Sampler, FacetSearchParams, IndexReader, TaxonomyReader, FacetArrays) - Constructor for class org.apache.lucene.facet.sampling.SamplingAccumulator
SamplingAccumulator(Sampler, FacetSearchParams, IndexReader, TaxonomyReader) - Constructor for class org.apache.lucene.facet.sampling.SamplingAccumulator: Constructor...
samplingParams - Variable in class org.apache.lucene.facet.sampling.Sampler
SamplingParams - Class in org.apache.lucene.facet.sampling: Parameters for sampling, dictating whether sampling is to take place and how.
SamplingParams() - Constructor for class org.apache.lucene.facet.sampling.SamplingParams
SamplingWrapper - Class in org.apache.lucene.facet.sampling: Wrap any Facets Accumulator with sampling.
SamplingWrapper(StandardFacetsAccumulator, Sampler) - Constructor for class org.apache.lucene.facet.sampling.SamplingWrapper
ScoredDocIDs - Interface in org.apache.lucene.facet.search: Document IDs with scores for each, driving facets accumulation.
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
scores - Variable in class org.apache.lucene.facet.search.FacetsCollector.MatchingDocs
ScoringAggregator - Class in org.apache.lucene.facet.search: 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.ScoringAggregator
search(DrillDownQuery, Collector, FacetSearchParams) - Method in class org.apache.lucene.facet.search.DrillSideways: Search, collecting hits with a Collector, and computing drill down and sideways counts.
search(DrillDownQuery, Filter, FieldDoc, int, Sort, boolean, boolean, FacetSearchParams) - Method in class org.apache.lucene.facet.search.DrillSideways: Search, sorting by Sort, and computing drill down and sideways counts.
search(ScoreDoc, DrillDownQuery, int, FacetSearchParams) - Method in class org.apache.lucene.facet.search.DrillSideways: Search, sorting by score, and computing drill down and sideways counts.
searcher - Variable in class org.apache.lucene.facet.search.DrillSideways
searcher - Variable in class org.apache.lucene.facet.search.SearcherTaxonomyManager.SearcherAndTaxonomy
SearcherTaxonomyManager - Class in org.apache.lucene.facet.search: Manages near-real-time reopen of both an IndexSearcher and a TaxonomyReader.
SearcherTaxonomyManager(IndexWriter, boolean, SearcherFactory, DirectoryTaxonomyWriter) - Constructor for class org.apache.lucene.facet.search.SearcherTaxonomyManager: Creates near-real-time searcher and taxonomy reader from the corresponding writers.
SearcherTaxonomyManager.SearcherAndTaxonomy - Class in org.apache.lucene.facet.search: Holds a matched pair of IndexSearcher and TaxonomyReader
searchParams - Variable in class org.apache.lucene.facet.search.FacetsAccumulator
serialize(ByteArrayDataOutput) - Method in interface org.apache.lucene.facet.associations.CategoryAssociation: Serializes the associated value into the given DataOutput.
serialize(ByteArrayDataOutput) - Method in class org.apache.lucene.facet.associations.CategoryFloatAssociation
serialize(ByteArrayDataOutput) - Method in class org.apache.lucene.facet.associations.CategoryIntAssociation
set(int, int) - Method in class org.apache.lucene.facet.collections.IntArray
setAssociation(CategoryPath, CategoryAssociation) - Method in class org.apache.lucene.facet.associations.CategoryAssociationsContainer: Adds the CategoryAssociation for the given category.
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.complements.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).
setCommitData(Map<String, String>) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
setCommitData(Map<String, String>) - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyWriter: Sets the commit user data map.
setComplementThreshold(double) - Method in class org.apache.lucene.facet.sampling.SamplingWrapper
setComplementThreshold(double) - Method in class org.apache.lucene.facet.search.StandardFacetsAccumulator: Set the complement threshold.
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: 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.FacetRequest
setMaxSampleSize(int) - Method in class org.apache.lucene.facet.sampling.SamplingParams
setMaxSize(int) - Method in class org.apache.lucene.facet.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.sampling.SamplingParams
setNextReader(AtomicReaderContext) - Method in interface org.apache.lucene.facet.search.Aggregator: Sets the AtomicReaderContext for which Aggregator.aggregate(int, float, IntsRef) calls will be made.
setNextReader(AtomicReaderContext) - Method in interface org.apache.lucene.facet.search.CategoryListIterator: Sets the AtomicReaderContext for which CategoryListIterator.getOrdinals(int, IntsRef) calls will be made.
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.facet.search.CountingAggregator
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.facet.search.DocValuesCategoryListIterator
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.facet.search.FacetsCollector
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.facet.search.ScoringAggregator
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.facet.util.MultiCategoryListIterator
setNumLabel(int) - Method in class org.apache.lucene.facet.search.FacetRequest
setOversampleFactor(double) - Method in class org.apache.lucene.facet.sampling.SamplingParams
setResultMode(FacetRequest.ResultMode) - Method in class org.apache.lucene.facet.search.FacetRequest
setSampler(Sampler) - Method in class org.apache.lucene.facet.search.AdaptiveFacetsAccumulator: Set the sampler.
setSampleRatio(double) - Method in class org.apache.lucene.facet.sampling.SamplingParams
setSamplingThreshold(int) - Method in class org.apache.lucene.facet.sampling.SamplingParams: Set a sampling-threshold
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.
setSortOrder(FacetRequest.SortOrder) - Method in class org.apache.lucene.facet.search.FacetRequest
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.sampling.Sampler: Check if this sampler would complement for the input docIds
siblings() - Method in class org.apache.lucene.facet.taxonomy.ParallelTaxonomyArrays: Returns the siblings array, where siblings[i] denotes the sibling of category ordinal i.
SimpleIntDecoder - Class in org.apache.lucene.facet.encoding: Decodes values encoded with SimpleIntEncoder.
SimpleIntDecoder() - Constructor for class org.apache.lucene.facet.encoding.SimpleIntDecoder
SimpleIntEncoder - Class in org.apache.lucene.facet.encoding: A simple IntEncoder, writing an integer as 4 raw bytes.
SimpleIntEncoder() - Constructor for class org.apache.lucene.facet.encoding.SimpleIntEncoder
size() - Method in class org.apache.lucene.facet.collections.ArrayHashMap: Returns number of pairs currently in the map.
size() - Method in class org.apache.lucene.facet.collections.FloatToObjectMap
size() - Method in class org.apache.lucene.facet.collections.IntArray: Return the size of the Array.
size() - Method in class org.apache.lucene.facet.collections.IntHashSet
size() - Method in class org.apache.lucene.facet.collections.IntToDoubleMap
size() - Method in class org.apache.lucene.facet.collections.IntToFloatMap
size() - Method in class org.apache.lucene.facet.collections.IntToIntMap
size() - Method in class org.apache.lucene.facet.collections.IntToObjectMap
size() - Method in class org.apache.lucene.facet.collections.ObjectToFloatMap
size() - Method in class org.apache.lucene.facet.collections.ObjectToIntMap
size() - Method in interface org.apache.lucene.facet.search.Heap: Return the amount of objects currently in the heap
size() - Method in class org.apache.lucene.facet.search.MatchingDocsAsScoredDocIDs
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
sizeOfMap() - Method in class org.apache.lucene.facet.taxonomy.writercache.cl2o.CompactLabelToOrdinal
sort() - Method in class org.apache.lucene.facet.collections.IntArray: Sorts the data.
SortedSetDocValuesAccumulator - Class in org.apache.lucene.facet.sortedset: A FacetsAccumulator that uses previously indexed SortedSetDocValuesFacetFields to perform faceting, without require a separate taxonomy index.
SortedSetDocValuesAccumulator(FacetSearchParams, SortedSetDocValuesReaderState) - Constructor for class org.apache.lucene.facet.sortedset.SortedSetDocValuesAccumulator
SortedSetDocValuesFacetFields - Class in org.apache.lucene.facet.sortedset: Add instances of this to your Document if you intend to use SortedSetDocValuesAccumulator to count facets at search time.
SortedSetDocValuesFacetFields() - Constructor for class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetFields: Create a SortedSetDocValuesFacetField with the provided CategoryPath.
SortedSetDocValuesFacetFields(FacetIndexingParams) - Constructor for class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetFields: Create a SortedSetDocValuesFacetField with the provided CategoryPath, and custom FacetIndexingParams.
SortedSetDocValuesReaderState - Class in org.apache.lucene.facet.sortedset: Wraps a IndexReader and resolves ords using existing SortedSetDocValues APIs without a separate taxonomy index.
SortedSetDocValuesReaderState(IndexReader) - Constructor for class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Create an instance, scanning the SortedSetDocValues from the provided reader, with default FacetIndexingParams.
SortedSetDocValuesReaderState(FacetIndexingParams, IndexReader) - Constructor for class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Create an instance, scanning the SortedSetDocValues from the provided reader and FacetIndexingParams.
SortingIntEncoder - Class in org.apache.lucene.facet.encoding: An IntEncoderFilter which sorts the values to encode in ascending order before encoding them.
SortingIntEncoder(IntEncoder) - Constructor for class org.apache.lucene.facet.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) - Constructor for class org.apache.lucene.facet.search.StandardFacetsAccumulator
StandardFacetsAccumulator(FacetSearchParams, IndexReader, TaxonomyReader, FacetArrays) - Constructor for class org.apache.lucene.facet.search.StandardFacetsAccumulator
store(File, IndexReader, TaxonomyReader, FacetIndexingParams) - Method in class org.apache.lucene.facet.complements.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).
subpath(int) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath: Returns a sub-path of this path up to length components.
subResults - Variable in class org.apache.lucene.facet.search.FacetResultNode: The sub-results of this result.
SumFloatAssociationFacetsAggregator - Class in org.apache.lucene.facet.associations: A FacetsAggregator which computes the weight of a category as the sum of the float values associated with it in the result documents.
SumFloatAssociationFacetsAggregator() - Constructor for class org.apache.lucene.facet.associations.SumFloatAssociationFacetsAggregator
SumIntAssociationFacetsAggregator - Class in org.apache.lucene.facet.associations: A FacetsAggregator which computes the weight of a category as the sum of the integer values associated with it in the result documents.
SumIntAssociationFacetsAggregator() - Constructor for class org.apache.lucene.facet.associations.SumIntAssociationFacetsAggregator
SumScoreFacetRequest - Class in org.apache.lucene.facet.search: A FacetRequest for weighting facets by summing the scores of matching documents.
SumScoreFacetRequest(CategoryPath, int) - Constructor for class org.apache.lucene.facet.search.SumScoreFacetRequest: Create a score facet request for a given node in the taxonomy.
SumScoreFacetsAggregator - Class in org.apache.lucene.facet.search: A FacetsAggregator which updates the weight of a category by summing the scores of documents it was found in.
SumScoreFacetsAggregator() - Constructor for class org.apache.lucene.facet.search.SumScoreFacetsAggregator

T

TaxonomyMergeUtils - Class in org.apache.lucene.facet.util: Utility methods for merging index and taxonomy directories.
TaxonomyMergeUtils() - Constructor for class org.apache.lucene.facet.util.TaxonomyMergeUtils
taxonomyReader - Variable in class org.apache.lucene.facet.search.FacetResultsHandler
taxonomyReader - Variable in class org.apache.lucene.facet.search.FacetsAccumulator
taxonomyReader - Variable in class org.apache.lucene.facet.search.SearcherTaxonomyManager.SearcherAndTaxonomy
TaxonomyReader - Class in org.apache.lucene.facet.taxonomy: TaxonomyReader is the read-only interface with which the faceted-search library uses the taxonomy during search time.
TaxonomyReader() - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyReader
TaxonomyReader.ChildrenIterator - Class in org.apache.lucene.facet.taxonomy: An iterator over a category's children.
taxonomyWriter - Variable in class org.apache.lucene.facet.index.FacetFields
TaxonomyWriter - Interface in org.apache.lucene.facet.taxonomy: TaxonomyWriter is the interface which the faceted-search library uses to dynamically build the taxonomy at indexing time.
TaxonomyWriterCache - Interface in org.apache.lucene.facet.taxonomy.writercache: TaxonomyWriterCache is a relatively simple interface for a cache of category->ordinal mappings, used in TaxonomyWriter implementations (such as DirectoryTaxonomyWriter).
taxoReader - Variable in class org.apache.lucene.facet.search.DrillSideways
term(FacetIndexingParams, CategoryPath) - Static method in class org.apache.lucene.facet.search.DrillDownQuery: Return a drill-down Term for a category.
toArray() - Method in class org.apache.lucene.facet.collections.ArrayHashMap: Translates the mapped pairs' values into an array of Objects
toArray(V[]) - Method in class org.apache.lucene.facet.collections.ArrayHashMap: Translates the mapped pairs' values into an array of V
toArray() - Method in class org.apache.lucene.facet.collections.FloatToObjectMap: Translates the mapped pairs' values into an array of Objects
toArray(T[]) - Method in class org.apache.lucene.facet.collections.FloatToObjectMap: Translates the mapped pairs' values into an array of T
toArray() - Method in class org.apache.lucene.facet.collections.IntHashSet: Translates the mapped pairs' values into an array of Objects
toArray(int[]) - Method in class org.apache.lucene.facet.collections.IntHashSet: Translates the mapped pairs' values into an array of ints
toArray() - Method in class org.apache.lucene.facet.collections.IntToDoubleMap: Translates the mapped pairs' values into an array of Objects
toArray(double[]) - Method in class org.apache.lucene.facet.collections.IntToDoubleMap: Translates the mapped pairs' values into an array of T
toArray() - Method in class org.apache.lucene.facet.collections.IntToFloatMap: Translates the mapped pairs' values into an array of Objects
toArray(float[]) - Method in class org.apache.lucene.facet.collections.IntToFloatMap: Translates the mapped pairs' values into an array of T
toArray() - Method in class org.apache.lucene.facet.collections.IntToIntMap: Translates the mapped pairs' values into an array of Objects
toArray(int[]) - Method in class org.apache.lucene.facet.collections.IntToIntMap: Translates the mapped pairs' values into an array of ints
toArray() - Method in class org.apache.lucene.facet.collections.IntToObjectMap: Translates the mapped pairs' values into an array of Objects
toArray(T[]) - Method in class org.apache.lucene.facet.collections.IntToObjectMap: Translates the mapped pairs' values into an array of T
toArray() - Method in class org.apache.lucene.facet.collections.ObjectToFloatMap: Translates the mapped pairs' values into an array of Objects
toArray(float[]) - Method in class org.apache.lucene.facet.collections.ObjectToFloatMap: Translates the mapped pairs' values into an array of T
toArray() - Method in class org.apache.lucene.facet.collections.ObjectToIntMap: Translates the mapped pairs' values into an array of Objects
toArray(int[]) - Method in class org.apache.lucene.facet.collections.ObjectToIntMap: Translates the mapped pairs' values into an array of T
toHashString() - Method in class org.apache.lucene.facet.collections.IntHashSet
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, FacetArrays) - 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 FacetArrays aggregated for a particular FacetRequest.
TopKInEachNodeHandler(TaxonomyReader, FacetRequest, FacetArrays) - Constructor for class org.apache.lucene.facet.search.TopKInEachNodeHandler
TopKInEachNodeHandler.AACO - Class in org.apache.lucene.facet.search: Maintains an array of AggregatedCategory.
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.associations.CategoryAssociationsContainer
toString() - Method in class org.apache.lucene.facet.associations.CategoryFloatAssociation
toString() - Method in class org.apache.lucene.facet.associations.CategoryIntAssociation
toString() - Method in class org.apache.lucene.facet.collections.ArrayHashMap
toString() - Method in class org.apache.lucene.facet.collections.FloatToObjectMap
toString() - Method in class org.apache.lucene.facet.collections.IntArray: toString or not toString.
toString() - Method in class org.apache.lucene.facet.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.facet.collections.IntToDoubleMap
toString() - Method in class org.apache.lucene.facet.collections.IntToFloatMap
toString() - Method in class org.apache.lucene.facet.collections.IntToIntMap
toString() - Method in class org.apache.lucene.facet.collections.IntToObjectMap
toString() - Method in class org.apache.lucene.facet.collections.ObjectToFloatMap
toString() - Method in class org.apache.lucene.facet.collections.ObjectToIntMap
toString() - Method in class org.apache.lucene.facet.encoding.DGapIntDecoder
toString() - Method in class org.apache.lucene.facet.encoding.DGapIntEncoder
toString() - Method in class org.apache.lucene.facet.encoding.DGapVInt8IntDecoder
toString() - Method in class org.apache.lucene.facet.encoding.DGapVInt8IntEncoder
toString() - Method in class org.apache.lucene.facet.encoding.EightFlagsIntDecoder
toString() - Method in class org.apache.lucene.facet.encoding.EightFlagsIntEncoder
toString() - Method in class org.apache.lucene.facet.encoding.FourFlagsIntDecoder
toString() - Method in class org.apache.lucene.facet.encoding.FourFlagsIntEncoder
toString() - Method in class org.apache.lucene.facet.encoding.NOnesIntDecoder
toString() - Method in class org.apache.lucene.facet.encoding.NOnesIntEncoder
toString() - Method in class org.apache.lucene.facet.encoding.SimpleIntDecoder
toString() - Method in class org.apache.lucene.facet.encoding.SimpleIntEncoder
toString() - Method in class org.apache.lucene.facet.encoding.SortingIntEncoder
toString() - Method in class org.apache.lucene.facet.encoding.UniqueValuesIntEncoder
toString() - Method in class org.apache.lucene.facet.encoding.VInt8IntDecoder
toString() - Method in class org.apache.lucene.facet.encoding.VInt8IntEncoder
toString() - Method in class org.apache.lucene.facet.params.CategoryListParams
toString() - Method in class org.apache.lucene.facet.params.FacetSearchParams
toString() - Method in class org.apache.lucene.facet.params.PerDimensionOrdinalPolicy
toString() - Method in class org.apache.lucene.facet.search.DocValuesCategoryListIterator
toString(String) - Method in class org.apache.lucene.facet.search.DrillDownQuery
toString() - Method in class org.apache.lucene.facet.search.FacetRequest
toString(String) - Method in class org.apache.lucene.facet.search.FacetResult: String representation of this facet result.
toString() - Method in class org.apache.lucene.facet.search.FacetResult
toString() - Method in class org.apache.lucene.facet.search.FacetResultNode
toString(String) - Method in class org.apache.lucene.facet.search.FacetResultNode: Returns a String representation of this facet result node.
toString() - Method in class org.apache.lucene.facet.taxonomy.CategoryPath: Returns a string representation of the path, separating components with '/'.
toString(char) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath: Returns a string representation of the path, separating components with the given delimiter.
toString(int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
TotalFacetCounts - Class in org.apache.lucene.facet.complements: 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.complements: Manage an LRU cache for TotalFacetCounts per index, taxonomy, and facet indexing params.
totalHits - Variable in class org.apache.lucene.facet.search.FacetsCollector.MatchingDocs
trimResult(FacetResult) - Method in class org.apache.lucene.facet.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).
tryIncRef(SearcherTaxonomyManager.SearcherAndTaxonomy) - Method in class org.apache.lucene.facet.search.SearcherTaxonomyManager
tryIncRef() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Expert: increments the refCount of this TaxonomyReader instance only if it has not been closed yet.

U

UniqueValuesIntEncoder - Class in org.apache.lucene.facet.encoding: An IntEncoderFilter which ensures only unique values are encoded.
UniqueValuesIntEncoder(IntEncoder) - Constructor for class org.apache.lucene.facet.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.

V

validate() - Method in class org.apache.lucene.facet.sampling.SamplingParams: Check validity of sampling settings, making sure that minSampleSize <= maxSampleSize <= samplingThreshold 0 < samplingRatio <= 1
value - Variable in class org.apache.lucene.facet.search.FacetResultNode: The value of this result.
valueOf(String) - Static method in enum org.apache.lucene.facet.params.CategoryListParams.OrdinalPolicy: Returns the enum constant of this type with the specified name.
valueOf(int) - Method in class org.apache.lucene.facet.search.DepthOneFacetResultsHandler: Returnt the value of the requested ordinal.
valueOf(String) - Static method in enum org.apache.lucene.facet.search.FacetRequest.FacetArraysSource: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.lucene.facet.search.FacetRequest.ResultMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.lucene.facet.search.FacetRequest.SortOrder: Returns the enum constant of this type with the specified name.
valueOf(int) - Method in class org.apache.lucene.facet.search.FloatFacetResultsHandler
valueOf(int) - Method in class org.apache.lucene.facet.search.IntFacetResultsHandler
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.params.CategoryListParams.OrdinalPolicy: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.lucene.facet.search.FacetRequest.FacetArraysSource: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.lucene.facet.search.FacetRequest.ResultMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.lucene.facet.search.FacetRequest.SortOrder: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.lucene.facet.taxonomy.writercache.lru.LruTaxonomyWriterCache.LRUType: Returns an array containing the constants of this enum type, in the order they are declared.
VERSION_CURRENT - Static variable in class org.apache.lucene.facet.codecs.facet42.Facet42DocValuesFormat
VERSION_START - Static variable in class org.apache.lucene.facet.codecs.facet42.Facet42DocValuesFormat
VInt8IntDecoder - Class in org.apache.lucene.facet.encoding: Decodes values encoded by VInt8IntEncoder.
VInt8IntDecoder() - Constructor for class org.apache.lucene.facet.encoding.VInt8IntDecoder
VInt8IntEncoder - Class in org.apache.lucene.facet.encoding: An IntEncoder which implements variable length encoding.
VInt8IntEncoder() - Constructor for class org.apache.lucene.facet.encoding.VInt8IntEncoder

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