Uses of Package
org.apache.lucene.index

Packages that use org.apache.lucene.index

Package	Description
org.apache.lucene.analysis.query	Automatically filter high-frequency stopwords.
org.apache.lucene.codecs	Codecs API: API for customization of the encoding and structure of the index.
org.apache.lucene.codecs.blocktree	BlockTree terms dictionary.
org.apache.lucene.codecs.compressing	StoredFieldsFormat that allows cross-document and cross-field compression of stored fields.
org.apache.lucene.codecs.idversion	A primary-key postings format that associates a version (long) with each term and can provide fail-fast lookups by ID and version.
org.apache.lucene.codecs.lucene50	Components from the Lucene 5.0 index format See org.apache.lucene.codecs.lucene53 for an overview of the index format.
org.apache.lucene.codecs.lucene53	Components from the Lucene 5.3 index format See org.apache.lucene.codecs.lucene54 for an overview of the index format.
org.apache.lucene.codecs.lucene54	Lucene 5.4 file format.
org.apache.lucene.codecs.lucene60	Lucene 6.0 file format.
org.apache.lucene.codecs.perfield	Postings format that can delegate to different formats per-field.
org.apache.lucene.collation	Unicode collation support.
org.apache.lucene.document	The logical representation of a Document for indexing and searching.
org.apache.lucene.geo	Geospatial Utility Implementations for Lucene Core
org.apache.lucene.index	Code to maintain and access indices.
org.apache.lucene.index.memory	High-performance single-document main memory Apache Lucene fulltext search index.
org.apache.lucene.misc	Miscellaneous index tools.
org.apache.lucene.payloads	Experimental classes for interacting with payloads
org.apache.lucene.queries	Filters and Queries that add to core Lucene.
org.apache.lucene.queries.function	Queries that compute score based upon a function.
org.apache.lucene.queries.function.docvalues	FunctionValues for different data types.
org.apache.lucene.queries.function.valuesource	A variety of functions to use with FunctionQuery.
org.apache.lucene.queries.mlt	Document similarity query generators.
org.apache.lucene.queries.payloads	The payloads package provides Query mechanisms for finding and using payloads.
org.apache.lucene.queryparser.classic	A simple query parser implemented with JavaCC.
org.apache.lucene.queryparser.complexPhrase	QueryParser which permits complex phrase query syntax eg "(john jon jonathan~) peters*"
org.apache.lucene.queryparser.surround.query	This package contains SrndQuery and its subclasses.
org.apache.lucene.sandbox.queries	Additional queries (some may have caveats or limitations)
org.apache.lucene.search	Code to search indices.
org.apache.lucene.search.grouping	Grouping.
org.apache.lucene.search.grouping.function	Support for grouping by ValueSource.
org.apache.lucene.search.grouping.term	Support for grouping by indexed terms via DocValues.
org.apache.lucene.search.highlight	Highlighting search terms.
org.apache.lucene.search.join	Support for index-time and query-time joins.
org.apache.lucene.search.postingshighlight	Highlighter implementation that uses offsets from postings lists.
org.apache.lucene.search.similarities	This package contains the various ranking models that can be used in Lucene.
org.apache.lucene.search.spans	The calculus of spans.
org.apache.lucene.search.vectorhighlight	Another highlighter implementation based on term vectors.
org.apache.lucene.uninverting	Support for creating docvalues on-the-fly from the inverted index at runtime.
org.apache.lucene.util	Some utility classes.
org.apache.lucene.util.automaton	Finite-state automaton for regular expressions.
org.apache.lucene.util.bkd	Block KD-tree, implementing the generic spatial data structure described in this paper.
org.apache.lucene.util.packed	Packed integer arrays and streams.

Classes in org.apache.lucene.index used by org.apache.lucene.analysis.query

Class and Description
IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
Term A Term represents a word from text.

Classes in org.apache.lucene.index used by org.apache.lucene.codecs

Class and Description
BinaryDocValues A per-document byte[]
FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.
FieldInfos Collection of FieldInfos (accessible by number or by name).
Fields Flex API for access to fields and terms
FilteredTermsEnum Abstract class for enumerating a subset of all terms.
FilteredTermsEnum.AcceptStatus Return value, if term should be accepted or the iteration should END.
IndexableField Represents a single field for indexing.
IndexableFieldType Describes the properties of a field.
IndexOptions Controls how much information is stored in the postings lists.
MergeState Holds common state used during segment merging.
NumericDocValues A per-document numeric value.
OrdTermState An ordinal based TermState
PointValues Access to indexed numeric values.
PostingsEnum Iterates through the postings.
SegmentCommitInfo Embeds a [read-only] SegmentInfo and adds per-commit fields.
SegmentInfo Information about a segment such as its name, directory, and files related to the segment.
SegmentReadState Holder class for common parameters used during read.
SegmentWriteState Holder class for common parameters used during write.
SortedDocValues A per-document byte[] with presorted values.
SortedNumericDocValues A list of per-document numeric values, sorted according to Long.compare(long, long).
SortedSetDocValues A per-document set of presorted byte[] values.
StoredFieldVisitor Expert: provides a low-level means of accessing the stored field values in an index.
StoredFieldVisitor.Status Enumeration of possible return values for StoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo).
TermsEnum Iterator to seek (TermsEnum.seekCeil(BytesRef), TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq()), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).
TermState Encapsulates all required internal state to position the associated TermsEnum without re-seeking.

