Uses of Package
org.apache.lucene.index
Packages that use org.apache.lucene.index
Package
Description
Codecs API: API for customization of the encoding and structure of the index.
Compressing helper classes.
HNSW vector helper classes.
Lucene 9.0 file format.
BlockTree terms dictionary.
Lucene 9.0 compressing format.
Lucene 9.12 file format.
Lucene 9.4 file format.
Lucene 9.5 file format.
Lucene 9.9 file format.
Postings format that can delegate to different formats per-field.
The logical representation of a
Document for indexing and
searching.Geospatial Utility Implementations for Lucene Core
Code to maintain and access indices.
Internal bridges to package-private internals, for use by the lucene test framework only.
Code to search indices.
Comparators, used to compare hits so as to determine their sort order when collecting the top
results with
TopFieldCollector.Classes related to vector search: knn and vector fields.
This package contains the various ranking models that can be used in Lucene.
Some utility classes.
Finite-state automaton for regular expressions.
Block KD-tree, implementing the generic spatial data structure described in this paper.
Utility classes for working with token streams as graphs.
Navigable Small-World graph, nominally Hierarchical but currently only has a single layer.
Provides quantization methods for scaling vector values to smaller data types and possibly fewer
dimensions
-
Classes in org.apache.lucene.index used by org.apache.lucene.codecsClassDescriptionA per-document numeric value.This class provides access to per-document floating point vector values indexed as
KnnByteVectorField.Accumulator for documents that have a value for a field.Skipper forDocValues.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfos (accessible by number or by name).Provides aTermsindex for fields that have it, and lists which fields do.This class provides access to per-document floating point vector values indexed asKnnFloatVectorField.Per-document scoring factors.Extension ofPostingsEnumwhich also provides information about upcoming impacts.Controls how much information is stored in the postings lists.Holds common state used during segment merging.A per-document numeric value.An ordinal basedTermStateAccess to indexed numeric values.We recurse thePointValues.PointTree, using a provided instance of this to guide the recursion.Basic operations to read the KD-tree.Iterates through the postings.Embeds a [read-only] SegmentInfo and adds per-commit fields.Information about a segment such as its name, directory, and files related to the segment.Holder class for common parameters used during read.Holder class for common parameters used during write.A per-document byte[] with presorted values.A list of per-document numeric values, sorted according toLong.compare(long, long).A multi-valued version ofSortedDocValues.A permutation of doc IDs.API for reading stored fields.Expert: provides a low-level means of accessing the stored field values in an index.Enumeration of possible return values forStoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo).Iterator to seek (TermsEnum.seekCeil(BytesRef),TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next()terms to obtain frequency information (TermsEnum.docFreq()),PostingsEnumorPostingsEnumfor the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).Encapsulates all required internal state to position the associatedTermsEnumwithout re-seeking.API for reading term vectors. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.compressing
-
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.hnswClassDescriptionAccumulator for documents that have a value for a field.Access to the Field Info file that describes document fields and whether or not they are indexed.This class abstracts addressing of document vector values indexed as
KnnFloatVectorFieldorKnnByteVectorField.Holds common state used during segment merging.Holder class for common parameters used during read.Holder class for common parameters used during write.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.codecs.lucene90ClassDescriptionAccess to the Field Info file that describes document fields and whether or not they are indexed.Collection of
FieldInfos (accessible by number or by name).A DocIdSetIterator that also provides an index() method tracking a distinct ordinal for a vector associated with each doc.Holds common state used during segment merging.Access to indexed numeric values.Embeds a [read-only] SegmentInfo and adds per-commit fields.Information about a segment such as its name, directory, and files related to the segment.Holder class for common parameters used during read.Holder class for common parameters used during write. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene90.blocktreeClassDescriptionProvides a
Termsindex for fields that have it, and lists which fields do.Holder class for common parameters used during read.Holder class for common parameters used during write.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef),TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next()terms to obtain frequency information (TermsEnum.docFreq()),PostingsEnumorPostingsEnumfor the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum). -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene90.compressingClassDescriptionAccess to the Field Info file that describes document fields and whether or not they are indexed.Collection of
FieldInfos (accessible by number or by name).Provides aTermsindex for fields that have it, and lists which fields do.Holds common state used during segment merging.Information about a segment such as its name, directory, and files related to the segment.API for reading stored fields.Expert: provides a low-level means of accessing the stored field values in an index.API for reading term vectors. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene912ClassDescriptionAccess to the Field Info file that describes document fields and whether or not they are indexed.Extension of
PostingsEnumwhich also provides information about upcoming impacts.A per-document numeric value.An ordinal basedTermStateIterates through the postings.Holder class for common parameters used during read.Holder class for common parameters used during write.Encapsulates all required internal state to position the associatedTermsEnumwithout re-seeking. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene94ClassDescriptionCollection of
FieldInfos (accessible by number or by name).Information about a segment such as its name, directory, and files related to the segment. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene95ClassDescriptionThis class provides access to per-document floating point vector values indexed as
KnnByteVectorField.Accumulator for documents that have a value for a field.This class provides access to per-document floating point vector values indexed asKnnFloatVectorField.This class abstracts addressing of document vector values indexed asKnnFloatVectorFieldorKnnByteVectorField.A DocIdSetIterator that also provides an index() method tracking a distinct ordinal for a vector associated with each doc.The numeric datatype of the vector values.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.codecs.lucene99ClassDescriptionThis class provides access to per-document floating point vector values indexed as
KnnByteVectorField.Accumulator for documents that have a value for a field.Access to the Field Info file that describes document fields and whether or not they are indexed.This class provides access to per-document floating point vector values indexed asKnnFloatVectorField.This class abstracts addressing of document vector values indexed asKnnFloatVectorFieldorKnnByteVectorField.A DocIdSetIterator that also provides an index() method tracking a distinct ordinal for a vector associated with each doc.Holds common state used during segment merging.Information about a segment such as its name, directory, and files related to the segment.Holder class for common parameters used during read.Holder class for common parameters used during write.A permutation of doc IDs.The numeric datatype of the vector values.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.codecs.perfieldClassDescriptionThis class provides access to per-document floating point vector values indexed as
KnnByteVectorField.This class provides access to per-document floating point vector values indexed asKnnFloatVectorField.Holder class for common parameters used during read.Holder class for common parameters used during write. -
Classes in org.apache.lucene.index used by org.apache.lucene.documentClassDescriptionA per-document numeric value.Options for skip indexes on doc values.DocValues types.Access to the Field Info file that describes document fields and whether or not they are indexed.Represents a single field for indexing.Describes the properties of a field.Controls how much information is stored in the postings lists.Expert: provides a low-level means of accessing the stored field values in an index.Enumeration of possible return values for
StoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo).The numeric datatype of the vector values.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.geoClassDescriptionUsed by
PointValues.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.indexClassDescriptionBase class for implementing
CompositeReaders based on an array of sub-readers.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.A per-document numeric value.This class provides access to per-document floating point vector values indexed asKnnByteVectorField.Run-time configuration options for CheckIndex commands.Returned fromCheckIndex.checkIndex()detailing the health and status of the index.Status from testing DocValuesStatus from testing field infos.Status from testing field norms.Status from testing index sortStatus from testing livedocsStatus from testing PointValuesHolds the status of each segment in the index.Status from testing soft deletesStatus from testing stored fields.Status from testing term index.Status from testing stored fields.Status from testing vector valuesLeafReader implemented by codec APIs.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.IndexReaderContextforCompositeReaderinstance.Runs a merge thread to execute a single merge, then exits.DirectoryReader is an implementation ofCompositeReaderthat can read indexes in aDirectory.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.Represents one sub-reader being mergedOptions for skip indexes on doc values.Skipper forDocValues.DocValues types.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfos (accessible by number or by name).Provides aTermsindex for fields that have it, and lists which fields do.AFilterCodecReadercontains another CodecReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.A FilterDirectoryReader wraps another DirectoryReader, allowing implementations to transform or extend it.Factory class passed to FilterDirectoryReader constructor that allows subclasses to wrap the filtered DirectoryReader's subreaders.Abstract class for enumerating a subset of all terms.Return value, if term should be accepted or the iteration shouldEND.AFilterLeafReadercontains another LeafReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.Base class for filteringFieldsimplementations.Base class for filteringTermsimplementations.Base class for filteringTermsEnumimplementations.A wrapper forMergePolicyinstances.This class provides access to per-document floating point vector values indexed asKnnFloatVectorField.Per-document scoring factors.Information about upcoming impacts, ie.Extension ofPostingsEnumwhich also provides information about upcoming impacts.Source ofImpacts.Represents a single field for indexing.Describes the properties of a field.Expert: represents a single commit into an index as seen by theIndexDeletionPolicyorIndexReader.Expert: policy for deletion of staleindex commits.Controls how much information is stored in the postings lists.IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.A utility class that gives hooks in order to help build a cache based on the data that is contained in this index.A cache key identifying a resource that is being cached on.A listener that is called when a resource gets closed.A struct like class that represents a hierarchical relationship betweenIndexReaderinstances.Handles how documents should be sorted in an index, both within a segment and between segments.Used for sorting documents across segmentsA comparator of doc IDs, used for sorting documents within a segmentProvide a NumericDocValues instance for a LeafReaderProvide a SortedDocValues instance for a LeafReaderAnIndexWritercreates and maintains an index.DocStats for this indexIfDirectoryReader.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.Holds all the configuration that is used to create anIndexWriter.Specifies the open mode forIndexWriter.A callback event listener for recording key events happened inside IndexWriterThis class abstracts addressing of document vector values indexed asKnnFloatVectorFieldorKnnByteVectorField.A DocIdSetIterator that also provides an index() method tracking a distinct ordinal for a vector associated with each doc.Provides read-only metadata about a leaf.LeafReaderis an abstract class, providing an interface for accessing an index.IndexReaderContextforLeafReaderinstances.Holds all the configuration used byIndexWriterwith few setters for settings that can be changed on anIndexWriterinstance "live".This class implements aMergePolicythat tries to merge segments into levels of exponentially increasing size, where each level has fewer segments than the value of the merge factor.Expert: a MergePolicy determines the sequence of primitive merge operations.Thrown when a merge was explicitly aborted becauseIndexWriter.abortMerges()was called.This interface represents the current context of the merge selection process.A MergeSpecification instance provides the information necessary to perform multiple merges.OneMerge provides the information necessary to perform an individual primitive merge operation, resulting in a single new segment.Progress and state for an executing merge.Reason for pausing the merge thread.Expert:IndexWriteruses an instance implementing this interface to execute the merges selected by aMergePolicy.Provides access to new merges and executes the actual mergeHolds common state used during segment merging.A map of doc IDs.MergeTrigger is passed toMergePolicy.findMerges(MergeTrigger, SegmentInfos, MergePolicy.MergeContext)to indicate the event that triggered the merge.Provides a singleFieldsterm index view over anIndexReader.ExposesPostingsEnum, merged fromPostingsEnumAPI of sub-segments.Holds aPostingsEnumalong with the correspondingReaderSlice.A per-document numeric value.A wrapping merge policy that wraps theMergePolicy.OneMergeobjects returned by the wrapped merge policy.Maps per-segment ordinals to/from global ordinal space, using a compact packed-ints representation.Access to indexed numeric values.We recurse thePointValues.PointTree, using a provided instance of this to guide the recursion.Basic operations to read the KD-tree.Used byPointValues.intersect(org.apache.lucene.index.PointValues.IntersectVisitor)to check how each recursive cell corresponds to the query.Iterates through the postings.Prefix codes term instances (prefixes are shared).An iterator over the list of terms stored in aPrefixCodedTerms.Query timeout abstraction that controls whether a query should continue or be stopped.Subreader slice from a parent composite reader.Embeds a [read-only] SegmentInfo and adds per-commit fields.Information about a segment such as its name, directory, and files related to the segment.A collection of segmentInfo objects with methods for operating on those segments in relation to the file system.Holder class for common parameters used during read.Holder class for common parameters used during write.AnIndexDeletionPolicythat wraps any otherIndexDeletionPolicyand adds the ability to hold and later release snapshots of an index.A per-document byte[] with presorted values.A list of per-document numeric values, sorted according toLong.compare(long, long).A multi-valued version ofSortedDocValues.A permutation of doc IDs.Reads/Writes a named SortField from a segment info file, used to record index sortsAPI for reading stored fields.Expert: provides a low-level means of accessing the stored field values in an index.Enumeration of possible return values forStoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo).A Term represents a word from text.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef),TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next()terms to obtain frequency information (TermsEnum.docFreq()),PostingsEnumorPostingsEnumfor the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef).Encapsulates all required internal state to position the associatedTermsEnumwithout re-seeking.API for reading term vectors.Merges segments of approximately equal size, subject to an allowed number of segments per tier.Holds score and explanation for a single candidate merge.An interface for implementations that support 2-phase commit.Thrown byTwoPhaseCommitTool.execute(TwoPhaseCommit...)when an object fails to commit().Thrown byTwoPhaseCommitTool.execute(TwoPhaseCommit...)when an object fails to prepareCommit().The numeric datatype of the vector values.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.internal.testsClassDescriptionA
MergeSchedulerthat runs each merge using a separate thread.DirectoryReader is an implementation ofCompositeReaderthat can read indexes in aDirectory.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfos (accessible by number or by name).Information about upcoming impacts, ie.A cache key identifying a resource that is being cached on.AnIndexWritercreates and maintains an index.Embeds a [read-only] SegmentInfo and adds per-commit fields.IndexReader implementation over a single segment. -
Classes in org.apache.lucene.index used by org.apache.lucene.searchClassDescriptionA base TermsEnum that adds default implementations for
BaseTermsEnum.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.A per-document numeric value.DirectoryReader is an implementation ofCompositeReaderthat can read indexes in aDirectory.Skipper forDocValues.Extension ofPostingsEnumwhich also provides information about upcoming impacts.Source ofImpacts.IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.A struct like class that represents a hierarchical relationship betweenIndexReaderinstances.Handles how documents should be sorted in an index, both within a segment and between segments.AnIndexWritercreates and maintains an index.LeafReaderis an abstract class, providing an interface for accessing an index.IndexReaderContextforLeafReaderinstances.A per-document numeric value.Iterates through the postings.Query timeout abstraction that controls whether a query should continue or be stopped.A per-document byte[] with presorted values.A list of per-document numeric values, sorted according toLong.compare(long, long).A multi-valued version ofSortedDocValues.Reads/Writes a named SortField from a segment info file, used to record index sortsAPI for reading stored fields.A Term represents a word from text.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef),TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next()terms to obtain frequency information (TermsEnum.docFreq()),PostingsEnumorPostingsEnumfor the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef).Encapsulates all required internal state to position the associatedTermsEnumwithout re-seeking. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.comparatorsClassDescription
IndexReaderContextforLeafReaderinstances.A per-document numeric value.A per-document byte[] with presorted values. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.knn
-
Classes in org.apache.lucene.index used by org.apache.lucene.search.similaritiesClassDescriptionThis 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.utilClassDescriptionAccess to indexed numeric values.A Term represents a word from text.Access to the terms in a specific field.
-
Classes in org.apache.lucene.index used by org.apache.lucene.util.automatonClassDescriptionAccess to the terms in a specific field.Iterator to seek (
TermsEnum.seekCeil(BytesRef),TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next()terms to obtain frequency information (TermsEnum.docFreq()),PostingsEnumorPostingsEnumfor the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum). -
Classes in org.apache.lucene.index used by org.apache.lucene.util.bkdClassDescriptionA map of doc IDs.Access to indexed numeric values.Basic operations to read the KD-tree.
-
Classes in org.apache.lucene.index used by org.apache.lucene.util.graph
-
Classes in org.apache.lucene.index used by org.apache.lucene.util.hnswClassDescriptionAccess to the Field Info file that describes document fields and whether or not they are indexed.IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.This class abstracts addressing of document vector values indexed as
KnnFloatVectorFieldorKnnByteVectorField.A map of doc IDs. -
Classes in org.apache.lucene.index used by org.apache.lucene.util.quantizationClassDescriptionThis class provides access to per-document floating point vector values indexed as
KnnByteVectorField.This class provides access to per-document floating point vector values indexed asKnnFloatVectorField.This class abstracts addressing of document vector values indexed asKnnFloatVectorFieldorKnnByteVectorField.Vector similarity function; used in search to return top K most similar vectors to a target vector.