Index (Lucene 4.7.1 API)

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

A

accept(double) - Method in class org.apache.lucene.facet.range.DoubleRange: True if this range accepts the provided value.
accept(long) - Method in class org.apache.lucene.facet.range.LongRange: True if this range accepts the provided value.
acceptsDocsOutOfOrder() - Method in class org.apache.lucene.facet.FacetsCollector
add(String, String...) - Method in class org.apache.lucene.facet.DrillDownQuery: Adds one dimension of drill downs; if you pass the same dimension more than once it is OR'd with the previous cofnstraints on that dimension, and all dimensions are AND'd against each other and the base query.
add(String, Query) - Method in class org.apache.lucene.facet.DrillDownQuery: Expert: add a custom drill-down subQuery.
add(String, Filter) - Method in class org.apache.lucene.facet.DrillDownQuery: Expert: add a custom drill-down Filter, e.g.
addCategory(FacetLabel) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
addCategory(FacetLabel) - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyWriter: addCategory() adds a category with a given path name to the taxonomy, and returns its ordinal.
addDoc(int) - Method in class org.apache.lucene.facet.FacetsCollector.Docs: Record the given document.
addDone() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.DiskOrdinalMap
addDone() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.MemoryOrdinalMap
addDone() - Method in interface org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.OrdinalMap: Call addDone() to say that all addMapping() have been done.
addLabel(FacetLabel, int, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.CollisionMap: Add another mapping.
addLabel(FacetLabel, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.CompactLabelToOrdinal
addLabel(FacetLabel, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.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.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: Record a mapping.
addTaxonomy(Directory, DirectoryTaxonomyWriter.OrdinalMap) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Takes the categories from the given taxonomy directory, and adds the missing ones to this taxonomy.
assoc - Variable in class org.apache.lucene.facet.taxonomy.AssociationFacetField: Associated value.
AssociationFacetField - Class in org.apache.lucene.facet.taxonomy: Add an instance of this to your Document to add a facet label associated with an arbitrary byte[].
AssociationFacetField(BytesRef, String, String...) - Constructor for class org.apache.lucene.facet.taxonomy.AssociationFacetField: Creates this from dim and path and an association

B

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

C

CachedOrdinalsReader - Class in org.apache.lucene.facet.taxonomy: A per-segment cache of documents' facet ordinals.
CachedOrdinalsReader(OrdinalsReader) - Constructor for class org.apache.lucene.facet.taxonomy.CachedOrdinalsReader: Sole constructor.
CachedOrdinalsReader.CachedOrds - Class in org.apache.lucene.facet.taxonomy: Holds the cached ordinals in two paralel int[] arrays.
CachedOrdinalsReader.CachedOrds(OrdinalsReader.OrdinalsSegmentReader, int) - Constructor for class org.apache.lucene.facet.taxonomy.CachedOrdinalsReader.CachedOrds: Creates a new CachedOrdinalsReader.CachedOrds from the BinaryDocValues.
capacity() - Method in class org.apache.lucene.facet.taxonomy.writercache.CollisionMap: How many slots are allocated.
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.
childCount - Variable in class org.apache.lucene.facet.FacetResult: How many child labels were encountered.
children() - Method in class org.apache.lucene.facet.taxonomy.ParallelTaxonomyArrays: Returns the children array, where children[i] denotes a child of category ordinal i.
children - Variable in class org.apache.lucene.facet.taxonomy.TaxonomyFacets: Maps parent ordinal to its child, or -1 if the parent is childless.
Cl2oTaxonomyWriterCache - Class in org.apache.lucene.facet.taxonomy.writercache: TaxonomyWriterCache using CompactLabelToOrdinal.
Cl2oTaxonomyWriterCache(int, float, int) - Constructor for class org.apache.lucene.facet.taxonomy.writercache.Cl2oTaxonomyWriterCache: Sole constructor.
clear() - Method in class org.apache.lucene.facet.taxonomy.writercache.Cl2oTaxonomyWriterCache
clear() - Method in class org.apache.lucene.facet.taxonomy.writercache.LruTaxonomyWriterCache
clear() - Method in interface org.apache.lucene.facet.taxonomy.writercache.TaxonomyWriterCache: Clears the content of the cache.
clone() - Method in class org.apache.lucene.facet.DrillDownQuery
clone() - Method in class org.apache.lucene.facet.taxonomy.LRUHashMap
close() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Frees used resources as well as closes the underlying IndexWriter, which commits whatever changes made to it to the underlying Directory.
close() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader
close() - Method in class org.apache.lucene.facet.taxonomy.writercache.Cl2oTaxonomyWriterCache
close() - Method in class org.apache.lucene.facet.taxonomy.writercache.LruTaxonomyWriterCache
close() - Method in interface org.apache.lucene.facet.taxonomy.writercache.TaxonomyWriterCache: Let go of whatever resources the cache is holding.
closeResources() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: A hook for extending classes to close additional resources that were used.
collect(int) - Method in class org.apache.lucene.facet.FacetsCollector
CollisionMap - Class in org.apache.lucene.facet.taxonomy.writercache: 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: 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.CompactLabelToOrdinal: Sole constructor.
compareTo(CategoryPath) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath: Compares this path with another CategoryPath for lexicographic order.
compareTo(FacetLabel) - Method in class org.apache.lucene.facet.taxonomy.FacetLabel: Compares this path with another FacetLabel for lexicographic order.
components - Variable in class org.apache.lucene.facet.taxonomy.CategoryPath: The components of this CategoryPath.
components - Variable in class org.apache.lucene.facet.taxonomy.FacetLabel: The components of this FacetLabel.
config - Variable in class org.apache.lucene.facet.DrillSideways: FacetsConfig passed to constructor.
config - Variable in class org.apache.lucene.facet.taxonomy.TaxonomyFacets: FacetsConfig provided to the constructor.
context - Variable in class org.apache.lucene.facet.FacetsCollector.MatchingDocs: Context for this segment.
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.LabelToOrdinal: How many ordinals we've seen.
createDocs(int) - Method in class org.apache.lucene.facet.FacetsCollector: Creates a FacetsCollector.Docs to record hits.
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.

D

decode(BytesRef, IntsRef) - Method in class org.apache.lucene.facet.taxonomy.DocValuesOrdinalsReader: Subclass & override if you change the encoding.
decRef(SearcherTaxonomyManager.SearcherAndTaxonomy) - Method in class org.apache.lucene.facet.taxonomy.SearcherTaxonomyManager
decRef() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Expert: decreases the refCount of this TaxonomyReader instance.
dedupAndEncode(IntsRef) - Method in class org.apache.lucene.facet.FacetsConfig: Encodes ordinals into a BytesRef; expert: subclass can override this to change encoding.
DEFAULT_DIM_CONFIG - Static variable in class org.apache.lucene.facet.FacetsConfig: Default per-dimension configuration.
DEFAULT_INDEX_FIELD_NAME - Static variable in class org.apache.lucene.facet.FacetsConfig: Which Lucene field holds the drill-downs and ords (as doc values).
DefaultLoadFactor - Static variable in class org.apache.lucene.facet.taxonomy.writercache.CompactLabelToOrdinal: Default maximum load factor.
DefaultSortedSetDocValuesReaderState - Class in org.apache.lucene.facet.sortedset: Default implementation of SortedSetDocValuesFacetCounts
DefaultSortedSetDocValuesReaderState(IndexReader) - Constructor for class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState: Creates this, pulling doc values from the default FacetsConfig.DEFAULT_INDEX_FIELD_NAME.
DefaultSortedSetDocValuesReaderState(IndexReader, String) - Constructor for class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState: Creates this, pulling doc values from the specified field.
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.
description() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyFacetSumValueSource.ScoreValueSource
dim - Variable in class org.apache.lucene.facet.FacetField: Dimension for this field.
dim - Variable in class org.apache.lucene.facet.FacetResult: Dimension that was requested.
dim - Variable in class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetField: Dimension.
dim - Variable in class org.apache.lucene.facet.taxonomy.AssociationFacetField: Dimension for this field.
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: Create this with OpenMode.CREATE_OR_APPEND.
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: Sole constructor.
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: Sole constructor.
DirectoryTaxonomyWriter.OrdinalMap - Interface in org.apache.lucene.facet.taxonomy.directory: Mapping from old ordinal to new ordinals, used when merging indexes wit separate taxonomies.
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.
DocValuesOrdinalsReader - Class in org.apache.lucene.facet.taxonomy: Decodes ordinals previously indexed into a BinaryDocValues field
DocValuesOrdinalsReader() - Constructor for class org.apache.lucene.facet.taxonomy.DocValuesOrdinalsReader: Default constructor.
DocValuesOrdinalsReader(String) - Constructor for class org.apache.lucene.facet.taxonomy.DocValuesOrdinalsReader: Create this, with the specified indexed field name.
doOpenIfChanged() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader: Implements the opening of a new DirectoryTaxonomyReader instance if the taxonomy has changed.
doOpenIfChanged() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Implements the actual opening of a new TaxonomyReader instance if the taxonomy has changed.
DoubleRange - Class in org.apache.lucene.facet.range: Represents a range over double values.
DoubleRange(String, double, boolean, double, boolean) - Constructor for class org.apache.lucene.facet.range.DoubleRange: Create a DoubleRange.
DoubleRangeFacetCounts - Class in org.apache.lucene.facet.range: Facets implementation that computes counts for dynamic double ranges from a provided ValueSource, using FunctionValues.doubleVal(int).
DoubleRangeFacetCounts(String, FacetsCollector, DoubleRange...) - Constructor for class org.apache.lucene.facet.range.DoubleRangeFacetCounts: Create RangeFacetCounts, using DoubleFieldSource from the specified field.
DoubleRangeFacetCounts(String, ValueSource, FacetsCollector, DoubleRange...) - Constructor for class org.apache.lucene.facet.range.DoubleRangeFacetCounts: Create RangeFacetCounts, using the provided ValueSource.
DoubleRangeFacetCounts(String, ValueSource, FacetsCollector, Filter, DoubleRange...) - Constructor for class org.apache.lucene.facet.range.DoubleRangeFacetCounts: Create RangeFacetCounts, using the provided ValueSource, and using the provided Filter as a fastmatch: only documents passing the filter are checked for the matching ranges.
DrillDownQuery - Class in org.apache.lucene.facet: A Query for drill-down over facet categories.
DrillDownQuery(FacetsConfig) - Constructor for class org.apache.lucene.facet.DrillDownQuery: Creates a new DrillDownQuery without a base query, to perform a pure browsing query (equivalent to using MatchAllDocsQuery as base).
DrillDownQuery(FacetsConfig, Query) - Constructor for class org.apache.lucene.facet.DrillDownQuery: Creates a new DrillDownQuery over the given base query.
DrillSideways - Class in org.apache.lucene.facet: Computes drill down and sideways counts for the provided DrillDownQuery.
DrillSideways(IndexSearcher, FacetsConfig, TaxonomyReader) - Constructor for class org.apache.lucene.facet.DrillSideways: Create a new DrillSideways instance.
DrillSideways(IndexSearcher, FacetsConfig, SortedSetDocValuesReaderState) - Constructor for class org.apache.lucene.facet.DrillSideways: Create a new DrillSideways instance, assuming the categories were indexed with SortedSetDocValuesFacetField.
DrillSideways(IndexSearcher, FacetsConfig, TaxonomyReader, SortedSetDocValuesReaderState) - Constructor for class org.apache.lucene.facet.DrillSideways: Create a new DrillSideways instance, where some dimensions were indexed with SortedSetDocValuesFacetField and others were indexed with FacetField.
DrillSideways.DrillSidewaysResult - Class in org.apache.lucene.facet: Result of a drill sideways search, including the Facets and TopDocs.
DrillSideways.DrillSidewaysResult(Facets, TopDocs) - Constructor for class org.apache.lucene.facet.DrillSideways.DrillSidewaysResult: Sole constructor.

E

EMPTY - Static variable in class org.apache.lucene.facet.taxonomy.CategoryPath: An empty CategoryPath
end - Variable in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState.OrdRange: End of range, inclusive:
ensureOpen() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Verifies that this instance wasn't closed, or throws AlreadyClosedException if it is.
ensureOpen() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Throws AlreadyClosedException if this IndexReader is closed
equals(Object) - Method in class org.apache.lucene.facet.DrillDownQuery
equals(Object) - Method in class org.apache.lucene.facet.FacetResult
equals(Object) - Method in class org.apache.lucene.facet.LabelAndValue
equals(Object) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
equals(Object) - Method in class org.apache.lucene.facet.taxonomy.FacetLabel
equals(Object) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyFacetSumValueSource.ScoreValueSource

F

FacetField - Class in org.apache.lucene.facet: Add an instance of this to your Document for every facet label.
FacetField(String, String...) - Constructor for class org.apache.lucene.facet.FacetField: Creates the this from dim and path.
FacetLabel - Class in org.apache.lucene.facet.taxonomy: Holds a sequence of string components, specifying the hierarchical name of a category.
FacetLabel(String...) - Constructor for class org.apache.lucene.facet.taxonomy.FacetLabel: Construct from the given path components.
FacetLabel(String, String[]) - Constructor for class org.apache.lucene.facet.taxonomy.FacetLabel: Construct from the dimension plus the given path components.
FacetResult - Class in org.apache.lucene.facet: Counts or aggregates for a single dimension.
FacetResult(String, String[], Number, LabelAndValue[], int) - Constructor for class org.apache.lucene.facet.FacetResult: Sole constructor.
facets - Variable in class org.apache.lucene.facet.DrillSideways.DrillSidewaysResult: Combined drill down & sideways results.
Facets - Class in org.apache.lucene.facet: Common base class for all facets implementations.
Facets() - Constructor for class org.apache.lucene.facet.Facets: Default constructor.
FacetsCollector - Class in org.apache.lucene.facet: Collects hits for subsequent faceting.
FacetsCollector() - Constructor for class org.apache.lucene.facet.FacetsCollector: Default constructor
FacetsCollector(boolean) - Constructor for class org.apache.lucene.facet.FacetsCollector: Create this; if keepScores is true then a float[] is allocated to hold score of all hits.
FacetsCollector.Docs - Class in org.apache.lucene.facet: Used during collection to record matching docs and then return a DocIdSet that contains them.
FacetsCollector.Docs() - Constructor for class org.apache.lucene.facet.FacetsCollector.Docs: Solr constructor.
FacetsCollector.MatchingDocs - Class in org.apache.lucene.facet: Holds the documents that were matched in the AtomicReaderContext.
FacetsCollector.MatchingDocs(AtomicReaderContext, DocIdSet, int, float[]) - Constructor for class org.apache.lucene.facet.FacetsCollector.MatchingDocs: Sole constructor.
FacetsConfig - Class in org.apache.lucene.facet: Records per-dimension configuration.
FacetsConfig() - Constructor for class org.apache.lucene.facet.FacetsConfig: Default constructor.
FacetsConfig.DimConfig - Class in org.apache.lucene.facet: Holds the configuration for one dimension
FacetsConfig.DimConfig() - Constructor for class org.apache.lucene.facet.FacetsConfig.DimConfig: Default constructor.
failNoMatch() - Method in class org.apache.lucene.facet.range.Range: Invoke this for a useless range.
FastTaxonomyFacetCounts - Class in org.apache.lucene.facet.taxonomy: Computes facets counts, assuming the default encoding into DocValues was used.
FastTaxonomyFacetCounts(TaxonomyReader, FacetsConfig, FacetsCollector) - Constructor for class org.apache.lucene.facet.taxonomy.FastTaxonomyFacetCounts: Create FastTaxonomyFacetCounts, which also counts all facet labels.
FastTaxonomyFacetCounts(String, TaxonomyReader, FacetsConfig, FacetsCollector) - Constructor for class org.apache.lucene.facet.taxonomy.FastTaxonomyFacetCounts: Create FastTaxonomyFacetCounts, using the specified indexFieldName for ordinals.
findCategory(FacetLabel) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Look up the given category in the cache and/or the on-disk storage, returning the category's ordinal, or a negative number in case the category does not yet exist in the taxonomy.
FloatAssociationFacetField - Class in org.apache.lucene.facet.taxonomy: Add an instance of this to your Document to add a facet label associated with a float.
FloatAssociationFacetField(float, String, String...) - Constructor for class org.apache.lucene.facet.taxonomy.FloatAssociationFacetField: Creates this from dim and path and a float association
FloatTaxonomyFacets - Class in org.apache.lucene.facet.taxonomy: Base class for all taxonomy-based facets that aggregate to a per-ords float[].
FloatTaxonomyFacets(String, TaxonomyReader, FacetsConfig) - Constructor for class org.apache.lucene.facet.taxonomy.FloatTaxonomyFacets: Sole constructor.
floatToBytesRef(float) - Static method in class org.apache.lucene.facet.taxonomy.FloatAssociationFacetField: Encodes a float as a 4-byte BytesRef.
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(int, IntsRef) - Method in class org.apache.lucene.facet.taxonomy.OrdinalsReader.OrdinalsSegmentReader: Get the ordinals for this document.
get(FacetLabel) - Method in class org.apache.lucene.facet.taxonomy.writercache.Cl2oTaxonomyWriterCache
get(FacetLabel, int) - Method in class org.apache.lucene.facet.taxonomy.writercache.CollisionMap: Return the mapping, or LabelToOrdinal.INVALID_ORDINAL if the label isn't recognized.
get(FacetLabel) - Method in class org.apache.lucene.facet.taxonomy.writercache.LruTaxonomyWriterCache
get(FacetLabel) - Method in interface org.apache.lucene.facet.taxonomy.writercache.TaxonomyWriterCache: Lookup a category in the cache, returning its ordinal, or a negative number if the category is not in the cache.
getAllDims(int) - Method in class org.apache.lucene.facet.Facets: Returns topN labels for any dimension that had hits, sorted by the number of hits that dimension matched; this is used for "sparse" faceting, where many different dimensions were indexed, for example depending on the type of document.
getAllDims(int) - Method in class org.apache.lucene.facet.MultiFacets
getAllDims(int) - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetCounts
getAllDims(int) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyFacets
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.
getDimConfig(String) - Method in class org.apache.lucene.facet.FacetsConfig: Get the current configuration for a dimension.
getDimConfigs() - Method in class org.apache.lucene.facet.FacetsConfig: Returns map of field name to FacetsConfig.DimConfig.
getDirectory() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Returns the Directory of this taxonomy writer.
getDocIdSet() - Method in class org.apache.lucene.facet.FacetsCollector.Docs: Return the DocIdSet which contains all the recorded docs.
getDocValues() - Method in class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState: Return top-level doc values.
getDocValues() - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Return top-level doc values.
getField() - Method in class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState: Indexed field we are reading.
getField() - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Indexed field we are reading.
getFilter(Filter, ValueSource) - Method in class org.apache.lucene.facet.range.DoubleRange
getFilter(Filter, ValueSource) - Method in class org.apache.lucene.facet.range.LongRange
getFilter(Filter, ValueSource) - Method in class org.apache.lucene.facet.range.Range: Returns a new Filter accepting only documents in this range.
getFilter(ValueSource) - Method in class org.apache.lucene.facet.range.Range: Returns a new Filter accepting only documents in this range.
getIndexFieldName() - Method in class org.apache.lucene.facet.taxonomy.CachedOrdinalsReader
getIndexFieldName() - Method in class org.apache.lucene.facet.taxonomy.DocValuesOrdinalsReader
getIndexFieldName() - Method in class org.apache.lucene.facet.taxonomy.OrdinalsReader: Returns the indexed field name this OrdinalsReader is reading from.
getKeepScores() - Method in class org.apache.lucene.facet.FacetsCollector: True if scores were saved.
getMap() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.DiskOrdinalMap
getMap() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.MemoryOrdinalMap
getMap() - Method in interface org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.OrdinalMap: Return the map from the taxonomy's original (consecutive) ordinals to the new taxonomy's ordinals.
getMatchingDocs() - Method in class org.apache.lucene.facet.FacetsCollector: Returns the documents matched by the query, one FacetsCollector.MatchingDocs per visited segment.
getMaxOrdinal() - Method in class org.apache.lucene.facet.taxonomy.writercache.LabelToOrdinal: return the maximal Ordinal assigned so far
getMaxSize() - Method in class org.apache.lucene.facet.taxonomy.LRUHashMap: Return the max size
getMemoryUsage() - Method in class org.apache.lucene.facet.taxonomy.writercache.Cl2oTaxonomyWriterCache: Returns the number of bytes in memory used by this object.
getNextOrdinal() - Method in class org.apache.lucene.facet.taxonomy.writercache.LabelToOrdinal: Returns the next unassigned ordinal.
getOrdinal(FacetLabel) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getOrdinal(FacetLabel) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Returns the ordinal of the category given as a path.
getOrdinal(String, String[]) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Returns ordinal for the dim + path.
getOrdinal(FacetLabel) - Method in class org.apache.lucene.facet.taxonomy.writercache.CompactLabelToOrdinal
getOrdinal(FacetLabel) - Method in class org.apache.lucene.facet.taxonomy.writercache.LabelToOrdinal: Returns the ordinal assigned to the given label, or LabelToOrdinal.INVALID_ORDINAL if the label cannot be found in this table.
getOrdRange(String) - Method in class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState: Returns the SortedSetDocValuesReaderState.OrdRange for this dimension.
getOrdRange(String) - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Returns the SortedSetDocValuesReaderState.OrdRange for this dimension.
getOrigReader() - Method in class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState
getOrigReader() - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Returns top-level index reader.
getParallelTaxonomyArrays() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getParallelTaxonomyArrays() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Returns a ParallelTaxonomyArrays object which can be used to efficiently traverse the taxonomy tree.
getParent(int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
getParent(int) - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyWriter: getParent() returns the ordinal of the parent category of the category with the given ordinal.
getPath(int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getPath(int) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Returns the path name of the category with the given ordinal.
getPrefixToOrdRange() - Method in class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState: Returns mapping from prefix to SortedSetDocValuesReaderState.OrdRange.
getPrefixToOrdRange() - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Returns mapping from prefix to SortedSetDocValuesReaderState.OrdRange.
getReader(AtomicReaderContext) - Method in class org.apache.lucene.facet.taxonomy.CachedOrdinalsReader
getReader(AtomicReaderContext) - Method in class org.apache.lucene.facet.taxonomy.DocValuesOrdinalsReader
getReader(AtomicReaderContext) - Method in class org.apache.lucene.facet.taxonomy.OrdinalsReader: Set current atomic reader.
getRefCount(SearcherTaxonomyManager.SearcherAndTaxonomy) - Method in class org.apache.lucene.facet.taxonomy.SearcherTaxonomyManager
getRefCount() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Returns the current refCount for this taxonomy reader.
getSize() - Method in class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState: Number of unique labels.
getSize() - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Number of unique labels.
getSize() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader
getSize() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter
getSize() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Returns the number of categories in the taxonomy.
getSize() - Method in interface org.apache.lucene.facet.taxonomy.TaxonomyWriter: getSize() returns the number of categories in the taxonomy.
getSpecificValue(String, String...) - Method in class org.apache.lucene.facet.Facets: Return the count or value for a specific path.
getSpecificValue(String, String...) - Method in class org.apache.lucene.facet.MultiFacets
getSpecificValue(String, String...) - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetCounts
getSpecificValue(String, String...) - Method in class org.apache.lucene.facet.taxonomy.FloatTaxonomyFacets
getSpecificValue(String, String...) - Method in class org.apache.lucene.facet.taxonomy.IntTaxonomyFacets
getTaxonomyEpoch() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Expert: returns current index epoch, if this is a near-real-time reader.
getTopChildren(int, String, String...) - Method in class org.apache.lucene.facet.Facets: Returns the topN child labels under the specified path.
getTopChildren(int, String, String...) - Method in class org.apache.lucene.facet.MultiFacets
getTopChildren(int, String, String...) - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetCounts
getTopChildren(int, String, String...) - Method in class org.apache.lucene.facet.taxonomy.FloatTaxonomyFacets
getTopChildren(int, String, String...) - Method in class org.apache.lucene.facet.taxonomy.IntTaxonomyFacets
getValues(Map, AtomicReaderContext) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyFacetSumValueSource.ScoreValueSource

H

hashCode() - Method in class org.apache.lucene.facet.DrillDownQuery
hashCode() - Method in class org.apache.lucene.facet.FacetResult
hashCode() - Method in class org.apache.lucene.facet.LabelAndValue
hashCode() - Method in class org.apache.lucene.facet.taxonomy.CategoryPath
hashCode() - Method in class org.apache.lucene.facet.taxonomy.FacetLabel
hashCode() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyFacetSumValueSource.ScoreValueSource
hierarchical - Variable in class org.apache.lucene.facet.FacetsConfig.DimConfig: True if this dimension is hierarchical.
hits - Variable in class org.apache.lucene.facet.DrillSideways.DrillSidewaysResult: Hits.

I

incRef() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Expert: increments the refCount of this TaxonomyReader instance.
INDEX_EPOCH - Static variable in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Property name of user commit data that contains the index epoch.
indexFieldName - Variable in class org.apache.lucene.facet.FacetsConfig.DimConfig: Actual field where this dimension's facet labels should be indexed
indexFieldName - Variable in class org.apache.lucene.facet.taxonomy.TaxonomyFacets: Index field name provided to the constructor.
IntAssociationFacetField - Class in org.apache.lucene.facet.taxonomy: Add an instance of this to your Document to add a facet label associated with an int.
IntAssociationFacetField(int, String, String...) - Constructor for class org.apache.lucene.facet.taxonomy.IntAssociationFacetField: Creates this from dim and path and an int association
IntTaxonomyFacets - Class in org.apache.lucene.facet.taxonomy: Base class for all taxonomy-based facets that aggregate to a per-ords int[].
IntTaxonomyFacets(String, TaxonomyReader, FacetsConfig) - Constructor for class org.apache.lucene.facet.taxonomy.IntTaxonomyFacets: Sole constructor.
intToBytesRef(int) - Static method in class org.apache.lucene.facet.taxonomy.IntAssociationFacetField: Encodes an int as a 4-byte BytesRef, big-endian.
INVALID_ORDINAL - Static variable in class org.apache.lucene.facet.taxonomy.TaxonomyReader: Ordinals are always non-negative, so a negative ordinal can be used to signify an error.
INVALID_ORDINAL - Static variable in class org.apache.lucene.facet.taxonomy.writercache.LabelToOrdinal: Returned by LabelToOrdinal.getOrdinal(org.apache.lucene.facet.taxonomy.FacetLabel) when the label isn't recognized.
isFull() - Method in class org.apache.lucene.facet.taxonomy.writercache.Cl2oTaxonomyWriterCache
isFull() - Method in class org.apache.lucene.facet.taxonomy.writercache.LruTaxonomyWriterCache
isFull() - Method in interface org.apache.lucene.facet.taxonomy.writercache.TaxonomyWriterCache: Returns true if the cache is full, such that the next TaxonomyWriterCache.put(org.apache.lucene.facet.taxonomy.FacetLabel, int) will evict entries from it, false otherwise.

L

label - Variable in class org.apache.lucene.facet.LabelAndValue: Facet's label.
label - Variable in class org.apache.lucene.facet.range.Range: Label that identifies this range.
label - Variable in class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetField: Label.
LabelAndValue - Class in org.apache.lucene.facet: Single label and its value, usually contained in a FacetResult.
LabelAndValue(String, Number) - Constructor for class org.apache.lucene.facet.LabelAndValue: Sole constructor.
LabelToOrdinal - Class in org.apache.lucene.facet.taxonomy.writercache: Abstract class for storing Label->Ordinal mappings in a taxonomy.
LabelToOrdinal() - Constructor for class org.apache.lucene.facet.taxonomy.writercache.LabelToOrdinal: Default constructor.
labelValues - Variable in class org.apache.lucene.facet.FacetResult: Child counts.
length - Variable in class org.apache.lucene.facet.taxonomy.CategoryPath: The number of components of this CategoryPath.
length - Variable in class org.apache.lucene.facet.taxonomy.FacetLabel: The number of components of this FacetLabel.
lessThan(TopOrdAndFloatQueue.OrdAndValue, TopOrdAndFloatQueue.OrdAndValue) - Method in class org.apache.lucene.facet.TopOrdAndFloatQueue
lessThan(TopOrdAndIntQueue.OrdAndValue, TopOrdAndIntQueue.OrdAndValue) - Method in class org.apache.lucene.facet.TopOrdAndIntQueue
longHashCode() - Method in class org.apache.lucene.facet.taxonomy.CategoryPath: Calculate a 64-bit hash function for this path.
longHashCode() - Method in class org.apache.lucene.facet.taxonomy.FacetLabel: Calculate a 64-bit hash function for this path.
LongRange - Class in org.apache.lucene.facet.range: Represents a range over long values.
LongRange(String, long, boolean, long, boolean) - Constructor for class org.apache.lucene.facet.range.LongRange: Create a LongRange.
LongRangeFacetCounts - Class in org.apache.lucene.facet.range: Facets implementation that computes counts for dynamic long ranges from a provided ValueSource, using FunctionValues.longVal(int).
LongRangeFacetCounts(String, FacetsCollector, LongRange...) - Constructor for class org.apache.lucene.facet.range.LongRangeFacetCounts: Create LongRangeFacetCounts, using LongFieldSource from the specified field.
LongRangeFacetCounts(String, ValueSource, FacetsCollector, LongRange...) - Constructor for class org.apache.lucene.facet.range.LongRangeFacetCounts: Create RangeFacetCounts, using the provided ValueSource.
LongRangeFacetCounts(String, ValueSource, FacetsCollector, Filter, LongRange...) - Constructor for class org.apache.lucene.facet.range.LongRangeFacetCounts: Create RangeFacetCounts, using the provided ValueSource, and using the provided Filter as a fastmatch: only documents passing the filter are checked for the matching ranges.
LRUHashMap<K,V> - Class in org.apache.lucene.facet.taxonomy: LRUHashMap is an extension of Java's HashMap, which has a bounded size(); When it reaches that size, each time a new element is added, the least recently used (LRU) entry is removed.
LRUHashMap(int) - Constructor for class org.apache.lucene.facet.taxonomy.LRUHashMap: Create a new hash map with a bounded size and with least recently used entries removed.
LruTaxonomyWriterCache - Class in org.apache.lucene.facet.taxonomy.writercache: LRU TaxonomyWriterCache - good choice for huge taxonomies.
LruTaxonomyWriterCache(int) - Constructor for class org.apache.lucene.facet.taxonomy.writercache.LruTaxonomyWriterCache: Creates this with LruTaxonomyWriterCache.LRUType.LRU_HASHED method.
LruTaxonomyWriterCache(int, LruTaxonomyWriterCache.LRUType) - Constructor for class org.apache.lucene.facet.taxonomy.writercache.LruTaxonomyWriterCache: Creates this with the specified method.
LruTaxonomyWriterCache.LRUType - Enum in org.apache.lucene.facet.taxonomy.writercache: Determines cache type.

M

main(String[]) - Static method in class org.apache.lucene.facet.taxonomy.PrintTaxonomyStats: Command-line tool.
max - Variable in class org.apache.lucene.facet.range.DoubleRange: Maximum.
max - Variable in class org.apache.lucene.facet.range.LongRange: Maximum.
MAX_CATEGORY_PATH_LENGTH - Static variable in class org.apache.lucene.facet.taxonomy.FacetLabel: The maximum number of characters a FacetLabel can have.
maxInclusive - Variable in class org.apache.lucene.facet.range.DoubleRange: True if the maximum value is inclusive.
maxInclusive - Variable in class org.apache.lucene.facet.range.LongRange: True if the maximum value is inclusive.
min - Variable in class org.apache.lucene.facet.range.DoubleRange: Minimum.
min - Variable in class org.apache.lucene.facet.range.LongRange: Minimum.
minInclusive - Variable in class org.apache.lucene.facet.range.DoubleRange: True if the minimum value is inclusive.
minInclusive - Variable in class org.apache.lucene.facet.range.LongRange: True if the minimum value is inclusive.
MultiFacets - Class in org.apache.lucene.facet: Maps specified dims to provided Facets impls; else, uses the default Facets impl.
MultiFacets(Map<String, Facets>) - Constructor for class org.apache.lucene.facet.MultiFacets: Create this, with no default Facets.
MultiFacets(Map<String, Facets>, Facets) - Constructor for class org.apache.lucene.facet.MultiFacets: Create this, with the specified default Facets for fields not included in dimToFacets.
multiValued - Variable in class org.apache.lucene.facet.FacetsConfig.DimConfig: True if this dimension is multi-valued.

N

NameHashIntCacheLRU - Class in org.apache.lucene.facet.taxonomy.writercache: An an LRU cache of mapping from name to int.
next() - Method in class org.apache.lucene.facet.taxonomy.TaxonomyReader.ChildrenIterator: Return the next child ordinal, or TaxonomyReader.INVALID_ORDINAL if no more children.

O

offsets - Variable in class org.apache.lucene.facet.taxonomy.CachedOrdinalsReader.CachedOrds: Index into CachedOrdinalsReader.CachedOrds.ordinals for each document.
openIfChanged(T) - Static method in class org.apache.lucene.facet.taxonomy.TaxonomyReader: If the taxonomy has changed since the provided reader was opened, open and return a new TaxonomyReader; else, return null.
openIndexReader(Directory) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader: Open the DirectoryReader from this Directory.
openIndexReader(IndexWriter) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader: Open the DirectoryReader from this IndexWriter.
openIndexWriter(Directory, IndexWriterConfig) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Open internal index writer, which contains the taxonomy data.
ord - Variable in class org.apache.lucene.facet.TopOrdAndFloatQueue.OrdAndValue: Ordinal of the entry.
ord - Variable in class org.apache.lucene.facet.TopOrdAndIntQueue.OrdAndValue: Ordinal of the entry.
ordinals - Variable in class org.apache.lucene.facet.taxonomy.CachedOrdinalsReader.CachedOrds: Holds ords for all docs.
OrdinalsReader - Class in org.apache.lucene.facet.taxonomy: Provides per-document ordinals.
OrdinalsReader() - Constructor for class org.apache.lucene.facet.taxonomy.OrdinalsReader: Default constructor.
OrdinalsReader.OrdinalsSegmentReader - Class in org.apache.lucene.facet.taxonomy: Returns ordinals for documents in one segment.
OrdinalsReader.OrdinalsSegmentReader() - Constructor for class org.apache.lucene.facet.taxonomy.OrdinalsReader.OrdinalsSegmentReader: Default constructor.
org.apache.lucene.facet - package org.apache.lucene.facet: faceted search
org.apache.lucene.facet.range - package org.apache.lucene.facet.range: Provides range faceting capabilities.
org.apache.lucene.facet.sortedset - package org.apache.lucene.facet.sortedset: Provides faceting capabilities over facets that were indexed with SortedSetDocValuesFacetField.
org.apache.lucene.facet.taxonomy - package org.apache.lucene.facet.taxonomy: Taxonomy of Categories
org.apache.lucene.facet.taxonomy.directory - package org.apache.lucene.facet.taxonomy.directory: Taxonomy index implementation using on top of a Directory.
org.apache.lucene.facet.taxonomy.writercache - package org.apache.lucene.facet.taxonomy.writercache: Improves indexing time by caching a map of CategoryPath to their Ordinal.
origReader - Variable in class org.apache.lucene.facet.sortedset.DefaultSortedSetDocValuesReaderState: IndexReader passed to the constructor.

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

R

ramBytesUsed() - Method in class org.apache.lucene.facet.taxonomy.CachedOrdinalsReader: How many bytes is this cache using?
Range - Class in org.apache.lucene.facet.range: Base class for a single labeled range.
Range(String) - Constructor for class org.apache.lucene.facet.range.Range: Sole constructor.
refreshIfNeeded(SearcherTaxonomyManager.SearcherAndTaxonomy) - Method in class org.apache.lucene.facet.taxonomy.SearcherTaxonomyManager
removeEldestEntry(Map.Entry<K, V>) - Method in class org.apache.lucene.facet.taxonomy.LRUHashMap
replaceTaxonomy(Directory) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Replaces the current taxonomy with the given one.
requireDimCount - Variable in class org.apache.lucene.facet.FacetsConfig.DimConfig: True if the count/aggregate for the entire dimension is required, which is unusual (default is false).
rewrite(IndexReader) - Method in class org.apache.lucene.facet.DrillDownQuery
rollback() - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Rollback changes to the taxonomy writer and closes the instance.
rollup() - Method in class org.apache.lucene.facet.taxonomy.FloatTaxonomyFacets: Rolls up any single-valued hierarchical dimensions.
rollup() - Method in class org.apache.lucene.facet.taxonomy.IntTaxonomyFacets: Rolls up any single-valued hierarchical dimensions.
ROOT_ORDINAL - Static variable in class org.apache.lucene.facet.taxonomy.TaxonomyReader: The root category (the category with the empty path) always has the ordinal 0, to which we give a name ROOT_ORDINAL.

S

scores - Variable in class org.apache.lucene.facet.FacetsCollector.MatchingDocs: Non-sparse scores array.
scoreSubDocsAtOnce() - Method in class org.apache.lucene.facet.DrillSideways: Override this and return true if your collector (e.g., ToParentBlockJoinCollector) expects all sub-scorers to be positioned on the document being collected.
search(DrillDownQuery, Collector) - Method in class org.apache.lucene.facet.DrillSideways: Search, collecting hits with a Collector, and computing drill down and sideways counts.
search(DrillDownQuery, Filter, FieldDoc, int, Sort, boolean, boolean) - Method in class org.apache.lucene.facet.DrillSideways: Search, sorting by Sort, and computing drill down and sideways counts.
search(DrillDownQuery, int) - Method in class org.apache.lucene.facet.DrillSideways: Search, sorting by score, and computing drill down and sideways counts.
search(ScoreDoc, DrillDownQuery, int) - Method in class org.apache.lucene.facet.DrillSideways: Search, sorting by score, and computing drill down and sideways counts.
search(IndexSearcher, Query, int, Collector) - Static method in class org.apache.lucene.facet.FacetsCollector: Utility method, to search and also collect all hits into the provided Collector.
search(IndexSearcher, Query, Filter, int, Collector) - Static method in class org.apache.lucene.facet.FacetsCollector: Utility method, to search and also collect all hits into the provided Collector.
search(IndexSearcher, Query, Filter, int, Sort, Collector) - Static method in class org.apache.lucene.facet.FacetsCollector: Utility method, to search and also collect all hits into the provided Collector.
search(IndexSearcher, Query, Filter, int, Sort, boolean, boolean, Collector) - Static method in class org.apache.lucene.facet.FacetsCollector: Utility method, to search and also collect all hits into the provided Collector.
searchAfter(IndexSearcher, ScoreDoc, Query, int, Collector) - Method in class org.apache.lucene.facet.FacetsCollector: Utility method, to search and also collect all hits into the provided Collector.
searchAfter(IndexSearcher, ScoreDoc, Query, Filter, int, Collector) - Static method in class org.apache.lucene.facet.FacetsCollector: Utility method, to search and also collect all hits into the provided Collector.
searchAfter(IndexSearcher, ScoreDoc, Query, Filter, int, Sort, Collector) - Static method in class org.apache.lucene.facet.FacetsCollector: Utility method, to search and also collect all hits into the provided Collector.
searchAfter(IndexSearcher, ScoreDoc, Query, Filter, int, Sort, boolean, boolean, Collector) - Static method in class org.apache.lucene.facet.FacetsCollector: Utility method, to search and also collect all hits into the provided Collector.
searcher - Variable in class org.apache.lucene.facet.DrillSideways: IndexSearcher passed to constructor.
searcher - Variable in class org.apache.lucene.facet.taxonomy.SearcherTaxonomyManager.SearcherAndTaxonomy: Point-in-time IndexSearcher.
SearcherTaxonomyManager - Class in org.apache.lucene.facet.taxonomy: Manages near-real-time reopen of both an IndexSearcher and a TaxonomyReader.
SearcherTaxonomyManager(IndexWriter, boolean, SearcherFactory, DirectoryTaxonomyWriter) - Constructor for class org.apache.lucene.facet.taxonomy.SearcherTaxonomyManager: Creates near-real-time searcher and taxonomy reader from the corresponding writers.
SearcherTaxonomyManager(Directory, Directory, SearcherFactory) - Constructor for class org.apache.lucene.facet.taxonomy.SearcherTaxonomyManager: Creates search and taxonomy readers over the corresponding directories.
SearcherTaxonomyManager.SearcherAndTaxonomy - Class in org.apache.lucene.facet.taxonomy: Holds a matched pair of IndexSearcher and TaxonomyReader
SearcherTaxonomyManager.SearcherAndTaxonomy(IndexSearcher, DirectoryTaxonomyReader) - Constructor for class org.apache.lucene.facet.taxonomy.SearcherTaxonomyManager.SearcherAndTaxonomy: Create a SearcherAndTaxonomy
setCacheMissesUntilFill(int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Set the number of cache misses before an attempt is made to read the entire taxonomy into the in-memory cache.
setCacheSize(int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyReader: setCacheSize controls the maximum allowed size of each of the caches used by DirectoryTaxonomyReader.getPath(int) and DirectoryTaxonomyReader.getOrdinal(FacetLabel).
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.
setHierarchical(String, boolean) - Method in class org.apache.lucene.facet.FacetsConfig: Pass true if this dimension is hierarchical (has depth > 1 paths).
setIndexFieldName(String, String) - Method in class org.apache.lucene.facet.FacetsConfig: Specify which index field name should hold the ordinals for this dimension; this is only used by the taxonomy based facet methods.
setMaxSize(int) - Method in class org.apache.lucene.facet.taxonomy.LRUHashMap: setMaxSize() allows changing the map's maximal number of elements which was defined at construction time.
setMultiValued(String, boolean) - Method in class org.apache.lucene.facet.FacetsConfig: Pass true if this dimension may have more than one value per document.
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.facet.FacetsCollector
setRequireDimCount(String, boolean) - Method in class org.apache.lucene.facet.FacetsConfig: Pass true if at search time you require accurate counts of the dimension, i.e.
setScorer(Scorer) - Method in class org.apache.lucene.facet.FacetsCollector
setSize(int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.DiskOrdinalMap
setSize(int) - Method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.MemoryOrdinalMap
setSize(int) - Method in interface org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter.OrdinalMap: Set the size of the map.
siblings() - Method in class org.apache.lucene.facet.taxonomy.ParallelTaxonomyArrays: Returns the siblings array, where siblings[i] denotes the sibling of category ordinal i.
siblings - Variable in class org.apache.lucene.facet.taxonomy.TaxonomyFacets: Maps an ordinal to its sibling, or -1 if there is no sibling.
size() - Method in class org.apache.lucene.facet.taxonomy.writercache.CollisionMap: How many mappings.
sizeOfMap() - Method in class org.apache.lucene.facet.taxonomy.writercache.CompactLabelToOrdinal: How many labels.
SortedSetDocValuesFacetCounts - Class in org.apache.lucene.facet.sortedset: Compute facets counts from previously indexed SortedSetDocValuesFacetField, without require a separate taxonomy index.
SortedSetDocValuesFacetCounts(SortedSetDocValuesReaderState, FacetsCollector) - Constructor for class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetCounts: Sparse faceting: returns any dimension that had any hits, topCount labels per dimension.
SortedSetDocValuesFacetField - Class in org.apache.lucene.facet.sortedset: Add an instance of this to your Document for every facet label to be indexed via SortedSetDocValues.
SortedSetDocValuesFacetField(String, String) - Constructor for class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetField: Sole constructor.
SortedSetDocValuesReaderState - Class in org.apache.lucene.facet.sortedset: Wraps a IndexReader and resolves ords using existing SortedSetDocValues APIs without a separate taxonomy index.
SortedSetDocValuesReaderState() - Constructor for class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState: Sole constructor.
SortedSetDocValuesReaderState.OrdRange - Class in org.apache.lucene.facet.sortedset: Holds start/end range of ords, which maps to one dimension (someday we may generalize it to map to hierarchies within one dimension).
SortedSetDocValuesReaderState.OrdRange(int, int) - Constructor for class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState.OrdRange: Start and end are inclusive.
start - Variable in class org.apache.lucene.facet.sortedset.SortedSetDocValuesReaderState.OrdRange: Start of range, inclusive:
state - Variable in class org.apache.lucene.facet.DrillSideways: SortedSetDocValuesReaderState passed to constructor; can be null.
stringToPath(String) - Static method in class org.apache.lucene.facet.FacetsConfig: Turns an encoded string (from a previous call to FacetsConfig.pathToString(java.lang.String, java.lang.String[])) back into the original String[].
subpath(int) - Method in class org.apache.lucene.facet.taxonomy.CategoryPath: Returns a sub-path of this path up to length components.
subpath(int) - Method in class org.apache.lucene.facet.taxonomy.FacetLabel: Returns a sub-path of this path up to length components.

T

TaxonomyFacetCounts - Class in org.apache.lucene.facet.taxonomy: Reads from any OrdinalsReader; use FastTaxonomyFacetCounts if you are using the default encoding from BinaryDocValues.
TaxonomyFacetCounts(OrdinalsReader, TaxonomyReader, FacetsConfig, FacetsCollector) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetCounts: Create TaxonomyFacetCounts, which also counts all facet labels.
TaxonomyFacets - Class in org.apache.lucene.facet.taxonomy: Base class for all taxonomy-based facets impls.
TaxonomyFacets(String, TaxonomyReader, FacetsConfig) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacets: Sole constructor.
TaxonomyFacetSumFloatAssociations - Class in org.apache.lucene.facet.taxonomy: Aggregates sum of int values previously indexed with FloatAssociationFacetField, assuming the default encoding.
TaxonomyFacetSumFloatAssociations(TaxonomyReader, FacetsConfig, FacetsCollector) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetSumFloatAssociations: Create TaxonomyFacetSumFloatAssociations against the default index field.
TaxonomyFacetSumFloatAssociations(String, TaxonomyReader, FacetsConfig, FacetsCollector) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetSumFloatAssociations: Create TaxonomyFacetSumFloatAssociations against the specified index field.
TaxonomyFacetSumIntAssociations - Class in org.apache.lucene.facet.taxonomy: Aggregates sum of int values previously indexed with IntAssociationFacetField, assuming the default encoding.
TaxonomyFacetSumIntAssociations(TaxonomyReader, FacetsConfig, FacetsCollector) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetSumIntAssociations: Create TaxonomyFacetSumIntAssociations against the default index field.
TaxonomyFacetSumIntAssociations(String, TaxonomyReader, FacetsConfig, FacetsCollector) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetSumIntAssociations: Create TaxonomyFacetSumIntAssociations against the specified index field.
TaxonomyFacetSumValueSource - Class in org.apache.lucene.facet.taxonomy: Aggregates sum of values from FunctionValues.doubleVal(int), for each facet label.
TaxonomyFacetSumValueSource(TaxonomyReader, FacetsConfig, FacetsCollector, ValueSource) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetSumValueSource: Aggreggates float facet values from the provided ValueSource, pulling ordinals using DocValuesOrdinalsReader against the default indexed facet field FacetsConfig.DEFAULT_INDEX_FIELD_NAME.
TaxonomyFacetSumValueSource(OrdinalsReader, TaxonomyReader, FacetsConfig, FacetsCollector, ValueSource) - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetSumValueSource: Aggreggates float facet values from the provided ValueSource, and pulls ordinals from the provided OrdinalsReader.
TaxonomyFacetSumValueSource.ScoreValueSource - Class in org.apache.lucene.facet.taxonomy: ValueSource that returns the score for each hit; use this to aggregate the sum of all hit scores for each facet label.
TaxonomyFacetSumValueSource.ScoreValueSource() - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyFacetSumValueSource.ScoreValueSource: Sole constructor.
taxonomyReader - Variable in class org.apache.lucene.facet.taxonomy.SearcherTaxonomyManager.SearcherAndTaxonomy: Matching point-in-time DirectoryTaxonomyReader.
TaxonomyReader - Class in org.apache.lucene.facet.taxonomy: TaxonomyReader is the read-only interface with which the faceted-search library uses the taxonomy during search time.
TaxonomyReader() - Constructor for class org.apache.lucene.facet.taxonomy.TaxonomyReader: Sole constructor.
TaxonomyReader.ChildrenIterator - Class in org.apache.lucene.facet.taxonomy: An iterator over a category's children.
TaxonomyWriter - Interface in org.apache.lucene.facet.taxonomy: TaxonomyWriter is the interface which the faceted-search library uses to dynamically build the taxonomy at indexing time.
TaxonomyWriterCache - Interface in org.apache.lucene.facet.taxonomy.writercache: TaxonomyWriterCache is a relatively simple interface for a cache of category->ordinal mappings, used in TaxonomyWriter implementations (such as DirectoryTaxonomyWriter).
taxoReader - Variable in class org.apache.lucene.facet.DrillSideways: TaxonomyReader passed to constructor.
taxoReader - Variable in class org.apache.lucene.facet.taxonomy.TaxonomyFacets: TaxonomyReader provided to the constructor.
term(String, String, String...) - Static method in class org.apache.lucene.facet.DrillDownQuery: Creates a drill-down term.
TopOrdAndFloatQueue - Class in org.apache.lucene.facet: Keeps highest results, first by largest float value, then tie break by smallest ord.
TopOrdAndFloatQueue(int) - Constructor for class org.apache.lucene.facet.TopOrdAndFloatQueue: Sole constructor.
TopOrdAndFloatQueue.OrdAndValue - Class in org.apache.lucene.facet: Holds a single entry.
TopOrdAndFloatQueue.OrdAndValue() - Constructor for class org.apache.lucene.facet.TopOrdAndFloatQueue.OrdAndValue: Default constructor.
TopOrdAndIntQueue - Class in org.apache.lucene.facet: Keeps highest results, first by largest int value, then tie break by smallest ord.
TopOrdAndIntQueue(int) - Constructor for class org.apache.lucene.facet.TopOrdAndIntQueue: Sole constructor.
TopOrdAndIntQueue.OrdAndValue - Class in org.apache.lucene.facet: Holds a single entry.
TopOrdAndIntQueue.OrdAndValue() - Constructor for class org.apache.lucene.facet.TopOrdAndIntQueue.OrdAndValue: Default constructor.
toString(String) - Method in class org.apache.lucene.facet.DrillDownQuery
toString() - Method in class org.apache.lucene.facet.FacetField
toString() - Method in class org.apache.lucene.facet.FacetResult
toString() - Method in class org.apache.lucene.facet.LabelAndValue
toString() - Method in class org.apache.lucene.facet.range.DoubleRange
toString() - Method in class org.apache.lucene.facet.range.LongRange
toString() - Method in class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetField
toString() - Method in class org.apache.lucene.facet.taxonomy.AssociationFacetField
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: Returns ordinal -> label mapping, up to the provided max ordinal or number of ordinals, whichever is smaller.
toString() - Method in class org.apache.lucene.facet.taxonomy.FacetLabel: Returns a string representation of the path.
toString() - Method in class org.apache.lucene.facet.taxonomy.FloatAssociationFacetField
toString() - Method in class org.apache.lucene.facet.taxonomy.IntAssociationFacetField
totalHits - Variable in class org.apache.lucene.facet.FacetsCollector.MatchingDocs: Total number of hits
tryIncRef(SearcherTaxonomyManager.SearcherAndTaxonomy) - Method in class org.apache.lucene.facet.taxonomy.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.
TYPE - Static variable in class org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetField: Indexed FieldType.
TYPE - Static variable in class org.apache.lucene.facet.taxonomy.AssociationFacetField: Indexed FieldType.

U

unlock(Directory) - Static method in class org.apache.lucene.facet.taxonomy.directory.DirectoryTaxonomyWriter: Forcibly unlocks the taxonomy in the named directory.

V

value - Variable in class org.apache.lucene.facet.FacetResult: Total value for this path (sum of all child counts, or sum of all child values), even those not included in the topN.
value - Variable in class org.apache.lucene.facet.LabelAndValue: Value associated with this label.
value - Variable in class org.apache.lucene.facet.TopOrdAndFloatQueue.OrdAndValue: Value associated with the ordinal.
value - Variable in class org.apache.lucene.facet.TopOrdAndIntQueue.OrdAndValue: Value associated with the ordinal.
valueOf(String) - Static method in enum org.apache.lucene.facet.taxonomy.writercache.LruTaxonomyWriterCache.LRUType: Returns the enum constant of this type with the specified name.
values - Variable in class org.apache.lucene.facet.taxonomy.FloatTaxonomyFacets: Per-ordinal value.
values - Variable in class org.apache.lucene.facet.taxonomy.IntTaxonomyFacets: Per-ordinal value.
values() - Static method in enum org.apache.lucene.facet.taxonomy.writercache.LruTaxonomyWriterCache.LRUType: Returns an array containing the constants of this enum type, in the order they are declared.
verifyDim(String) - Method in class org.apache.lucene.facet.taxonomy.TaxonomyFacets: Throws IllegalArgumentException if the dimension is not recognized.
verifyLabel(String) - Static method in class org.apache.lucene.facet.FacetField: Verifies the label is not null or empty string.

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