Classes in org.apache.lucene.index used by org.apache.lucene.codecs.blocktree

Class and Description
FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.
FieldInfos Collection of FieldInfos (accessible by number or by name).
Fields Flex API for access to fields and terms
PostingsEnum Iterates through the postings.
SegmentReadState Holder class for common parameters used during read.
SegmentWriteState Holder class for common parameters used during write.
Terms Access to the terms in a specific field.
TermsEnum Iterator to seek (TermsEnum.seekCeil(BytesRef), TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq()), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).
TermsEnum.SeekStatus Represents returned result from TermsEnum.seekCeil(org.apache.lucene.util.BytesRef).
TermState Encapsulates all required internal state to position the associated TermsEnum without re-seeking.

Classes in org.apache.lucene.index used by org.apache.lucene.codecs.compressing

Class and Description
FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.
FieldInfos Collection of FieldInfos (accessible by number or by name).
Fields Flex API for access to fields and terms
IndexableField Represents a single field for indexing.
MergeState Holds common state used during segment merging.
PostingsEnum Iterates through the postings.
SegmentInfo Information about a segment such as its name, directory, and files related to the segment.
StoredFieldVisitor Expert: provides a low-level means of accessing the stored field values in an index.
Terms Access to the terms in a specific field.
TermsEnum Iterator to seek (TermsEnum.seekCeil(BytesRef), TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq()), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).
TermsEnum.SeekStatus Represents returned result from TermsEnum.seekCeil(org.apache.lucene.util.BytesRef).

Classes in org.apache.lucene.index used by org.apache.lucene.codecs.idversion

Class and Description
FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.
FieldInfos Collection of FieldInfos (accessible by number or by name).
Fields Flex API for access to fields and terms
OrdTermState An ordinal based TermState
PostingsEnum Iterates through the postings.
SegmentReadState Holder class for common parameters used during read.
SegmentWriteState Holder class for common parameters used during write.
Terms Access to the terms in a specific field.
TermsEnum Iterator to seek (TermsEnum.seekCeil(BytesRef), TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq()), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).
TermsEnum.SeekStatus Represents returned result from TermsEnum.seekCeil(org.apache.lucene.util.BytesRef).
TermState Encapsulates all required internal state to position the associated TermsEnum without re-seeking.

Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene50

Class and Description
DocValuesType DocValues types.
FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.
FieldInfos Collection of FieldInfos (accessible by number or by name).
IndexOptions Controls how much information is stored in the postings lists.
OrdTermState An ordinal based TermState
PostingsEnum Iterates through the postings.
SegmentCommitInfo Embeds a [read-only] SegmentInfo and adds per-commit fields.
SegmentInfo Information about a segment such as its name, directory, and files related to the segment.
SegmentReadState Holder class for common parameters used during read.
SegmentWriteState Holder class for common parameters used during write.
TermState Encapsulates all required internal state to position the associated TermsEnum without re-seeking.

Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene53

Class and Description
FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.
FieldInfos Collection of FieldInfos (accessible by number or by name).
NumericDocValues A per-document numeric value.
SegmentReadState Holder class for common parameters used during read.
SegmentWriteState Holder class for common parameters used during write.

Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene54

Class and Description
BinaryDocValues A per-document byte[]
FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.
FieldInfos Collection of FieldInfos (accessible by number or by name).
NumericDocValues A per-document numeric value.
PostingsEnum Iterates through the postings.
SegmentReadState Holder class for common parameters used during read.
SegmentWriteState Holder class for common parameters used during write.
SortedDocValues A per-document byte[] with presorted values.
SortedNumericDocValues A list of per-document numeric values, sorted according to Long.compare(long, long).
SortedSetDocValues A per-document set of presorted byte[] values.
TermsEnum Iterator to seek (TermsEnum.seekCeil(BytesRef), TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq()), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).
TermsEnum.SeekStatus Represents returned result from TermsEnum.seekCeil(org.apache.lucene.util.BytesRef).

Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene60

Class and Description
DocValuesType DocValues types.
FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.
FieldInfos Collection of FieldInfos (accessible by number or by name).
IndexOptions Controls how much information is stored in the postings lists.
MergeState Holds common state used during segment merging.
PointValues Access to indexed numeric values.
PointValues.IntersectVisitor We recurse the BKD tree, using a provided instance of this to guide the recursion.
SegmentInfo Information about a segment such as its name, directory, and files related to the segment.
SegmentReadState Holder class for common parameters used during read.
SegmentWriteState Holder class for common parameters used during write.

Classes in org.apache.lucene.index used by org.apache.lucene.codecs.perfield

