Uses of Package
org.apache.lucene.index
-
Packages that use org.apache.lucene.index Package Description org.apache.lucene.analysis.icu Analysis components based on ICUorg.apache.lucene.analysis.query Automatically filter high-frequency stopwords.org.apache.lucene.analysis.synonym.word2vec Analysis components for Synonyms using Word2Vec model.org.apache.lucene.backward_codecs.compressing Compressing helper classes.org.apache.lucene.backward_codecs.lucene40.blocktree BlockTree terms dictionary.org.apache.lucene.backward_codecs.lucene50 Lucene 5.0 file format.org.apache.lucene.backward_codecs.lucene50.compressing Lucene 5.0 compressing format.org.apache.lucene.backward_codecs.lucene60 Lucene 6.0 file format.org.apache.lucene.backward_codecs.lucene70 Components from the Lucene 7.0 index format.org.apache.lucene.backward_codecs.lucene80 Components from the Lucene 8.0 index format.org.apache.lucene.backward_codecs.lucene84 Lucene 8.4 file format.org.apache.lucene.backward_codecs.lucene86 Lucene 8.6 file format.org.apache.lucene.backward_codecs.lucene87 Lucene 8.7 file format.org.apache.lucene.backward_codecs.lucene90 Lucene 9.0 file format.org.apache.lucene.backward_codecs.lucene91 Lucene 9.1 file format.org.apache.lucene.backward_codecs.lucene92 Lucene 9.2 file format.org.apache.lucene.backward_codecs.lucene94 Lucene 9.4 file format.org.apache.lucene.backward_codecs.lucene95 Lucene 9.5 file format.org.apache.lucene.classification Uses already seen data (the indexed documents) to classify an input ( can be simple text or a structured document).org.apache.lucene.classification.document Uses already seen data (the indexed documents) to classify new documents.org.apache.lucene.classification.utils Utilities for evaluation, data preparation, etc.org.apache.lucene.codecs Codecs API: API for customization of the encoding and structure of the index.org.apache.lucene.codecs.bitvectors A simple bit-vector format that supports hamming distance and storing vectors in an HNSW graphorg.apache.lucene.codecs.blockterms Pluggable term index / block terms dictionary implementations.org.apache.lucene.codecs.blocktreeords Same postings format as Lucene50, except the terms dictionary also supports ords, i.e.org.apache.lucene.codecs.bloom Codec PostingsFormat for fast access to low-frequency terms such as primary key fields.org.apache.lucene.codecs.compressing Compressing helper classes.org.apache.lucene.codecs.hnsw HNSW vector 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.lucene94 Lucene 9.4 file format.org.apache.lucene.codecs.lucene95 Lucene 9.5 file format.org.apache.lucene.codecs.lucene99 Lucene 9.9 file format.org.apache.lucene.codecs.memory Term dictionary, DocValues or Postings formats that are read entirely into memory.org.apache.lucene.codecs.perfield Postings format that can delegate to different formats per-field.org.apache.lucene.codecs.simpletext Simpletext Codec: writes human readable postings.org.apache.lucene.codecs.uniformsplit Pluggable term index / block terms dictionary implementations.org.apache.lucene.codecs.uniformsplit.sharedterms Pluggable term index / block terms dictionary implementations.org.apache.lucene.collation Unicode collation support.org.apache.lucene.document The logical representation of aDocument
for indexing and searching.org.apache.lucene.expressions Expressions.org.apache.lucene.geo Geospatial Utility Implementations for Lucene Coreorg.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.internal.tests Internal bridges to package-private internals, for use by the lucene test framework only.org.apache.lucene.misc Miscellaneous Lucene utilities that don't really fit anywhere else.org.apache.lucene.misc.document Misc extensions of the Document/Field API.org.apache.lucene.misc.index Misc index tools and index support.org.apache.lucene.misc.search Misc search implementations.org.apache.lucene.monitor Monitoring frameworkorg.apache.lucene.payloads Experimental classes for interacting with payloadsorg.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.intervals Intervals queriesorg.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.queries.spans The calculus of spans.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.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.sandbox.document This package contains several point types:BigIntegerPoint
for 128-bit integersLatLonPoint
for latitude/longitude geospatial pointsorg.apache.lucene.sandbox.index Experimental index-related classesorg.apache.lucene.sandbox.queries Additional queries (some may have caveats or limitations)org.apache.lucene.sandbox.search This package contains a flexible graph-based proximity query, TermAutomatonQuery, and geospatial queries.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.grouping Grouping.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.knn Classes related to vector search: knn and vector fields.org.apache.lucene.search.matchhighlight This package contains several components useful to build a highlighter on top of theMatches
API.org.apache.lucene.search.similarities This package contains the various ranking models that can be used in Lucene.org.apache.lucene.search.spell Suggest alternate spellings for words.org.apache.lucene.search.suggest Support for Autocomplete/Autosuggestorg.apache.lucene.search.suggest.analyzing Analyzer based autosuggest.org.apache.lucene.search.suggest.document Support for document suggestionorg.apache.lucene.search.uhighlight The UnifiedHighlighter -- a flexible highlighter that can get offsets from postings, term vectors, or analysis.org.apache.lucene.search.vectorhighlight Another highlighter implementation based on term vectors.org.apache.lucene.spatial3d Lucene field & query support for the spatial geometry implemented inorg.apache.lucene.spatial3d.geom
.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.org.apache.lucene.util.quantization 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.analysis.icu Class Description IndexableField Represents a single field for indexing. -
Classes in org.apache.lucene.index used by org.apache.lucene.analysis.query Class 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.analysis.synonym.word2vec Class Description 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.backward_codecs.compressing Class Description MergeState Holds common state used during segment merging. -
Classes in org.apache.lucene.index used by org.apache.lucene.backward_codecs.lucene40.blocktree Class Description 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.FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.Fields Provides aTerms
index for fields that have it, and lists which fields do.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.PostingsEnum Iterates through the postings.SegmentReadState Holder class for common parameters used during read.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. -
Classes in org.apache.lucene.index used by org.apache.lucene.backward_codecs.lucene50 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).Impact Per-document scoring factors.Impacts Information about upcoming impacts, ie.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.ImpactsSource Source ofImpacts
.OrdTermState An ordinal basedTermState
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. -
Classes in org.apache.lucene.index used by org.apache.lucene.backward_codecs.lucene50.compressing Class Description 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.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.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.PostingsEnum Iterates through the postings.SegmentInfo Information about a segment such as its name, directory, and files related to the segment.StoredFields API for reading stored fields.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
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.TermsEnum.SeekStatus Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.TermVectors API for reading term vectors. -
Classes in org.apache.lucene.index used by org.apache.lucene.backward_codecs.lucene60 Class Description DocValuesType 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).IndexOptions Controls how much information is stored in the postings lists.PointValues Access to indexed numeric values.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.backward_codecs.lucene70 Class Description 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.DocValuesIterator 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.NumericDocValues A per-document numeric value.PostingsEnum Iterates through the postings.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
.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)
. -
Classes in org.apache.lucene.index used by org.apache.lucene.backward_codecs.lucene80 Class Description 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.DocValuesIterator 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.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 toLong.compare(long, long)
.SortedSetDocValues A multi-valued version ofSortedDocValues
.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)
. -
Classes in org.apache.lucene.index used by org.apache.lucene.backward_codecs.lucene84 Class Description FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.Impact Per-document scoring factors.Impacts Information about upcoming impacts, ie.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.ImpactsSource Source ofImpacts
.OrdTermState An ordinal basedTermState
PostingsEnum Iterates through the postings.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. -
Classes in org.apache.lucene.index used by org.apache.lucene.backward_codecs.lucene86 Class Description PointValues Access to indexed numeric values.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.backward_codecs.lucene87 Class Description FieldInfos Collection ofFieldInfo
s (accessible by number or by name).SegmentInfo 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.backward_codecs.lucene90 Class Description ByteVectorValues This class provides access to per-document floating point vector values indexed asKnnByteVectorField
.DocValuesType 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).FloatVectorValues This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.Impact Per-document scoring factors.Impacts Information about upcoming impacts, ie.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.ImpactsSource Source ofImpacts
.IndexOptions Controls how much information is stored in the postings lists.NumericDocValues A per-document numeric value.OrdTermState An ordinal basedTermState
PostingsEnum Iterates through the postings.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.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.backward_codecs.lucene91 Class Description ByteVectorValues This class provides access to per-document floating point vector values indexed asKnnByteVectorField
.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).FloatVectorValues This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.SegmentReadState Holder class for common parameters used during read.SegmentWriteState Holder class for common parameters used during write.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.backward_codecs.lucene92 Class Description ByteVectorValues This class provides access to per-document floating point vector values indexed asKnnByteVectorField
.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).FloatVectorValues This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.SegmentReadState Holder class for common parameters used during read.SegmentWriteState Holder class for common parameters used during write.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.backward_codecs.lucene94 Class Description ByteVectorValues This class provides access to per-document floating point vector values indexed asKnnByteVectorField
.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).FloatVectorValues This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.SegmentReadState Holder class for common parameters used during read.SegmentWriteState Holder class for common parameters used during write.VectorEncoding The numeric datatype of the vector values.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.backward_codecs.lucene95 Class Description ByteVectorValues This class provides access to per-document floating point vector values indexed asKnnByteVectorField
.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).FloatVectorValues This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.SegmentReadState Holder class for common parameters used during read.SegmentWriteState Holder class for common parameters used during write.VectorEncoding The numeric datatype of the vector values.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.classification Class 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.Terms Access to the terms in a specific field.TermVectors API for reading term vectors. -
Classes in org.apache.lucene.index used by org.apache.lucene.classification.document Class 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.classification.utils Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.StoredFields API for reading stored fields.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.codecs Class Description BinaryDocValues A per-document numeric value.ByteVectorValues This class provides access to per-document floating point vector values indexed asKnnByteVectorField
.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 mergedDocsWithFieldSet Accumulator for documents that have a value for a field.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.FilteredTermsEnum Abstract class for enumerating a subset of all terms.FilteredTermsEnum.AcceptStatus Return value, if term should be accepted or the iteration shouldEND
.FloatVectorValues This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.Impact Per-document scoring factors.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.IndexOptions Controls how much information is stored in the postings lists.MergeState Holds common state used during segment merging.MergeState.DocMap A map of doc IDs.NumericDocValues A per-document numeric value.OrdinalMap Maps per-segment ordinals to/from global ordinal space, using a compact packed-ints representation.OrdTermState An ordinal basedTermState
PointValues Access to indexed numeric values.PointValues.IntersectVisitor We recurse thePointValues.PointTree
, using a provided instance of this to guide the recursion.PointValues.PointTree Basic operations to read the KD-tree.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
.Sorter.DocMap A permutation of doc IDs.StoredFields API for reading stored fields.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)
.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.TermVectors API for reading term vectors. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.bitvectors Class Description FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.MergeState Holds common state used during segment merging.SegmentReadState Holder class for common parameters used during read.SegmentWriteState Holder class for common parameters used during write.Sorter.DocMap A permutation of doc IDs.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.codecs.blockterms Class Description 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.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.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.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
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. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.blocktreeords Class Description 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.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.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.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
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. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.bloom Class Description 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.FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.Fields Provides aTerms
index for fields that have it, and lists which fields do.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.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
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.TermsEnum.SeekStatus Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
. -
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.hnsw Class Description ByteVectorValues This class provides access to per-document floating point vector values indexed asKnnByteVectorField
.FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.FloatVectorValues This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.MergeState Holds common state used during segment merging.SegmentReadState Holder class for common parameters used during read.SegmentWriteState Holder class for common parameters used during write.Sorter.DocMap A permutation of doc IDs.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.codecs.lucene90 Class Description 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.DocValuesIterator 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.MergeState Holds common state used during segment merging.NumericDocValues A per-document numeric value.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
.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)
. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene90.blocktree Class Description 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.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.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.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
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. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene90.compressing Class Description 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.DocIDMerger.Sub Represents one sub-reader being mergedFieldInfo 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.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.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.StoredFields API for reading stored fields.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
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.TermsEnum.SeekStatus Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.TermVectors API for reading term vectors. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene94 Class Description DocValuesType DocValues types.FieldInfos Collection ofFieldInfo
s (accessible by number or by name).IndexOptions Controls how much information is stored in the postings lists.SegmentInfo Information about a segment such as its name, directory, and files related to the segment.VectorEncoding The numeric datatype of the vector values.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.codecs.lucene95 Class Description ByteVectorValues This class provides access to per-document floating point vector values indexed asKnnByteVectorField
.DocsWithFieldSet Accumulator for documents that have a value for a field.FloatVectorValues This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.VectorEncoding The numeric datatype of the vector values.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.codecs.lucene99 Class Description ByteVectorValues This class provides access to per-document floating point vector values indexed asKnnByteVectorField
.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 mergedDocsWithFieldSet Accumulator for documents that have a value for a field.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).FloatVectorValues This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.Impact Per-document scoring factors.Impacts Information about upcoming impacts, ie.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.ImpactsSource Source ofImpacts
.MergeState Holds common state used during segment merging.MergeState.DocMap A map of doc IDs.NumericDocValues A per-document numeric value.OrdTermState An ordinal basedTermState
PostingsEnum Iterates through the postings.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.Sorter.DocMap A permutation of doc IDs.TermState Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking.VectorEncoding The numeric datatype of the vector values.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.codecs.memory Class Description 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.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.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.PostingsEnum Iterates through the postings.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.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. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.perfield Class Description BinaryDocValues A per-document numeric value.ByteVectorValues This class provides access to per-document floating point vector values indexed asKnnByteVectorField
.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.FloatVectorValues This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.MergeState Holds common state used during segment merging.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 toLong.compare(long, long)
.SortedSetDocValues A multi-valued version ofSortedDocValues
.Sorter.DocMap A permutation of doc IDs.Terms Access to the terms in a specific field. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.simpletext Class Description 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.ByteVectorValues This class provides access to per-document floating point vector values indexed asKnnByteVectorField
.DocValuesType 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.FloatVectorValues This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.Impact Per-document scoring factors.Impacts Information about upcoming impacts, ie.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.ImpactsSource Source ofImpacts
.IndexOptions Controls how much information is stored in the postings lists.NumericDocValues A per-document numeric value.PointValues Access to indexed numeric values.PointValues.IntersectVisitor We recurse thePointValues.PointTree
, using a provided instance of this to guide the recursion.PointValues.PointTree Basic operations to read the KD-tree.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
.StoredFields API for reading stored fields.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
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.TermsEnum.SeekStatus Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.TermVectors API for reading term vectors.VectorEncoding The numeric datatype of the vector values.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.codecs.uniformsplit Class Description 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.CorruptIndexException This exception is thrown when Lucene detects an inconsistency in the index.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.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.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
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. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.uniformsplit.sharedterms Class Description 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.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.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.MergeState Holds common state used during segment merging.MergeState.DocMap A map of doc IDs.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
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. -
Classes in org.apache.lucene.index used by org.apache.lucene.collation Class Description IndexableField Represents a single field for indexing. -
Classes in org.apache.lucene.index used by org.apache.lucene.document Class Description BinaryDocValues A per-document numeric value.DocValuesIterator 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.LeafReader LeafReader
is an abstract class, providing an interface for accessing an index.LeafReaderContext IndexReaderContext
forLeafReader
instances.NumericDocValues A per-document numeric value.PointValues Access to indexed numeric values.PointValues.IntersectVisitor We recurse thePointValues.PointTree
, 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.SortedNumericDocValues A list of per-document numeric values, sorted according toLong.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 forStoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo)
.VectorEncoding The numeric datatype of the vector values.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.expressions Class Description LeafReaderContext IndexReaderContext
forLeafReader
instances. -
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 ApproximatePriorityQueue An approximate priority queue, which attempts to poll items by decreasing log of the weight, though exact ordering is not guaranteed.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.BinaryDocValuesFieldUpdates.Iterator BinaryDocValuesWriter.BinaryDVs BufferedUpdates Holds buffered deletes and updates, by docID, term or query for a single segment.BufferedUpdates.BytesRefIntMap BufferedUpdates.DeletedTerms BufferedUpdates.DeletedTerms.DeletedTermConsumer BufferedUpdatesStream Tracks the stream ofFrozenBufferedUpdates
.BufferedUpdatesStream.ApplyDeletesResult BufferedUpdatesStream.FinishedSegments Tracks the contiguous range of packets that have finished resolving.BufferedUpdatesStream.SegmentState Holds all per-segment internal state used while resolving deletions.ByteSlicePool Class that Posting and PostingVector use to write interleaved byte streams into shared fixed-size byte[] arrays.ByteSliceReader IndexInput that knows how to read the byte slices written by Posting and PostingVector.ByteVectorValues This class provides access to per-document floating point vector values indexed asKnnByteVectorField
.CheckIndex.DocValuesIteratorSupplier 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 vector valuesCodecReader 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.ConcurrentApproximatePriorityQueue Concurrent version ofApproximatePriorityQueue
, which trades a bit more of ordering for better concurrency by maintaining multiple subApproximatePriorityQueue
s that are locked independently.ConcurrentMergeScheduler.CachedExecutor This executor provides intra-merge threads for parallel execution of merge tasks.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 mergedDocsWithFieldSet Accumulator for documents that have a value for a field.DocumentsWriter This class accepts multiple added documents and directly writes segment files.DocumentsWriter.FlushNotifications DocumentsWriterDeleteQueue DocumentsWriterDeleteQueue
is a non-blocking linked pending deletes queue.DocumentsWriterDeleteQueue.DeleteSlice DocumentsWriterDeleteQueue.Node DocumentsWriterFlushControl This class controlsDocumentsWriterPerThread
flushing during indexing.DocumentsWriterFlushQueue DocumentsWriterFlushQueue.FlushTicket DocumentsWriterPerThread DocumentsWriterPerThread.FlushedSegment DocumentsWriterPerThreadPool DocumentsWriterPerThreadPool
controlsDocumentsWriterPerThread
instances and their thread assignments during indexing.DocumentsWriterStallControl Controls the health status of aDocumentsWriter
sessions.DocValuesFieldUpdates Holds updates of a single DocValues field, for a set of documents within one segment.DocValuesFieldUpdates.AbstractIterator DocValuesFieldUpdates.Iterator An iterator over documents and their updated values.DocValuesFieldUpdates.SingleValueDocValuesFieldUpdates DocValuesIterator DocValuesType DocValues types.DocValuesUpdate An in-place update to a DocValues field.DocValuesUpdate.BinaryDocValuesUpdate An in-place update to a binary DocValues fieldDocValuesUpdate.NumericDocValuesUpdate An in-place update to a numeric DocValues fieldDocValuesWriter ExitableDirectoryReader.ExitableIntersectVisitor 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).FieldInfos.Builder FieldInfos.FieldDimensions FieldInfos.FieldNumbers FieldInfos.FieldVectorProperties FieldInvertState This class tracks the number and position / offset parameters of terms being added to the index.Fields Provides aTerms
index for fields that have it, and lists which fields do.FieldTermIterator Iterates over terms in across multiple fields.FieldUpdatesBuffer This class efficiently buffers numeric and binary field updates and stores terms, values and metadata in a memory efficient way without creating large amounts of objects.FieldUpdatesBuffer.BufferedUpdate Struct like class that is used to iterate over all updates in this bufferFieldUpdatesBuffer.BufferedUpdateIterator An iterator that iterates over all updates in insertion orderFilterCodecReader 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.FloatVectorValues This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.FlushPolicy FlushPolicy
controls when segments are flushed from a RAM resident internal data-structure to theIndexWriter
sDirectory
.FreqProxTermsWriter.SortingPostingsEnum.DocOffsetSorter ATimSorter
which sorts two parallel arrays of doc IDs and offsets in one go.FreqProxTermsWriterPerField FreqProxTermsWriterPerField.FreqProxPostingsArray FrozenBufferedUpdates Holds buffered deletes and updates by term or query, once pushed.FrozenBufferedUpdates.TermDocsIterator.TermsProvider 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
.IndexFileDeleter This class keeps track of each SegmentInfos instance that is still "live", either because it corresponds to a segments_N file in the Directory (a "commit", i.e.IndexFileDeleter.CommitPoint Holds details for each commit point.IndexingChain Default general purpose indexing chain, which handles indexing all types of fields.IndexingChain.FieldSchema A schema of the field in the current document.IndexingChain.PerField NOTE: not static: accesses at least docState, termsHash.IndexingChain.ReservedField 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 LeafReaderIndexUpgrader 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 AnIndexWriter
creates and maintains an index.IndexWriter.AddIndexesMergeSource IndexWriter.DocModifier IndexWriter.DocStats DocStats for this indexIndexWriter.Event Interface for internal atomic events.IndexWriter.EventQueue IndexWriter.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.IndexWriter.Merges 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 IndexWriterLeafMetaData 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".LockableConcurrentApproximatePriorityQueue AConcurrentApproximatePriorityQueue
ofLock
objects.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.LogMergePolicy.SegmentInfoAndLevel MappingMultiPostingsEnum Exposes flex API, merged from flex API of sub-segments, remapping docIDs (this is used for segment merging).MappingMultiPostingsEnum.MappingPostingsSub 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.MergeReader 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.MergeRateLimiter This is theRateLimiter
thatIndexWriter
assigns to each running merge, to giveMergeScheduler
s ionice like control.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
.MultiTerms Exposes flex API, merged from flex API of sub-segments.MultiTermsEnum MultiTermsEnum.TermMergeQueue MultiTermsEnum.TermsEnumWithSlice NormValuesWriter Buffers up pending long per doc, then flushes when segment flushes.NumericDocValues A per-document numeric value.NumericDocValuesFieldUpdates.Iterator NumericDocValuesWriter.NumericDVs 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.OrdinalMap.SegmentMap ParallelPostingsArray PendingDeletes This class handles accounting and applying pending deletes for live segment readersPointValues Access to indexed numeric values.PointValues.IntersectVisitor We recurse thePointValues.PointTree
, using a provided instance of this to guide the recursion.PointValues.PointTree Basic operations to read the KD-tree.PointValues.Relation Used byPointValues.intersect(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 aPrefixCodedTerms
.QueryTimeout Query timeout abstraction that controls whether a query should continue or be stopped.ReaderPool Holds shared SegmentReader instances.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 reopenedSegmentDocValues Manages theDocValuesProducer
held bySegmentReader
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.SegmentMerger The SegmentMerger class combines two or more Segments, represented by an IndexReader, into a single Segment.SegmentMerger.Merger SegmentMerger.VoidMerger 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.SlowCompositeCodecReaderWrapper.DocValuesSub SnapshotDeletionPolicy AnIndexDeletionPolicy
that wraps any otherIndexDeletionPolicy
and adds the ability to hold and later release snapshots of an index.SoftDeletesDirectoryReaderWrapper.SoftDeletesSubReaderWrapper SortedDocValues A per-document byte[] with presorted values.SortedNumericDocValues A list of per-document numeric values, sorted according toLong.compare(long, long)
.SortedNumericDocValuesWriter.LongValues SortedSetDocValues A multi-valued version ofSortedDocValues
.SortedSetDocValuesWriter.DocOrds Sorter.DocMap A permutation of doc IDs.SortFieldProvider Reads/Writes a named SortField from a segment info file, used to record index sortsSortingCodecReader.SortingIntersectVisitor StandardDirectoryReader Default implementation ofDirectoryReader
.StoredFields API for reading stored fields.StoredFieldsConsumer 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)
.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)
.TermsEnumIndex Wrapper around aTermsEnum
and an integer that identifies it.TermsEnumIndex.TermState Wrapper around a term that allows for quick equals comparisons.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 This class stores streams of information per term without knowing the size of the stream ahead of time.TermState Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking.TermStates TermVectors API for reading term vectors.TermVectorsConsumer TermVectorsConsumerPerField TermVectorsConsumerPerField.TermVectorsPostingsArray TieredMergePolicy Merges segments of approximately equal size, subject to an allowed number of segments per tier.TieredMergePolicy.MERGE_TYPE TieredMergePolicy.MergeScore Holds score and explanation for a single candidate merge.TieredMergePolicy.SegmentSizeAndDocs TrackingTmpOutputDirectoryWrapper 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().VectorEncoding The numeric datatype of the vector values.VectorSimilarityFunction Vector similarity function; used in search to return top K most similar vectors to a target vector.VectorValues Deprecated.useFloatVectorValues
insteadVectorValuesConsumer Streams vector values for indexing to the given codec's vectors writer. -
Classes in org.apache.lucene.index used by org.apache.lucene.index.memory Class Description 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.ByteVectorValues This class provides access to per-document floating point vector values indexed asKnnByteVectorField
.DocValuesType 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.FloatVectorValues This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.IndexableField Represents a single field for indexing.IndexableFieldType Describes the properties of a field.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.LeafMetaData Provides read-only metadata about a leaf.LeafReader LeafReader
is an abstract class, providing an interface for accessing an index.NumericDocValues A per-document numeric value.PointValues Access to indexed numeric values.PointValues.PointTree Basic operations to read the KD-tree.PostingsEnum Iterates through the postings.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
.StoredFields API for reading stored fields.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
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.TermVectors API for reading term vectors. -
Classes in org.apache.lucene.index used by org.apache.lucene.internal.tests Class Description ConcurrentMergeScheduler AMergeScheduler
that runs each merge using a separate thread.DirectoryReader DirectoryReader is an implementation ofCompositeReader
that can read indexes in aDirectory
.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).Impacts Information about upcoming impacts, ie.IndexReader.CacheKey A cache key identifying a resource that is being cached on.IndexWriter AnIndexWriter
creates and maintains an index.SegmentCommitInfo Embeds a [read-only] SegmentInfo and adds per-commit fields.SegmentReader IndexReader implementation over a single segment. -
Classes in org.apache.lucene.index used by org.apache.lucene.misc Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.IndexWriterConfig Holds all the configuration that is used to create anIndexWriter
.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
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
. -
Classes in org.apache.lucene.index used by org.apache.lucene.misc.document Class Description 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.IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index. -
Classes in org.apache.lucene.index used by org.apache.lucene.misc.index Class Description BaseCompositeReader Base class for implementingCompositeReader
s based on an array of sub-readers.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.DirectoryReader DirectoryReader is an implementation ofCompositeReader
that can read indexes in aDirectory
.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.FilterMergePolicy A wrapper forMergePolicy
instances.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.IndexWriter AnIndexWriter
creates and maintains an index.IndexWriterConfig Holds all the configuration that is used to create anIndexWriter
.LeafReader LeafReader
is an abstract class, providing an interface for accessing an index.LeafReaderContext IndexReaderContext
forLeafReader
instances.MergePolicy Expert: a MergePolicy determines the sequence of primitive merge operations.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.MergeTrigger MergeTrigger is passed toMergePolicy.findMerges(MergeTrigger, SegmentInfos, MergePolicy.MergeContext)
to indicate the event that triggered the merge.SegmentCommitInfo Embeds a [read-only] SegmentInfo and adds per-commit fields.SegmentInfos A collection of segmentInfo objects with methods for operating on those segments in relation to the file system.Sorter.DocMap A permutation of doc IDs.Term A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.misc.search Class Description LeafReaderContext IndexReaderContext
forLeafReader
instances.NumericDocValues A per-document numeric value.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
. -
Classes in org.apache.lucene.index used by org.apache.lucene.monitor Class Description BinaryDocValues A per-document numeric value.IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.IndexReader.CacheKey A cache key identifying a resource that is being cached on.IndexWriter AnIndexWriter
creates and maintains an index.IndexWriterConfig Holds all the configuration that is used to create anIndexWriter
.LeafReader LeafReader
is an abstract class, providing an interface for accessing an index.LeafReaderContext IndexReaderContext
forLeafReader
instances.SortedDocValues A per-document byte[] with presorted values.Term A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.payloads Class Description IndexReaderContext A struct like class that represents a hierarchical relationship betweenIndexReader
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 Description IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.LeafReaderContext IndexReaderContext
forLeafReader
instances.Term A Term represents a word from text.TermStates -
Classes in org.apache.lucene.index used by org.apache.lucene.queries.function Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.LeafReaderContext IndexReaderContext
forLeafReader
instances.Term A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.queries.function.docvalues Class Description LeafReaderContext IndexReaderContext
forLeafReader
instances.SortedDocValues A per-document byte[] with presorted values. -
Classes in org.apache.lucene.index used by org.apache.lucene.queries.function.valuesource Class Description LeafReader LeafReader
is an abstract class, providing an interface for accessing an index.LeafReaderContext IndexReaderContext
forLeafReader
instances.NumericDocValues A per-document numeric value.VectorEncoding The numeric datatype of the vector values.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.queries.intervals Class Description LeafReaderContext IndexReaderContext
forLeafReader
instances.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.queries.mlt Class 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 Description LeafReaderContext IndexReaderContext
forLeafReader
instances.PostingsEnum Iterates through the postings.Term A Term represents a word from text.TermStates -
Classes in org.apache.lucene.index used by org.apache.lucene.queries.spans Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.LeafReaderContext IndexReaderContext
forLeafReader
instances.PostingsEnum Iterates through the postings.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
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.TermStates -
Classes in org.apache.lucene.index used by org.apache.lucene.queryparser.classic Class Description Term A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.queryparser.complexPhrase Class Description Term A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.queryparser.surround.query Class 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.codecs.idversion Class Description 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.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.ImpactsEnum Extension ofPostingsEnum
which also provides information about upcoming impacts.NumericDocValues A per-document numeric value.OrdTermState An ordinal basedTermState
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
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. -
Classes in org.apache.lucene.index used by org.apache.lucene.sandbox.document Class Description IndexableField Represents a single field for indexing.PointValues Access to indexed numeric values.PointValues.IntersectVisitor We recurse thePointValues.PointTree
, using a provided instance of this to guide the recursion.PointValues.PointTree Basic operations to read the KD-tree.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.sandbox.index Class Description FilterMergePolicy A wrapper forMergePolicy
instances.MergePolicy Expert: a MergePolicy determines the sequence of primitive merge operations.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.MergeTrigger MergeTrigger is passed toMergePolicy.findMerges(MergeTrigger, SegmentInfos, MergePolicy.MergeContext)
to indicate the event that triggered the merge.SegmentInfos A collection of segmentInfo objects with methods for operating on those segments in relation to the file system. -
Classes in org.apache.lucene.index used by org.apache.lucene.sandbox.queries Class 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.search Class Description DocValuesIterator 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
forLeafReader
instances.NumericDocValues A per-document numeric value.PointValues Access to indexed numeric values.PointValues.IntersectVisitor We recurse thePointValues.PointTree
, using a provided instance of this to guide the recursion.PointValues.PointTree Basic operations to read the KD-tree.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.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)
.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 Class Description BinaryDocValues A per-document numeric value.DirectoryReader DirectoryReader is an implementation ofCompositeReader
that can read indexes in aDirectory
.DocValuesIterator FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.FilteredTermsEnum Abstract class for enumerating a subset of all terms.FilteredTermsEnum.AcceptStatus Return value, if term should be accepted or the iteration shouldEND
.Impact Per-document scoring factors.Impacts Information about upcoming impacts, ie.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.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.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.PointValues Access to indexed numeric values.PointValues.IntersectVisitor We recurse thePointValues.PointTree
, using a provided instance of this to guide the recursion.PointValues.PointTree Basic operations to read the KD-tree.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 Query timeout abstraction that controls whether a query should continue or be stopped.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 sortsStoredFields API for reading stored fields.StoredFieldVisitor 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.PointValues.PointTree Basic operations to read the KD-tree.PostingsEnum Iterates through the postings.SortedDocValues A per-document byte[] with presorted values.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.search.grouping Class Description LeafReaderContext IndexReaderContext
forLeafReader
instances.SortedDocValues A per-document byte[] with presorted values.SortedSetDocValues A multi-valued version ofSortedDocValues
.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.search.highlight Class Description BinaryDocValues A per-document numeric value.ByteVectorValues This class provides access to per-document floating point vector values indexed asKnnByteVectorField
.FieldInfos Collection ofFieldInfo
s (accessible by number or by name).Fields Provides aTerms
index for fields that have it, and lists which fields do.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.FloatVectorValues This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.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.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.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 toLong.compare(long, long)
.SortedSetDocValues A multi-valued version ofSortedDocValues
.StoredFields API for reading stored fields.StoredFieldVisitor 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.TermVectors API for reading term vectors. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.join Class Description DocValuesIterator FilteredTermsEnum Abstract class for enumerating a subset of all terms.FilteredTermsEnum.AcceptStatus Return value, if term should be accepted or the iteration shouldEND
.IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.IndexReader.CacheKey A cache key identifying a resource that is being cached on.LeafReader LeafReader
is an abstract class, providing an interface for accessing an index.LeafReaderContext IndexReaderContext
forLeafReader
instances.NumericDocValues A per-document numeric value.OrdinalMap Maps per-segment ordinals to/from global ordinal space, using a compact packed-ints representation.PointValues.IntersectVisitor We recurse thePointValues.PointTree
, 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.PrefixCodedTerms Prefix codes term instances (prefixes are shared).PrefixCodedTerms.TermIterator An iterator over the list of terms stored in aPrefixCodedTerms
.QueryTimeout Query timeout abstraction that controls whether a query should continue or be stopped.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
.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.search.knn Class Description LeafReaderContext IndexReaderContext
forLeafReader
instances. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.matchhighlight Class Description 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
forLeafReader
instances. -
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.search.spell Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.IndexWriterConfig Holds all the configuration that is used to create anIndexWriter
.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
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.suggest Class Description 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.LeafReaderContext IndexReaderContext
forLeafReader
instances.NumericDocValues A per-document numeric value.StoredFields API for reading stored fields. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.suggest.analyzing Class Description IndexWriter AnIndexWriter
creates and maintains an index.IndexWriterConfig Holds all the configuration that is used to create anIndexWriter
.IndexWriterConfig.OpenMode Specifies the open mode forIndexWriter
.TermVectors API for reading term vectors. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.suggest.document Class Description Fields Provides aTerms
index for fields that have it, and lists which fields do.FilterLeafReader.FilterTerms Base class for filteringTerms
implementations.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.LeafReaderContext IndexReaderContext
forLeafReader
instances.PostingsEnum Iterates through the postings.SegmentReadState Holder class for common parameters used during read.SegmentWriteState Holder class for common parameters used during write.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)
. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.uhighlight 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.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.FilterTerms Base class for filteringTerms
implementations.FilterLeafReader.FilterTermsEnum Base class for filteringTermsEnum
implementations.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.LeafReader LeafReader
is an abstract class, providing an interface for accessing an index.NumericDocValues A per-document numeric value.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 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)
.TermVectors API for reading term vectors. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.vectorhighlight Class 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.spatial3d Class Description 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.LeafReaderContext IndexReaderContext
forLeafReader
instances.PointValues.IntersectVisitor We recurse thePointValues.PointTree
, 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.SortedNumericDocValues A list of per-document numeric values, sorted according toLong.compare(long, long)
. -
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 thePointValues.PointTree
, using a provided instance of this to guide the recursion.PointValues.PointTree Basic operations to read the KD-tree.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.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 FieldInfo Access to the Field Info file that describes document fields and whether or not they are indexed.MergeState.DocMap A map of doc IDs. -
Classes in org.apache.lucene.index used by org.apache.lucene.util.quantization Class Description FloatVectorValues This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.VectorSimilarityFunction Vector similarity function; used in search to return top K most similar vectors to a target vector.