Uses of Package
org.apache.lucene.index
-
Packages that use org.apache.lucene.index Package Description org.apache.lucene.codecs Codecs API: API for customization of the encoding and structure of the index.org.apache.lucene.codecs.compressing Compressing helper classes.org.apache.lucene.codecs.lucene90 Lucene 9.0 file format.org.apache.lucene.codecs.lucene90.blocktree BlockTree terms dictionary.org.apache.lucene.codecs.lucene90.compressing Lucene 9.0 compressing format.org.apache.lucene.codecs.perfield Postings format that can delegate to different formats per-field.org.apache.lucene.document The logical representation of aDocument
for indexing and searching.org.apache.lucene.geo Geospatial Utility Implementations for Lucene Coreorg.apache.lucene.index Code to maintain and access indices.org.apache.lucene.search Code to search indices.org.apache.lucene.search.comparators Comparators, used to compare hits so as to determine their sort order when collecting the top results withTopFieldCollector
.org.apache.lucene.search.similarities This package contains the various ranking models that can be used in Lucene.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.graph Utility classes for working with token streams as graphs.org.apache.lucene.util.hnsw Navigable Small-World graph, nominally Hierarchical but currently only has a single layer. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs Class Description BinaryDocValues A per-document numeric value.FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.FieldInfos Collection ofFieldInfo
s (accessible by number or by name).Fields Provides aTerms
index for fields that have it, and lists which fields do.Impact Per-document scoring factors.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.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 basedTermState
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 toLong.compare(long, long)
.SortedSetDocValues A multi-valued version ofSortedDocValues
.StoredFieldVisitor Expert: provides a low-level means of accessing the stored field values in an index.StoredFieldVisitor.Status Enumeration of possible return values forStoredFieldVisitor.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
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.TermState Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking.VectorValues This class provides access to per-document floating point vector values indexed asKnnVectorField
. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.compressing Class Description MergeState Holds common state used during segment merging. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene90 Class Description FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.FieldInfos Collection ofFieldInfo
s (accessible by number or by name).ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.KnnGraphValues Access to per-document neighbor lists in a (hierarchical) knn search graph.MergeState Holds common state used during segment merging.NumericDocValues A per-document numeric value.OrdTermState An ordinal basedTermState
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.TermState Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking.VectorValues This class provides access to per-document floating point vector values indexed asKnnVectorField
. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene90.blocktree Class Description Fields Provides aTerms
index for fields that have it, and lists which fields do.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
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene90.compressing Class Description FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.FieldInfos Collection ofFieldInfo
s (accessible by number or by name).Fields Provides aTerms
index for fields that have it, and lists which fields do.IndexableField Represents a single field for indexing.MergeState Holds common state used during segment merging.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. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.perfield Class Description SegmentReadState Holder class for common parameters used during read.SegmentWriteState Holder class for common parameters used during write.VectorValues This class provides access to per-document floating point vector values indexed asKnnVectorField
. -
Classes in org.apache.lucene.index used by org.apache.lucene.document Class 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.StoredFieldVisitor Expert: provides a low-level means of accessing the stored field values in an index.StoredFieldVisitor.Status Enumeration of possible return values forStoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo)
.VectorSimilarityFunction Vector similarity function; used in search to return top K most similar vectors to a target vector. -
Classes in org.apache.lucene.index used by org.apache.lucene.geo Class Description PointValues.Relation Used byPointValues.intersect(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 Description BaseCompositeReader Base class for implementingCompositeReader
s based on an array of sub-readers.BaseTermsEnum A base TermsEnum that adds default implementations forBaseTermsEnum.attributes()
BaseTermsEnum.termState()
BaseTermsEnum.seekExact(BytesRef)
BaseTermsEnum.seekExact(BytesRef, TermState)
In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.BinaryDocValues A per-document numeric value.CheckIndex.Options Run-time configuration options for CheckIndex commands.CheckIndex.Status Returned fromCheckIndex.checkIndex()
detailing the health and status of the index.CheckIndex.Status.DocValuesStatus Status from testing DocValuesCheckIndex.Status.FieldInfoStatus Status from testing field infos.CheckIndex.Status.FieldNormStatus Status from testing field norms.CheckIndex.Status.IndexSortStatus Status from testing index sortCheckIndex.Status.LiveDocStatus Status from testing livedocsCheckIndex.Status.PointsStatus Status from testing PointValuesCheckIndex.Status.SegmentInfoStatus Holds the status of each segment in the index.CheckIndex.Status.SoftDeletsStatus Status from testing soft deletesCheckIndex.Status.StoredFieldStatus Status from testing stored fields.CheckIndex.Status.TermIndexStatus Status from testing term index.CheckIndex.Status.TermVectorStatus Status from testing stored fields.CheckIndex.Status.VectorValuesStatus Status from testing VectorValuesCodecReader 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
forCompositeReader
instance.ConcurrentMergeScheduler.MergeThread Runs a merge thread to execute a single merge, then exits.DirectoryReader DirectoryReader is an implementation ofCompositeReader
that can read indexes in aDirectory
.DocIDMerger Utility class to help merging documents from sub-readers according to either simple concatenated (unsorted) order, or by a specified index-time sort, skipping deleted documents and remapping non-deleted documents.DocIDMerger.Sub Represents one sub-reader being mergedDocValuesType DocValues types.FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.FieldInfos Collection ofFieldInfo
s (accessible by number or by name).Fields Provides aTerms
index for fields that have it, and lists which fields do.FilterCodecReader AFilterCodecReader
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 shouldEND
.FilterLeafReader AFilterLeafReader
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 filteringFields
implementations.FilterLeafReader.FilterTerms Base class for filteringTerms
implementations.FilterLeafReader.FilterTermsEnum Base class for filteringTermsEnum
implementations.FilterMergePolicy A wrapper forMergePolicy
instances.Impact Per-document scoring factors.Impacts Information about upcoming impacts, ie.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.ImpactsSource Source ofImpacts
.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 theIndexDeletionPolicy
orIndexReader
.IndexDeletionPolicy Expert: policy for deletion of staleindex commits
.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.CacheHelper A utility class that gives hooks in order to help build a cache based on the data that is contained in this index.IndexReader.CacheKey A cache key identifying a resource that is being cached on.IndexReader.ClosedListener A listener that is called when a resource gets closed.IndexReaderContext A struct like class that represents a hierarchical relationship betweenIndexReader
instances.IndexSorter Handles how documents should be sorted in an index, both within a segment and between segments.IndexSorter.ComparableProvider Used for sorting documents across segmentsIndexSorter.DocComparator A comparator of doc IDs, used for sorting documents within a segmentIndexSorter.NumericDocValuesProvider Provide a NumericDocValues instance for a LeafReaderIndexSorter.SortedDocValuesProvider Provide a SortedDocValues instance for a LeafReaderIndexWriter AnIndexWriter
creates and maintains an index.IndexWriter.DocStats DocStats for this indexIndexWriter.IndexReaderWarmer IfDirectoryReader.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.IndexWriterConfig Holds all the configuration that is used to create anIndexWriter
.IndexWriterConfig.OpenMode Specifies the open mode forIndexWriter
.IndexWriterEventListener A callback event listener for recording key events happened inside IndexWriterKnnGraphValues Access to per-document neighbor lists in a (hierarchical) knn search graph.LeafMetaData Provides read-only metadata about a leaf.LeafReader LeafReader
is an abstract class, providing an interface for accessing an index.LeafReaderContext IndexReaderContext
forLeafReader
instances.LiveIndexWriterConfig Holds all the configuration used byIndexWriter
with few setters for settings that can be changed on anIndexWriter
instance "live".LogMergePolicy This class implements aMergePolicy
that tries to merge segments into levels of exponentially increasing size, where each level has fewer segments than the value of the merge factor.MergePolicy Expert: a MergePolicy determines the sequence of primitive merge operations.MergePolicy.MergeAbortedException Thrown when a merge was explicitly aborted becauseIndexWriter.abortMerges()
was called.MergePolicy.MergeContext This interface represents the current context of the merge selection process.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.MergePolicy.OneMergeProgress Progress and state for an executing merge.MergePolicy.OneMergeProgress.PauseReason Reason for pausing the merge thread.MergeScheduler Expert:IndexWriter
uses an instance implementing this interface to execute the merges selected by aMergePolicy
.MergeScheduler.MergeSource Provides access to new merges and executes the actual mergeMergeState Holds common state used during segment merging.MergeState.DocMap A map of doc IDs.MergeTrigger MergeTrigger is passed toMergePolicy.findMerges(MergeTrigger, SegmentInfos, MergePolicy.MergeContext)
to indicate the event that triggered the merge.MultiFields Provides a singleFields
term index view over anIndexReader
.MultiPostingsEnum ExposesPostingsEnum
, merged fromPostingsEnum
API of sub-segments.MultiPostingsEnum.EnumWithSlice Holds aPostingsEnum
along with the correspondingReaderSlice
.MultiTermsEnum NumericDocValues A per-document numeric value.OneMergeWrappingMergePolicy A wrapping merge policy that wraps theMergePolicy.OneMerge
objects returned by the wrapped merge policy.OrdinalMap Maps per-segment ordinals to/from global ordinal space, using a compact packed-ints representation.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 byPointValues.intersect(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 aPrefixCodedTerms
.QueryTimeout Base for query timeout implementations, which will provide ashouldExit()
method, used withExitableDirectoryReader
.RandomAccessVectorValues Provides random access to vectors by dense ordinal.ReaderSlice Subreader slice from a parent composite reader.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.SegmentInfos A collection of segmentInfo objects with methods for operating on those segments in relation to the file system.SegmentReadState Holder class for common parameters used during read.SegmentWriteState Holder class for common parameters used during write.SnapshotDeletionPolicy AnIndexDeletionPolicy
that wraps any otherIndexDeletionPolicy
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 toLong.compare(long, long)
.SortedSetDocValues A multi-valued version ofSortedDocValues
.SortFieldProvider Reads/Writes a named SortField from a segment info file, used to record index sortsStoredFieldVisitor Expert: provides a low-level means of accessing the stored field values in an index.StoredFieldVisitor.Status Enumeration of possible return values forStoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo)
.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
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.TermsEnum.SeekStatus Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.TermState Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking.TermStates 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 byTwoPhaseCommitTool.execute(TwoPhaseCommit...)
when an object fails to commit().TwoPhaseCommitTool.PrepareCommitFailException Thrown byTwoPhaseCommitTool.execute(TwoPhaseCommit...)
when an object fails to prepareCommit().VectorSimilarityFunction Vector similarity function; used in search to return top K most similar vectors to a target vector.VectorValues This class provides access to per-document floating point vector values indexed asKnnVectorField
. -
Classes in org.apache.lucene.index used by org.apache.lucene.search Class Description BinaryDocValues A per-document numeric value.DirectoryReader DirectoryReader is an implementation ofCompositeReader
that can read indexes in aDirectory
.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.ImpactsSource Source ofImpacts
.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 betweenIndexReader
instances.IndexSorter Handles how documents should be sorted in an index, both within a segment and between segments.IndexWriter AnIndexWriter
creates and maintains an index.LeafReader LeafReader
is an abstract class, providing an interface for accessing an index.LeafReaderContext IndexReaderContext
forLeafReader
instances.NumericDocValues A per-document numeric value.PostingsEnum Iterates through the postings.PrefixCodedTerms Prefix codes term instances (prefixes are shared).SortedDocValues A per-document byte[] with presorted values.SortedNumericDocValues A list of per-document numeric values, sorted according toLong.compare(long, long)
.SortedSetDocValues A multi-valued version ofSortedDocValues
.SortFieldProvider Reads/Writes a named SortField from a segment info file, used to record index sortsStoredFieldVisitor Expert: provides a low-level means of accessing the stored field values in 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
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.TermsEnum.SeekStatus Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.TermState Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking.TermStates -
Classes in org.apache.lucene.index used by org.apache.lucene.search.comparators Class Description LeafReaderContext IndexReaderContext
forLeafReader
instances.NumericDocValues A per-document numeric value.PointValues Access to indexed numeric values. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.similarities Class Description FieldInvertState This class tracks the number and position / offset parameters of terms being added to the index. -
Classes in org.apache.lucene.index used by org.apache.lucene.util Class Description PointValues Access to indexed numeric values.Term A Term represents a word from text.Terms Access to the terms in a specific field. -
Classes in org.apache.lucene.index used by org.apache.lucene.util.automaton Class 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
orPostingsEnum
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 Description MergeState.DocMap A map of doc IDs.PointValues Access to indexed numeric values.PointValues.IntersectVisitor We recurse the BKD tree, using a provided instance of this to guide the recursion. -
Classes in org.apache.lucene.index used by org.apache.lucene.util.graph Class Description Term A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.util.hnsw Class Description KnnGraphValues Access to per-document neighbor lists in a (hierarchical) knn search graph.RandomAccessVectorValues Provides random access to vectors by dense ordinal.RandomAccessVectorValuesProducer Something (generally aVectorValues
) that provides aRandomAccessVectorValues
.VectorSimilarityFunction Vector similarity function; used in search to return top K most similar vectors to a target vector.