Class and Description
BinaryDocValues A per-document byte[]
FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.
Fields Flex API for access to fields and terms
NumericDocValues A per-document numeric value.
SegmentReadState Holder class for common parameters used during read.
SegmentWriteState Holder class for common parameters used during write.
SortedDocValues A per-document byte[] with presorted values.
SortedNumericDocValues A list of per-document numeric values, sorted according to Long.compare(long, long).
SortedSetDocValues A per-document set of presorted byte[] values.
Terms Access to the terms in a specific field.

Classes in org.apache.lucene.index used by org.apache.lucene.collation

Class and Description
IndexableField Represents a single field for indexing.

Classes in org.apache.lucene.index used by org.apache.lucene.document

Class and Description
DocValuesType DocValues types.
FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.
IndexableField Represents a single field for indexing.
IndexableFieldType Describes the properties of a field.
IndexOptions Controls how much information is stored in the postings lists.
IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
LeafReaderContext IndexReaderContext for LeafReader instances.
PointValues.IntersectVisitor We recurse the BKD tree, using a provided instance of this to guide the recursion.
PointValues.Relation Used by PointValues.intersect(java.lang.String, org.apache.lucene.index.PointValues.IntersectVisitor) to check how each recursive cell corresponds to the query.
SortedNumericDocValues A list of per-document numeric values, sorted according to Long.compare(long, long).
StoredFieldVisitor Expert: provides a low-level means of accessing the stored field values in an index.
StoredFieldVisitor.Status Enumeration of possible return values for StoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo).

Classes in org.apache.lucene.index used by org.apache.lucene.geo

Class and Description
PointValues.Relation Used by PointValues.intersect(java.lang.String, org.apache.lucene.index.PointValues.IntersectVisitor) to check how each recursive cell corresponds to the query.

Classes in org.apache.lucene.index used by org.apache.lucene.index

Class and Description
AbortingException Thrown and caught internally in IndexWriter methods when an IOException would cause it to lose previously indexed documents.
BaseCompositeReader Base class for implementing CompositeReaders based on an array of sub-readers.
BinaryDocValues A per-document byte[]
BinaryDocValuesFieldUpdates A DocValuesFieldUpdates which holds updates of documents, of a single BinaryDocValuesField.
BinaryDocValuesFieldUpdates.Iterator
BufferedUpdates
BufferedUpdatesStream
BufferedUpdatesStream.ApplyDeletesResult
BufferedUpdatesStream.QueryAndLimit
BufferedUpdatesStream.SegmentState
ByteSliceReader
CheckIndex.Options Run-time configuration options for CheckIndex commands.
CheckIndex.Status Returned from CheckIndex.checkIndex() detailing the health and status of the index.
CheckIndex.Status.DocValuesStatus Status from testing DocValues
CheckIndex.Status.FieldInfoStatus Status from testing field infos.
CheckIndex.Status.FieldNormStatus Status from testing field norms.
CheckIndex.Status.LiveDocStatus Status from testing livedocs
CheckIndex.Status.PointsStatus Status from testing PointValues
CheckIndex.Status.SegmentInfoStatus Holds the status of each segment in the index.
CheckIndex.Status.StoredFieldStatus Status from testing stored fields.
CheckIndex.Status.TermIndexStatus Status from testing term index.
CheckIndex.Status.TermVectorStatus Status from testing stored fields.
CoalescedUpdates
CodecReader LeafReader implemented by codec APIs.
CompositeReader Instances of this reader type can only be used to get stored fields from the underlying LeafReaders, but it is not possible to directly retrieve postings.
CompositeReaderContext IndexReaderContext for CompositeReader instance.
ConcurrentMergeScheduler.MergeThread Runs a merge thread to execute a single merge, then exits.
DefaultIndexingChain.PerField NOTE: not static: accesses at least docState, termsHash.
DirectoryReader DirectoryReader is an implementation of CompositeReader that can read indexes in a Directory.
DocConsumer
DocumentsWriter This class accepts multiple added documents and directly writes segment files.
DocumentsWriterDeleteQueue DocumentsWriterDeleteQueue is a non-blocking linked pending deletes queue.
DocumentsWriterDeleteQueue.DeleteSlice
DocumentsWriterDeleteQueue.Node
DocumentsWriterFlushControl This class controls DocumentsWriterPerThread flushing during indexing.
DocumentsWriterFlushControl.BlockedFlush
DocumentsWriterFlushQueue
DocumentsWriterFlushQueue.FlushTicket
DocumentsWriterFlushQueue.SegmentFlushTicket
DocumentsWriterPerThread
DocumentsWriterPerThread.DocState
DocumentsWriterPerThread.FlushedSegment
DocumentsWriterPerThread.IndexingChain The IndexingChain must define the DocumentsWriterPerThread.IndexingChain.getChain(DocumentsWriterPerThread) method which returns the DocConsumer that the DocumentsWriter calls to process the documents.
DocumentsWriterPerThreadPool DocumentsWriterPerThreadPool controls DocumentsWriterPerThreadPool.ThreadState instances and their thread assignments during indexing.
DocumentsWriterPerThreadPool.ThreadState DocumentsWriterPerThreadPool.ThreadState references and guards a DocumentsWriterPerThread instance that is used during indexing to build a in-memory index segment.
DocumentsWriterStallControl Controls the health status of a DocumentsWriter sessions.
DocValuesFieldUpdates Holds updates of a single DocValues field, for a set of documents.
DocValuesFieldUpdates.Container
DocValuesFieldUpdates.Iterator An iterator over documents and their updated values.
DocValuesType DocValues types.
DocValuesUpdate An in-place update to a DocValues field.
DocValuesUpdate.BinaryDocValuesUpdate An in-place update to a binary DocValues field
DocValuesUpdate.NumericDocValuesUpdate An in-place update to a numeric DocValues field
DocValuesWriter
FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.
FieldInfos Collection of FieldInfos (accessible by number or by name).
FieldInfos.Builder
FieldInfos.FieldDimensions
FieldInfos.FieldNumbers
FieldInvertState This class tracks the number and position / offset parameters of terms being added to the index.
Fields Flex API for access to fields and terms
FieldTermIterator Iterates over terms in across multiple fields.
FilterCodecReader A FilterCodecReader contains another CodecReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.
FilterDirectoryReader A FilterDirectoryReader wraps another DirectoryReader, allowing implementations to transform or extend it.
FilterDirectoryReader.SubReaderWrapper Factory class passed to FilterDirectoryReader constructor that allows subclasses to wrap the filtered DirectoryReader's subreaders.
FilteredTermsEnum Abstract class for enumerating a subset of all terms.
FilteredTermsEnum.AcceptStatus Return value, if term should be accepted or the iteration should END.
FilterLeafReader A FilterLeafReader contains another LeafReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.
FilterLeafReader.FilterFields Base class for filtering Fields implementations.
FilterLeafReader.FilterPostingsEnum Base class for filtering PostingsEnum implementations.
FilterLeafReader.FilterTerms Base class for filtering Terms implementations.
FilterLeafReader.FilterTermsEnum Base class for filtering TermsEnum implementations.
FlushPolicy FlushPolicy controls when segments are flushed from a RAM resident internal data-structure to the IndexWriters Directory.
FreqProxTermsWriterPerField
FreqProxTermsWriterPerField.FreqProxPostingsArray
FrozenBufferedUpdates Holds buffered deletes and updates by term or query, once pushed.
IndexableField Represents a single field for indexing.
IndexableFieldType Describes the properties of a field.
IndexCommit Expert: represents a single commit into an index as seen by the IndexDeletionPolicy or IndexReader.
IndexDeletionPolicy Expert: policy for deletion of stale index commits.
IndexFileDeleter
IndexFileDeleter.CommitPoint Holds details for each commit point.
IndexFileDeleter.RefCount Tracks the reference count for a single index file:
IndexOptions Controls how much information is stored in the postings lists.
IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
IndexReader.ReaderClosedListener A custom listener that's invoked when the IndexReader is closed.
IndexReaderContext A struct like class that represents a hierarchical relationship between IndexReader instances.
IndexUpgrader This is an easy-to-use tool that upgrades all segments of an index from previous Lucene versions to the current segment file format.
IndexWriter An IndexWriter creates and maintains an index.
IndexWriter.Event Interface for internal atomic events.
IndexWriter.IndexReaderWarmer If DirectoryReader.open(IndexWriter) has been called (ie, this writer is in near real-time mode), then after a merge completes, this class can be invoked to warm the reader on the newly merged segment, before the merge commits.
IndexWriter.MergedDeletesAndUpdates
IndexWriter.ReaderPool Holds shared SegmentReader instances.
IndexWriterConfig Holds all the configuration that is used to create an IndexWriter.
IndexWriterConfig.OpenMode Specifies the open mode for IndexWriter.
LeafReader LeafReader is an abstract class, providing an interface for accessing an index.
LeafReader.CoreClosedListener Called when the shared core for this LeafReader is closed.
LeafReaderContext IndexReaderContext for LeafReader instances.
LiveIndexWriterConfig Holds all the configuration used by IndexWriter with few setters for settings that can be changed on an IndexWriter instance "live".
LogMergePolicy This class implements a MergePolicy that tries to merge segments into levels of exponentially increasing size, where each level has fewer segments than the value of the merge factor.
LogMergePolicy.SegmentInfoAndLevel
MappingMultiPostingsEnum Exposes flex API, merged from flex API of sub-segments, remapping docIDs (this is used for segment merging).
MergedPrefixCodedTermsIterator.FieldMergeQueue
MergedPrefixCodedTermsIterator.TermMergeQueue
MergePolicy Expert: a MergePolicy determines the sequence of primitive merge operations.
MergePolicy.DocMap A map of doc IDs.
MergePolicy.MergeAbortedException Thrown when a merge was explicity aborted because IndexWriter.abortMerges() was called.
MergePolicy.MergeSpecification A MergeSpecification instance provides the information necessary to perform multiple merges.
MergePolicy.OneMerge OneMerge provides the information necessary to perform an individual primitive merge operation, resulting in a single new segment.
MergePolicyWrapper A wrapper for MergePolicy instances.
MergeRateLimiter This is the RateLimiter that IndexWriter assigns to each running merge, to give MergeSchedulers ionice like control.
MergeRateLimiter.PauseResult Returned by MergeRateLimiter.maybePause(long, long).
MergeScheduler Expert: IndexWriter uses an instance implementing this interface to execute the merges selected by a MergePolicy.
MergeState Holds common state used during segment merging.
MergeState.DocMap Remaps docids around deletes during merge
MergeTrigger MergeTrigger is passed to MergePolicy.findMerges(MergeTrigger, org.apache.lucene.index.SegmentInfos, IndexWriter) to indicate the event that triggered the merge.
MultiBits.SubResult Represents a sub-Bits from getMatchingSub().
MultiDocValues.OrdinalMap maps per-segment ordinals to/from global ordinal space
MultiDocValues.OrdinalMap.SegmentMap
MultiFields Exposes flex API, merged from flex API of sub-segments.
MultiPassIndexSplitter.FakeDeleteLeafIndexReader
MultiPostingsEnum Exposes PostingsEnum, merged from PostingsEnum API of sub-segments.
MultiPostingsEnum.EnumWithSlice Holds a PostingsEnum along with the corresponding ReaderSlice.
MultiTerms Exposes flex API, merged from flex API of sub-segments.
MultiTermsEnum Exposes TermsEnum API, merged from TermsEnum API of sub-segments.
MultiTermsEnum.TermMergeQueue
MultiTermsEnum.TermsEnumIndex
MultiTermsEnum.TermsEnumWithSlice
NormValuesWriter Buffers up pending long per doc, then flushes when segment flushes.
NumericDocValues A per-document numeric value.
NumericDocValuesFieldUpdates A DocValuesFieldUpdates which holds updates of documents, of a single NumericDocValuesField.
NumericDocValuesFieldUpdates.Iterator
ParallelLeafReader.ParallelFields
ParallelPostingsArray
PointValues Access to indexed numeric values.
PointValues.IntersectVisitor We recurse the BKD tree, using a provided instance of this to guide the recursion.
PointValues.Relation Used by PointValues.intersect(java.lang.String, org.apache.lucene.index.PointValues.IntersectVisitor) to check how each recursive cell corresponds to the query.
PointValuesWriter Buffers up pending byte[][] value(s) per doc, then flushes when segment flushes.
PostingsEnum Iterates through the postings.
PrefixCodedTerms Prefix codes term instances (prefixes are shared)
PrefixCodedTerms.TermIterator An iterator over the list of terms stored in a PrefixCodedTerms.
QueryTimeout Base for query timeout implementations, which will provide a shouldExit() method, used with ExitableDirectoryReader.
RandomAccessOrds Extension of SortedSetDocValues that supports random access to the ordinals of a document.
ReadersAndUpdates
ReaderSlice Subreader slice from a parent composite reader.
SegmentCommitInfo Embeds a [read-only] SegmentInfo and adds per-commit fields.
SegmentCoreReaders Holds core readers that are shared (unchanged) when SegmentReader is cloned or reopened
SegmentDocValues Manages the DocValuesProducer held by SegmentReader and keeps track of their reference counting.
SegmentInfo Information about a segment such as its name, directory, and files related to the segment.
SegmentInfos A collection of segmentInfo objects with methods for operating on those segments in relation to the file system.
SegmentReader IndexReader implementation over a single segment.
SegmentReadState Holder class for common parameters used during read.
SegmentWriteState Holder class for common parameters used during write.
SnapshotDeletionPolicy An IndexDeletionPolicy that wraps any other IndexDeletionPolicy and adds the ability to hold and later release snapshots of an index.
SortedDocValues A per-document byte[] with presorted values.
SortedNumericDocValues A list of per-document numeric values, sorted according to Long.compare(long, long).
SortedSetDocValues A per-document set of presorted byte[] values.
Sorter Sorts documents of a given index by returning a permutation on the document IDs.
Sorter.DocComparator A comparator of doc IDs.
Sorter.DocMap A permutation of doc IDs.
SortingLeafReader.SortingDocsEnum
SortingLeafReader.SortingDocsEnum.DocFreqSorter
SortingLeafReader.SortingPostingsEnum
SortingLeafReader.SortingPostingsEnum.DocOffsetSorter A TimSorter which sorts two parallel arrays of doc IDs and offsets in one go.
StandardDirectoryReader Default implementation of DirectoryReader.
StoredFieldVisitor Expert: provides a low-level means of accessing the stored field values in an index.
StoredFieldVisitor.Status Enumeration of possible return values for StoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo).
Term A Term represents a word from text.
TermContext Maintains a IndexReader TermState view over IndexReader instances containing a single term.
Terms Access to the terms in a specific field.
TermsEnum Iterator to seek (TermsEnum.seekCeil(BytesRef), TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq()), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).
TermsEnum.SeekStatus Represents returned result from TermsEnum.seekCeil(org.apache.lucene.util.BytesRef).
TermsHash This class is passed each token produced by the analyzer on each field during indexing, and it stores these tokens in a hash table, and allocates separate byte streams per token.
TermsHashPerField
TermState Encapsulates all required internal state to position the associated TermsEnum without re-seeking.
TermVectorsConsumer
TermVectorsConsumerPerField
TermVectorsConsumerPerField.TermVectorsPostingsArray
TieredMergePolicy Merges segments of approximately equal size, subject to an allowed number of segments per tier.
TieredMergePolicy.MergeScore Holds score and explanation for a single candidate merge.
TwoPhaseCommit An interface for implementations that support 2-phase commit.
TwoPhaseCommitTool.CommitFailException Thrown by TwoPhaseCommitTool.execute(TwoPhaseCommit...) when an object fails to commit().
TwoPhaseCommitTool.PrepareCommitFailException Thrown by TwoPhaseCommitTool.execute(TwoPhaseCommit...) when an object fails to prepareCommit().

Classes in org.apache.lucene.index used by org.apache.lucene.index.memory

Class and Description
BinaryDocValues A per-document byte[]
DocValuesType DocValues types.
FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.
FieldInfos Collection of FieldInfos (accessible by number or by name).
Fields Flex API for access to fields and terms
IndexableField Represents a single field for indexing.
IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
LeafReader LeafReader is an abstract class, providing an interface for accessing an index.
LeafReader.CoreClosedListener Called when the shared core for this LeafReader is closed.
NumericDocValues A per-document numeric value.
PointValues Access to indexed numeric values.
PointValues.IntersectVisitor We recurse the BKD tree, using a provided instance of this to guide the recursion.
PostingsEnum Iterates through the postings.
SortedDocValues A per-document byte[] with presorted values.
SortedNumericDocValues A list of per-document numeric values, sorted according to Long.compare(long, long).
SortedSetDocValues A per-document set of presorted byte[] values.
StoredFieldVisitor Expert: provides a low-level means of accessing the stored field values in an index.
Terms Access to the terms in a specific field.
TermsEnum Iterator to seek (TermsEnum.seekCeil(BytesRef), TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq()), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).
TermsEnum.SeekStatus Represents returned result from TermsEnum.seekCeil(org.apache.lucene.util.BytesRef).
TermState Encapsulates all required internal state to position the associated TermsEnum without re-seeking.

Classes in org.apache.lucene.index used by org.apache.lucene.misc

Class and Description
FieldInvertState This class tracks the number and position / offset parameters of terms being added to the index.
IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
Term A Term represents a word from text.
TermsEnum Iterator to seek (TermsEnum.seekCeil(BytesRef), TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq()), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).

Classes in org.apache.lucene.index used by org.apache.lucene.payloads

Class and Description
IndexReaderContext A struct like class that represents a hierarchical relationship between IndexReader instances.
PostingsEnum Iterates through the postings.
Term A Term represents a word from text.

Classes in org.apache.lucene.index used by org.apache.lucene.queries

Class and Description
IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
LeafReaderContext IndexReaderContext for LeafReader instances.
PrefixCodedTerms Prefix codes term instances (prefixes are shared)
Term A Term represents a word from text.
TermContext Maintains a IndexReader TermState view over IndexReader instances containing a single term.
TermsEnum Iterator to seek (TermsEnum.seekCeil(BytesRef), TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq()), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).
TermState Encapsulates all required internal state to position the associated TermsEnum without re-seeking.

Classes in org.apache.lucene.index used by org.apache.lucene.queries.function

Class and Description
IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
LeafReaderContext IndexReaderContext for LeafReader instances.
Term A Term represents a word from text.

Classes in org.apache.lucene.index used by org.apache.lucene.queries.function.docvalues

Class and Description
LeafReaderContext IndexReaderContext for LeafReader instances.
SortedDocValues A per-document byte[] with presorted values.

Classes in org.apache.lucene.index used by org.apache.lucene.queries.function.valuesource

Class and Description
LeafReaderContext IndexReaderContext for LeafReader instances.

Classes in org.apache.lucene.index used by org.apache.lucene.queries.mlt

Class and Description
IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
Terms Access to the terms in a specific field.

Classes in org.apache.lucene.index used by org.apache.lucene.queries.payloads

Class and Description
LeafReaderContext IndexReaderContext for LeafReader instances.
PostingsEnum Iterates through the postings.
Term A Term represents a word from text.
TermContext Maintains a IndexReader TermState view over IndexReader instances containing a single term.

Classes in org.apache.lucene.index used by org.apache.lucene.queryparser.classic

Class and Description
Term A Term represents a word from text.

Classes in org.apache.lucene.index used by org.apache.lucene.queryparser.complexPhrase

Class and Description
IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
Term A Term represents a word from text.

Classes in org.apache.lucene.index used by org.apache.lucene.queryparser.surround.query

Class and Description
IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
Term A Term represents a word from text.

Classes in org.apache.lucene.index used by org.apache.lucene.sandbox.queries

Class and Description
FilteredTermsEnum Abstract class for enumerating a subset of all terms.
FilteredTermsEnum.AcceptStatus Return value, if term should be accepted or the iteration should END.
IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
Term A Term represents a word from text.
Terms Access to the terms in a specific field.
TermsEnum Iterator to seek (TermsEnum.seekCeil(BytesRef), TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq()), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).

Classes in org.apache.lucene.index used by org.apache.lucene.search

Class and Description
BinaryDocValues A per-document byte[]
DirectoryReader DirectoryReader is an implementation of CompositeReader that can read indexes in a Directory.
FilteredTermsEnum Abstract class for enumerating a subset of all terms.
FilteredTermsEnum.AcceptStatus Return value, if term should be accepted or the iteration should END.
IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
IndexReaderContext A struct like class that represents a hierarchical relationship between IndexReader instances.
IndexWriter An IndexWriter creates and maintains an index.
LeafReader LeafReader is an abstract class, providing an interface for accessing an index.
LeafReaderContext IndexReaderContext for LeafReader instances.
NumericDocValues A per-document numeric value.
PointValues.IntersectVisitor We recurse the BKD tree, using a provided instance of this to guide the recursion.
PointValues.Relation Used by PointValues.intersect(java.lang.String, org.apache.lucene.index.PointValues.IntersectVisitor) to check how each recursive cell corresponds to the query.
PostingsEnum Iterates through the postings.
PrefixCodedTerms Prefix codes term instances (prefixes are shared)
PrefixCodedTerms.TermIterator An iterator over the list of terms stored in a PrefixCodedTerms.
RandomAccessOrds Extension of SortedSetDocValues that supports random access to the ordinals of a document.
SortedDocValues A per-document byte[] with presorted values.
SortedNumericDocValues A list of per-document numeric values, sorted according to Long.compare(long, long).
SortedSetDocValues A per-document set of presorted byte[] values.
StoredFieldVisitor Expert: provides a low-level means of accessing the stored field values in an index.
Term A Term represents a word from text.
TermContext Maintains a IndexReader TermState view over IndexReader instances containing a single term.
Terms Access to the terms in a specific field.
TermsEnum Iterator to seek (TermsEnum.seekCeil(BytesRef), TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq()), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).
TermsEnum.SeekStatus Represents returned result from TermsEnum.seekCeil(org.apache.lucene.util.BytesRef).
TermState Encapsulates all required internal state to position the associated TermsEnum without re-seeking.
TrackingIndexWriter Class that tracks changes to a delegated IndexWriter, used by ControlledRealTimeReopenThread to ensure specific changes are visible.

Classes in org.apache.lucene.index used by org.apache.lucene.search.grouping

Class and Description
LeafReaderContext IndexReaderContext for LeafReader instances.

Classes in org.apache.lucene.index used by org.apache.lucene.search.grouping.function

Class and Description
LeafReaderContext IndexReaderContext for LeafReader instances.

Classes in org.apache.lucene.index used by org.apache.lucene.search.grouping.term

Class and Description
LeafReaderContext IndexReaderContext for LeafReader instances.
SortedDocValues A per-document byte[] with presorted values.
SortedSetDocValues A per-document set of presorted byte[] values.
TermsEnum Iterator to seek (TermsEnum.seekCeil(BytesRef), TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq()), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).

Classes in org.apache.lucene.index used by org.apache.lucene.search.highlight

Class and Description
BinaryDocValues A per-document byte[]
FieldInfos Collection of FieldInfos (accessible by number or by name).
Fields Flex API for access to fields and terms
FilterLeafReader A FilterLeafReader contains another LeafReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.
IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
LeafReader LeafReader is an abstract class, providing an interface for accessing an index.
LeafReader.CoreClosedListener Called when the shared core for this LeafReader is closed.
LeafReaderContext IndexReaderContext for LeafReader instances.
NumericDocValues A per-document numeric value.
PointValues Access to indexed numeric values.
SortedDocValues A per-document byte[] with presorted values.
SortedNumericDocValues A list of per-document numeric values, sorted according to Long.compare(long, long).
SortedSetDocValues A per-document set of presorted byte[] values.
StoredFieldVisitor Expert: provides a low-level means of accessing the stored field values in an index.
Terms Access to the terms in a specific field.

Classes in org.apache.lucene.index used by org.apache.lucene.search.join

Class and Description
BinaryDocValues A per-document byte[]
FilteredTermsEnum Abstract class for enumerating a subset of all terms.
FilteredTermsEnum.AcceptStatus Return value, if term should be accepted or the iteration should END.
IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
LeafReader LeafReader is an abstract class, providing an interface for accessing an index.
LeafReaderContext IndexReaderContext for LeafReader instances.
MultiDocValues.OrdinalMap maps per-segment ordinals to/from global ordinal space
NumericDocValues A per-document numeric value.
PointValues.IntersectVisitor We recurse the BKD tree, using a provided instance of this to guide the recursion.
PointValues.Relation Used by PointValues.intersect(java.lang.String, org.apache.lucene.index.PointValues.IntersectVisitor) to check how each recursive cell corresponds to the query.
PrefixCodedTerms Prefix codes term instances (prefixes are shared)
PrefixCodedTerms.TermIterator An iterator over the list of terms stored in a PrefixCodedTerms.
SortedDocValues A per-document byte[] with presorted values.
SortedNumericDocValues A list of per-document numeric values, sorted according to Long.compare(long, long).
SortedSetDocValues A per-document set of presorted byte[] values.
Term A Term represents a word from text.
Terms Access to the terms in a specific field.
TermsEnum Iterator to seek (TermsEnum.seekCeil(BytesRef), TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq()), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).

Classes in org.apache.lucene.index used by org.apache.lucene.search.postingshighlight

Class and Description
FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.
LeafReaderContext IndexReaderContext for LeafReader instances.
PostingsEnum Iterates through the postings.
StoredFieldVisitor Expert: provides a low-level means of accessing the stored field values in an index.
StoredFieldVisitor.Status Enumeration of possible return values for StoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo).
TermsEnum Iterator to seek (TermsEnum.seekCeil(BytesRef), TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq()), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).

Classes in org.apache.lucene.index used by org.apache.lucene.search.similarities

Class and Description
FieldInvertState This class tracks the number and position / offset parameters of terms being added to the index.
LeafReaderContext IndexReaderContext for LeafReader instances.
NumericDocValues A per-document numeric value.

Classes in org.apache.lucene.index used by org.apache.lucene.search.spans

Class and Description
IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
LeafReaderContext IndexReaderContext for LeafReader instances.
PostingsEnum Iterates through the postings.
Term A Term represents a word from text.
TermContext Maintains a IndexReader TermState view over IndexReader instances containing a single term.
TermsEnum Iterator to seek (TermsEnum.seekCeil(BytesRef), TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq()), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).

Classes in org.apache.lucene.index used by org.apache.lucene.search.vectorhighlight

Class and Description
IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
Term A Term represents a word from text.

Classes in org.apache.lucene.index used by org.apache.lucene.uninverting

Class and Description
BaseCompositeReader Base class for implementing CompositeReaders based on an array of sub-readers.
BinaryDocValues A per-document byte[]
CompositeReader Instances of this reader type can only be used to get stored fields from the underlying LeafReaders, but it is not possible to directly retrieve postings.
DirectoryReader DirectoryReader is an implementation of CompositeReader that can read indexes in a Directory.
FieldInfos Collection of FieldInfos (accessible by number or by name).
FilterDirectoryReader A FilterDirectoryReader wraps another DirectoryReader, allowing implementations to transform or extend it.
FilterLeafReader A FilterLeafReader contains another LeafReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.
IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
LeafReader LeafReader is an abstract class, providing an interface for accessing an index.
LeafReader.CoreClosedListener Called when the shared core for this LeafReader is closed.
NumericDocValues A per-document numeric value.
PostingsEnum Iterates through the postings.
SortedDocValues A per-document byte[] with presorted values.
SortedSetDocValues A per-document set of presorted byte[] values.
Terms Access to the terms in a specific field.
TermsEnum Iterator to seek (TermsEnum.seekCeil(BytesRef), TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq()), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).
TermsEnum.SeekStatus Represents returned result from TermsEnum.seekCeil(org.apache.lucene.util.BytesRef).

Classes in org.apache.lucene.index used by org.apache.lucene.util

Class and Description
FilteredTermsEnum Abstract class for enumerating a subset of all terms.
NumericDocValues A per-document numeric value.
PointValues Access to indexed numeric values.
Term A Term represents a word from text.
Terms Access to the terms in a specific field.
TermsEnum Iterator to seek (TermsEnum.seekCeil(BytesRef), TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq()), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).
TermsEnum.SeekStatus Represents returned result from TermsEnum.seekCeil(org.apache.lucene.util.BytesRef).

Classes in org.apache.lucene.index used by org.apache.lucene.util.automaton

Class and Description
Terms Access to the terms in a specific field.
TermsEnum Iterator to seek (TermsEnum.seekCeil(BytesRef), TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq()), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).

Classes in org.apache.lucene.index used by org.apache.lucene.util.bkd

Class and Description
MergeState.DocMap Remaps docids around deletes during merge
PointValues.IntersectVisitor We recurse the BKD tree, using a provided instance of this to guide the recursion.
PointValues.Relation Used by PointValues.intersect(java.lang.String, org.apache.lucene.index.PointValues.IntersectVisitor) to check how each recursive cell corresponds to the query.

Classes in org.apache.lucene.index used by org.apache.lucene.util.packed

Class and Description
NumericDocValues A per-document numeric value.