Uses of Package
org.apache.lucene.index
Packages that use org.apache.lucene.index
Package
Description
Analysis components based on ICU
Automatically filter high-frequency stopwords.
Analysis components for Synonyms using Word2Vec model.
Compressing helper classes.
BlockTree terms dictionary.
Lucene 5.0 file format.
Lucene 5.0 compressing format.
Lucene 6.0 file format.
Components from the Lucene 7.0 index format.
Components from the Lucene 8.0 index format.
Lucene 8.4 file format.
Lucene 8.6 file format.
Lucene 8.7 file format.
Lucene 9.0 file format.
Lucene 9.1 file format.
Lucene 9.12 file format.
Lucene 9.2 file format.
Lucene 9.4 file format.
Lucene 9.5 file format.
Lucene 9.9 file format.
Uses already seen data (the indexed documents) to classify an input ( can be simple text or a
structured document).
Uses already seen data (the indexed documents) to classify new documents.
Utilities for evaluation, data preparation, etc.
Codecs API: API for customization of the encoding and structure of the index.
A simple bit-vector format that supports hamming distance and storing vectors in an HNSW graph
Pluggable term index / block terms dictionary implementations.
Same postings format as Lucene50, except the terms dictionary also supports ords, i.e.
Codec PostingsFormat for fast access to low-frequency terms such as primary key fields.
Compressing helper classes.
HNSW vector helper classes.
Lucene 10.1 file format.
Lucene 9.0 file format.
BlockTree terms dictionary.
Lucene 9.0 compressing format.
Lucene 9.4 file format.
Lucene 9.5 file format.
Lucene 9.9 file format.
Term dictionary, DocValues or Postings formats that are read entirely into memory.
Postings format that can delegate to different formats per-field.
Simpletext Codec: writes human readable postings.
Pluggable term index / block terms dictionary implementations.
Pluggable term index / block terms dictionary implementations.
Unicode collation support.
The logical representation of a
Document
for indexing and
searching.Expressions.
Faceted search.
Provides FacetSets faceting capabilities which allows users to facet on high dimensional field
values.
Provides faceting capabilities over facets that were indexed with
SortedSetDocValuesFacetField
.Taxonomy of Categories.
Taxonomy index implementation using on top of a Directory.
Geospatial Utility Implementations for Lucene Core
Code to maintain and access indices.
High-performance single-document main memory Apache Lucene fulltext search index.
Internal bridges to package-private internals, for use by the lucene test framework only.
Miscellaneous Lucene utilities that don't really fit anywhere else.
Misc extensions of the Document/Field API.
Misc index tools and index support.
Misc search implementations.
Monitoring framework
Experimental classes for interacting with payloads
Filters and Queries that add to core Lucene.
Queries that compute score based upon a function.
FunctionValues for different data types.
A variety of functions to use with FunctionQuery.
Intervals queries
Document similarity query generators.
The payloads package provides Query mechanisms for finding and using payloads.
The calculus of spans.
A simple query parser implemented with JavaCC.
QueryParser which permits complex phrase query syntax eg "(john jon jonathan~) peters*"
This package contains SrndQuery and its subclasses.
A primary-key postings format that associates a version (long) with each term and can provide
fail-fast lookups by ID and version.
This package implements KMeans algorithm for clustering vectors
This package contains several point types:
BigIntegerPoint
for 128-bit
integers
LatLonPoint
for latitude/longitude
geospatial points
Sandbox faceting - Collectors that compute facets.
Sandbox faceting: facet cutters, see
FacetCutter
for details.Sandbox faceting: Range Faceting
Sandbox faceting: classes that can record per ordinal data E.g.
Experimental index-related classes
Additional queries (some may have caveats or limitations)
This package contains a flexible graph-based proximity query, TermAutomatonQuery, and geospatial
queries.
Code to search indices.
Comparators, used to compare hits so as to determine their sort order when collecting the top
results with
TopFieldCollector
.Grouping.
Highlighting search terms.
Support for index-time and query-time joins.
Classes related to vector search: knn and vector fields.
This package contains several components useful to build a highlighter on top of the
Matches
API.This package contains the various ranking models that can be used in Lucene.
Suggest alternate spellings for words.
Support for Autocomplete/Autosuggest
Analyzer based autosuggest.
Support for document suggestion
The UnifiedHighlighter -- a flexible highlighter that can get offsets from postings, term
vectors, or analysis.
Another highlighter implementation based on term vectors.
Lucene field & query support for the spatial geometry implemented in
org.apache.lucene.spatial3d.geom
.Some utility classes.
Finite-state automaton for regular expressions.
Block KD-tree, implementing the generic spatial data structure described in this paper.
Utility classes for working with token streams as graphs.
Navigable Small-World graph, nominally Hierarchical but currently only has a single layer.
Provides quantization methods for scaling vector values to smaller data types and possibly fewer
dimensions
-
Classes in org.apache.lucene.index used by org.apache.lucene.analysis.icu
-
Classes in org.apache.lucene.index used by org.apache.lucene.analysis.queryClassDescriptionIndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.A Term represents a word from text.
-
Classes in org.apache.lucene.index used by org.apache.lucene.analysis.synonym.word2vecClassDescriptionThis class provides access to per-document floating point vector values indexed as
KnnFloatVectorField
.This class abstracts addressing of document vector values indexed asKnnFloatVectorField
orKnnByteVectorField
.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
-
Classes in org.apache.lucene.index used by org.apache.lucene.backward_codecs.lucene40.blocktreeClassDescriptionA base TermsEnum that adds default implementations for
BaseTermsEnum.attributes()
BaseTermsEnum.termState()
BaseTermsEnum.seekExact(BytesRef)
BaseTermsEnum.seekExact(BytesRef, TermState)
In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.Access to the Field Info file that describes document fields and whether or not they are indexed.Provides aTerms
index for fields that have it, and lists which fields do.Extension ofPostingsEnum
which also provides information about upcoming impacts.Iterates through the postings.Holder class for common parameters used during read.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef)
,TermsEnum.seekExact(BytesRef)
) or step through (BytesRefIterator.next()
terms to obtain frequency information (TermsEnum.docFreq()
),PostingsEnum
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking. -
Classes in org.apache.lucene.index used by org.apache.lucene.backward_codecs.lucene50ClassDescriptionAccess to the Field Info file that describes document fields and whether or not they are indexed.Collection of
FieldInfo
s (accessible by number or by name).Per-document scoring factors.Information about upcoming impacts, ie.Extension ofPostingsEnum
which also provides information about upcoming impacts.Source ofImpacts
.An ordinal basedTermState
Iterates through the postings.Embeds a [read-only] SegmentInfo and adds per-commit fields.Information about a segment such as its name, directory, and files related to the segment.Holder class for common parameters used during read.Holder class for common parameters used during write.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.compressingClassDescriptionA base TermsEnum that adds default implementations for
BaseTermsEnum.attributes()
BaseTermsEnum.termState()
BaseTermsEnum.seekExact(BytesRef)
BaseTermsEnum.seekExact(BytesRef, TermState)
In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).Provides aTerms
index for fields that have it, and lists which fields do.Extension ofPostingsEnum
which also provides information about upcoming impacts.Iterates through the postings.Information about a segment such as its name, directory, and files related to the segment.API for reading stored fields.Expert: provides a low-level means of accessing the stored field values in an index.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef)
,TermsEnum.seekExact(BytesRef)
) or step through (BytesRefIterator.next()
terms to obtain frequency information (TermsEnum.docFreq()
),PostingsEnum
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.API for reading term vectors. -
Classes in org.apache.lucene.index used by org.apache.lucene.backward_codecs.lucene60ClassDescriptionDocValues types.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection of
FieldInfo
s (accessible by number or by name).Controls how much information is stored in the postings lists.Access to indexed numeric values.Information about a segment such as its name, directory, and files related to the segment.Holder class for common parameters used during read.Holder class for common parameters used during write. -
Classes in org.apache.lucene.index used by org.apache.lucene.backward_codecs.lucene70ClassDescriptionInformation 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.lucene80ClassDescriptionA base TermsEnum that adds default implementations for
BaseTermsEnum.attributes()
BaseTermsEnum.termState()
BaseTermsEnum.seekExact(BytesRef)
BaseTermsEnum.seekExact(BytesRef, TermState)
In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.A per-document numeric value.Skipper forDocValues
.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).Extension ofPostingsEnum
which also provides information about upcoming impacts.A per-document numeric value.Iterates through the postings.Holder class for common parameters used during read.Holder class for common parameters used during write.A per-document byte[] with presorted values.A list of per-document numeric values, sorted according toLong.compare(long, long)
.A multi-valued version ofSortedDocValues
.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)
.Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
. -
Classes in org.apache.lucene.index used by org.apache.lucene.backward_codecs.lucene84ClassDescriptionAccess to the Field Info file that describes document fields and whether or not they are indexed.Per-document scoring factors.Information about upcoming impacts, ie.Extension of
PostingsEnum
which also provides information about upcoming impacts.Source ofImpacts
.An ordinal basedTermState
Iterates through the postings.Holder class for common parameters used during read.Holder class for common parameters used during write.Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking. -
Classes in org.apache.lucene.index used by org.apache.lucene.backward_codecs.lucene86ClassDescriptionAccess to indexed numeric values.Information about a segment such as its name, directory, and files related to the segment.Holder class for common parameters used during read.Holder class for common parameters used during write.
-
Classes in org.apache.lucene.index used by org.apache.lucene.backward_codecs.lucene87ClassDescriptionCollection of
FieldInfo
s (accessible by number or by name).Information about a segment such as its name, directory, and files related to the segment. -
Classes in org.apache.lucene.index used by org.apache.lucene.backward_codecs.lucene90ClassDescriptionThis class provides access to per-document floating point vector values indexed as
KnnByteVectorField
.DocValues types.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.Per-document scoring factors.Information about upcoming impacts, ie.Extension ofPostingsEnum
which also provides information about upcoming impacts.Source ofImpacts
.Controls how much information is stored in the postings lists.This class abstracts addressing of document vector values indexed asKnnFloatVectorField
orKnnByteVectorField
.A DocIdSetIterator that also provides an index() method tracking a distinct ordinal for a vector associated with each doc.A per-document numeric value.An ordinal basedTermState
Iterates through the postings.Information about a segment such as its name, directory, and files related to the segment.Holder class for common parameters used during read.Holder class for common parameters used during write.Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking.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.lucene91ClassDescriptionThis class provides access to per-document floating point vector values indexed as
KnnByteVectorField
.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.This class abstracts addressing of document vector values indexed asKnnFloatVectorField
orKnnByteVectorField
.A DocIdSetIterator that also provides an index() method tracking a distinct ordinal for a vector associated with each doc.Holder class for common parameters used during read.Holder class for common parameters used during write.Vector similarity function; used in search to return top K most similar vectors to a target vector. -
Classes in org.apache.lucene.index used by org.apache.lucene.backward_codecs.lucene912ClassDescriptionAccess to the Field Info file that describes document fields and whether or not they are indexed.Per-document scoring factors.Information about upcoming impacts, ie.Extension of
PostingsEnum
which also provides information about upcoming impacts.Source ofImpacts
.An ordinal basedTermState
Iterates through the postings.Holder class for common parameters used during read.Holder class for common parameters used during write.Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking. -
Classes in org.apache.lucene.index used by org.apache.lucene.backward_codecs.lucene92ClassDescriptionThis class provides access to per-document floating point vector values indexed as
KnnByteVectorField
.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.This class abstracts addressing of document vector values indexed asKnnFloatVectorField
orKnnByteVectorField
.A DocIdSetIterator that also provides an index() method tracking a distinct ordinal for a vector associated with each doc.Holder class for common parameters used during read.Holder class for common parameters used during write.Vector similarity function; used in search to return top K most similar vectors to a target vector. -
Classes in org.apache.lucene.index used by org.apache.lucene.backward_codecs.lucene94ClassDescriptionThis class provides access to per-document floating point vector values indexed as
KnnByteVectorField
.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.This class abstracts addressing of document vector values indexed asKnnFloatVectorField
orKnnByteVectorField
.A DocIdSetIterator that also provides an index() method tracking a distinct ordinal for a vector associated with each doc.Holder class for common parameters used during read.Holder class for common parameters used during write.The numeric datatype of the vector values.Vector similarity function; used in search to return top K most similar vectors to a target vector. -
Classes in org.apache.lucene.index used by org.apache.lucene.backward_codecs.lucene95ClassDescriptionThis class provides access to per-document floating point vector values indexed as
KnnByteVectorField
.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.Holder class for common parameters used during read.Holder class for common parameters used during write.The numeric datatype of the vector values.Vector similarity function; used in search to return top K most similar vectors to a target vector. -
Classes in org.apache.lucene.index used by org.apache.lucene.backward_codecs.lucene99ClassDescriptionAccess to the Field Info file that describes document fields and whether or not they are indexed.Per-document scoring factors.Information about upcoming impacts, ie.Extension of
PostingsEnum
which also provides information about upcoming impacts.Source ofImpacts
.An ordinal basedTermState
Iterates through the postings.Holder class for common parameters used during read.Holder class for common parameters used during write.Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking. -
Classes in org.apache.lucene.index used by org.apache.lucene.classificationClassDescriptionIndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.A Term represents a word from text.Access to the terms in a specific field.API for reading term vectors.
-
Classes in org.apache.lucene.index used by org.apache.lucene.classification.documentClassDescriptionIndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.A Term represents a word from text.
-
Classes in org.apache.lucene.index used by org.apache.lucene.classification.utilsClassDescriptionIndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.API for reading stored fields.A Term represents a word from text.Access to the terms in a specific field.
-
Classes in org.apache.lucene.index used by org.apache.lucene.codecsClassDescriptionA base TermsEnum that adds default implementations for
BaseTermsEnum.attributes()
BaseTermsEnum.termState()
BaseTermsEnum.seekExact(BytesRef)
BaseTermsEnum.seekExact(BytesRef, TermState)
In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.A per-document numeric value.This class provides access to per-document floating point vector values indexed asKnnByteVectorField
.Utility class to help merging documents from sub-readers according to either simple concatenated (unsorted) order, or by a specified index-time sort, skipping deleted documents and remapping non-deleted documents.Represents one sub-reader being mergedAccumulator for documents that have a value for a field.Skipper forDocValues
.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).Provides aTerms
index for fields that have it, and lists which fields do.Abstract class for enumerating a subset of all terms.Return value, if term should be accepted or the iteration shouldEND
.This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.Per-document scoring factors.Extension ofPostingsEnum
which also provides information about upcoming impacts.Controls how much information is stored in the postings lists.This class abstracts addressing of document vector values indexed asKnnFloatVectorField
orKnnByteVectorField
.A DocIdSetIterator that also provides an index() method tracking a distinct ordinal for a vector associated with each doc.Holds common state used during segment merging.A map of doc IDs.A per-document numeric value.Maps per-segment ordinals to/from global ordinal space, using a compact packed-ints representation.An ordinal basedTermState
Access to indexed numeric values.We recurse thePointValues.PointTree
, using a provided instance of this to guide the recursion.Basic operations to read the KD-tree.Iterates through the postings.Embeds a [read-only] SegmentInfo and adds per-commit fields.Information about a segment such as its name, directory, and files related to the segment.Holder class for common parameters used during read.Holder class for common parameters used during write.A per-document byte[] with presorted values.A list of per-document numeric values, sorted according toLong.compare(long, long)
.A multi-valued version ofSortedDocValues
.A permutation of doc IDs.Iterator over KnnVectorValues accepting a mapping to differently-sorted docs.API for reading stored fields.Expert: provides a low-level means of accessing the stored field values in an index.Enumeration of possible return values forStoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo)
.Iterator to seek (TermsEnum.seekCeil(BytesRef)
,TermsEnum.seekExact(BytesRef)
) or step through (BytesRefIterator.next()
terms to obtain frequency information (TermsEnum.docFreq()
),PostingsEnum
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking.API for reading term vectors.The numeric datatype of the vector values. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.bitvectorsClassDescriptionThis class provides access to per-document floating point vector values indexed as
KnnByteVectorField
.Access to the Field Info file that describes document fields and whether or not they are indexed.This class abstracts addressing of document vector values indexed asKnnFloatVectorField
orKnnByteVectorField
.Holds common state used during segment merging.Holder class for common parameters used during read.Holder class for common parameters used during write.A permutation of doc IDs.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.blocktermsClassDescriptionA base TermsEnum that adds default implementations for
BaseTermsEnum.attributes()
BaseTermsEnum.termState()
BaseTermsEnum.seekExact(BytesRef)
BaseTermsEnum.seekExact(BytesRef, TermState)
In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).Provides aTerms
index for fields that have it, and lists which fields do.Extension ofPostingsEnum
which also provides information about upcoming impacts.Iterates through the postings.Holder class for common parameters used during read.Holder class for common parameters used during write.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef)
,TermsEnum.seekExact(BytesRef)
) or step through (BytesRefIterator.next()
terms to obtain frequency information (TermsEnum.docFreq()
),PostingsEnum
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.blocktreeordsClassDescriptionA base TermsEnum that adds default implementations for
BaseTermsEnum.attributes()
BaseTermsEnum.termState()
BaseTermsEnum.seekExact(BytesRef)
BaseTermsEnum.seekExact(BytesRef, TermState)
In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).Provides aTerms
index for fields that have it, and lists which fields do.Extension ofPostingsEnum
which also provides information about upcoming impacts.Iterates through the postings.Holder class for common parameters used during read.Holder class for common parameters used during write.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef)
,TermsEnum.seekExact(BytesRef)
) or step through (BytesRefIterator.next()
terms to obtain frequency information (TermsEnum.docFreq()
),PostingsEnum
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.bloomClassDescriptionA base TermsEnum that adds default implementations for
BaseTermsEnum.attributes()
BaseTermsEnum.termState()
BaseTermsEnum.seekExact(BytesRef)
BaseTermsEnum.seekExact(BytesRef, TermState)
In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.Access to the Field Info file that describes document fields and whether or not they are indexed.Provides aTerms
index for fields that have it, and lists which fields do.Extension ofPostingsEnum
which also provides information about upcoming impacts.Iterates through the postings.Holder class for common parameters used during read.Holder class for common parameters used during write.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef)
,TermsEnum.seekExact(BytesRef)
) or step through (BytesRefIterator.next()
terms to obtain frequency information (TermsEnum.docFreq()
),PostingsEnum
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.compressing
-
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.hnswClassDescriptionThis class provides access to per-document floating point vector values indexed as
KnnByteVectorField
.Accumulator for documents that have a value for a field.Access to the Field Info file that describes document fields and whether or not they are indexed.This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.This class abstracts addressing of document vector values indexed asKnnFloatVectorField
orKnnByteVectorField
.Holds common state used during segment merging.Holder class for common parameters used during read.Holder class for common parameters used during write.Vector similarity function; used in search to return top K most similar vectors to a target vector. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene101ClassDescriptionAccess to the Field Info file that describes document fields and whether or not they are indexed.Per-document scoring factors.Information about upcoming impacts, ie.Extension of
PostingsEnum
which also provides information about upcoming impacts.Source ofImpacts
.Controls how much information is stored in the postings lists.A per-document numeric value.An ordinal basedTermState
Iterates through the postings.Holder class for common parameters used during read.Holder class for common parameters used during write.Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene90ClassDescriptionA base TermsEnum that adds default implementations for
BaseTermsEnum.attributes()
BaseTermsEnum.termState()
BaseTermsEnum.seekExact(BytesRef)
BaseTermsEnum.seekExact(BytesRef, TermState)
In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.A per-document numeric value.Skipper forDocValues
.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).Extension ofPostingsEnum
which also provides information about upcoming impacts.A DocIdSetIterator that also provides an index() method tracking a distinct ordinal for a vector associated with each doc.Holds common state used during segment merging.A per-document numeric value.Access to indexed numeric values.Iterates through the postings.Embeds a [read-only] SegmentInfo and adds per-commit fields.Information about a segment such as its name, directory, and files related to the segment.Holder class for common parameters used during read.Holder class for common parameters used during write.A per-document byte[] with presorted values.A list of per-document numeric values, sorted according toLong.compare(long, long)
.A multi-valued version ofSortedDocValues
.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)
.Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene90.blocktreeClassDescriptionA base TermsEnum that adds default implementations for
BaseTermsEnum.attributes()
BaseTermsEnum.termState()
BaseTermsEnum.seekExact(BytesRef)
BaseTermsEnum.seekExact(BytesRef, TermState)
In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).Provides aTerms
index for fields that have it, and lists which fields do.Extension ofPostingsEnum
which also provides information about upcoming impacts.Iterates through the postings.Holder class for common parameters used during read.Holder class for common parameters used during write.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef)
,TermsEnum.seekExact(BytesRef)
) or step through (BytesRefIterator.next()
terms to obtain frequency information (TermsEnum.docFreq()
),PostingsEnum
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene90.compressingClassDescriptionA base TermsEnum that adds default implementations for
BaseTermsEnum.attributes()
BaseTermsEnum.termState()
BaseTermsEnum.seekExact(BytesRef)
BaseTermsEnum.seekExact(BytesRef, TermState)
In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.Represents one sub-reader being mergedAccess to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).Provides aTerms
index for fields that have it, and lists which fields do.Extension ofPostingsEnum
which also provides information about upcoming impacts.Holds common state used during segment merging.Iterates through the postings.Information about a segment such as its name, directory, and files related to the segment.API for reading stored fields.Expert: provides a low-level means of accessing the stored field values in an index.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef)
,TermsEnum.seekExact(BytesRef)
) or step through (BytesRefIterator.next()
terms to obtain frequency information (TermsEnum.docFreq()
),PostingsEnum
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.API for reading term vectors. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene94ClassDescriptionOptions for skip indexes on doc values.DocValues types.Collection of
FieldInfo
s (accessible by number or by name).Controls how much information is stored in the postings lists.Information about a segment such as its name, directory, and files related to the segment.The numeric datatype of the vector values.Vector similarity function; used in search to return top K most similar vectors to a target vector. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene95ClassDescriptionThis class provides access to per-document floating point vector values indexed as
KnnByteVectorField
.Accumulator for documents that have a value for a field.This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.This class abstracts addressing of document vector values indexed asKnnFloatVectorField
orKnnByteVectorField
.A DocIdSetIterator that also provides an index() method tracking a distinct ordinal for a vector associated with each doc.The numeric datatype of the vector values.Vector similarity function; used in search to return top K most similar vectors to a target vector. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene99ClassDescriptionThis class provides access to per-document floating point vector values indexed as
KnnByteVectorField
.Utility class to help merging documents from sub-readers according to either simple concatenated (unsorted) order, or by a specified index-time sort, skipping deleted documents and remapping non-deleted documents.Represents one sub-reader being mergedAccumulator for documents that have a value for a field.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.This class abstracts addressing of document vector values indexed asKnnFloatVectorField
orKnnByteVectorField
.A DocIdSetIterator that also provides an index() method tracking a distinct ordinal for a vector associated with each doc.Holds common state used during segment merging.A map of doc IDs.Information about a segment such as its name, directory, and files related to the segment.Holder class for common parameters used during read.Holder class for common parameters used during write.A permutation of doc IDs.The numeric datatype of the vector values.Vector similarity function; used in search to return top K most similar vectors to a target vector. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.memoryClassDescriptionA base TermsEnum that adds default implementations for
BaseTermsEnum.attributes()
BaseTermsEnum.termState()
BaseTermsEnum.seekExact(BytesRef)
BaseTermsEnum.seekExact(BytesRef, TermState)
In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).Provides aTerms
index for fields that have it, and lists which fields do.Extension ofPostingsEnum
which also provides information about upcoming impacts.Iterates through the postings.Information about a segment such as its name, directory, and files related to the segment.Holder class for common parameters used during read.Holder class for common parameters used during write.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef)
,TermsEnum.seekExact(BytesRef)
) or step through (BytesRefIterator.next()
terms to obtain frequency information (TermsEnum.docFreq()
),PostingsEnum
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.perfieldClassDescriptionA per-document numeric value.This class provides access to per-document floating point vector values indexed as
KnnByteVectorField
.Skipper forDocValues
.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).Provides aTerms
index for fields that have it, and lists which fields do.This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.Holds common state used during segment merging.A per-document numeric value.Holder class for common parameters used during read.Holder class for common parameters used during write.A per-document byte[] with presorted values.A list of per-document numeric values, sorted according toLong.compare(long, long)
.A multi-valued version ofSortedDocValues
.A permutation of doc IDs.Access to the terms in a specific field. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.simpletextClassDescriptionA base TermsEnum that adds default implementations for
BaseTermsEnum.attributes()
BaseTermsEnum.termState()
BaseTermsEnum.seekExact(BytesRef)
BaseTermsEnum.seekExact(BytesRef, TermState)
In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.A per-document numeric value.This class provides access to per-document floating point vector values indexed asKnnByteVectorField
.Options for skip indexes on doc values.Skipper forDocValues
.DocValues types.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).Provides aTerms
index for fields that have it, and lists which fields do.This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.Per-document scoring factors.Information about upcoming impacts, ie.Extension ofPostingsEnum
which also provides information about upcoming impacts.Source ofImpacts
.Controls how much information is stored in the postings lists.This class abstracts addressing of document vector values indexed asKnnFloatVectorField
orKnnByteVectorField
.A DocIdSetIterator that also provides an index() method tracking a distinct ordinal for a vector associated with each doc.A per-document numeric value.Access to indexed numeric values.We recurse thePointValues.PointTree
, using a provided instance of this to guide the recursion.Basic operations to read the KD-tree.Iterates through the postings.Embeds a [read-only] SegmentInfo and adds per-commit fields.Information about a segment such as its name, directory, and files related to the segment.Holder class for common parameters used during read.Holder class for common parameters used during write.A per-document byte[] with presorted values.A list of per-document numeric values, sorted according toLong.compare(long, long)
.A multi-valued version ofSortedDocValues
.API for reading stored fields.Expert: provides a low-level means of accessing the stored field values in an index.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef)
,TermsEnum.seekExact(BytesRef)
) or step through (BytesRefIterator.next()
terms to obtain frequency information (TermsEnum.docFreq()
),PostingsEnum
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.API for reading term vectors.The numeric datatype of the vector values.Vector similarity function; used in search to return top K most similar vectors to a target vector. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.uniformsplitClassDescriptionA base TermsEnum that adds default implementations for
BaseTermsEnum.attributes()
BaseTermsEnum.termState()
BaseTermsEnum.seekExact(BytesRef)
BaseTermsEnum.seekExact(BytesRef, TermState)
In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.This exception is thrown when Lucene detects an inconsistency in the index.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).Provides aTerms
index for fields that have it, and lists which fields do.Extension ofPostingsEnum
which also provides information about upcoming impacts.Iterates through the postings.Holder class for common parameters used during read.Holder class for common parameters used during write.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef)
,TermsEnum.seekExact(BytesRef)
) or step through (BytesRefIterator.next()
terms to obtain frequency information (TermsEnum.docFreq()
),PostingsEnum
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking. -
Classes in org.apache.lucene.index used by org.apache.lucene.collation
-
Classes in org.apache.lucene.index used by org.apache.lucene.documentClassDescriptionA per-document numeric value.Options for skip indexes on doc values.Skipper for
DocValues
.DocValues types.Access to the Field Info file that describes document fields and whether or not they are indexed.Represents a single field for indexing.Describes the properties of a field.Controls how much information is stored in the postings lists.LeafReader
is an abstract class, providing an interface for accessing an index.IndexReaderContext
forLeafReader
instances.A per-document numeric value.Access to indexed numeric values.We recurse thePointValues.PointTree
, using a provided instance of this to guide the recursion.Basic operations to read the KD-tree.Used byPointValues.intersect(org.apache.lucene.index.PointValues.IntersectVisitor)
to check how each recursive cell corresponds to the query.Iterates through the postings.A per-document byte[] with presorted values.A list of per-document numeric values, sorted according toLong.compare(long, long)
.Expert: provides a low-level means of accessing the stored field values in an index.Enumeration of possible return values forStoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo)
.The numeric datatype of the vector values.Vector similarity function; used in search to return top K most similar vectors to a target vector. -
Classes in org.apache.lucene.index used by org.apache.lucene.expressions
-
Classes in org.apache.lucene.index used by org.apache.lucene.facetClassDescriptionRepresents a single field for indexing.IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
IndexReaderContext
forLeafReader
instances.Maps per-segment ordinals to/from global ordinal space, using a compact packed-ints representation.A multi-valued version ofSortedDocValues
.A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.facet.facetset
-
Classes in org.apache.lucene.index used by org.apache.lucene.facet.sortedsetClassDescriptionRepresents a single field for indexing.IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
LeafReader
is an abstract class, providing an interface for accessing an index.Maps per-segment ordinals to/from global ordinal space, using a compact packed-ints representation.A multi-valued version ofSortedDocValues
. -
Classes in org.apache.lucene.index used by org.apache.lucene.facet.taxonomyClassDescriptionA
FilterLeafReader
contains another LeafReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.Delegates all methods to a wrappedSortedNumericDocValues
.Represents a single field for indexing.IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.A utility class that gives hooks in order to help build a cache based on the data that is contained in this index.AnIndexWriter
creates and maintains an index.LeafReader
is an abstract class, providing an interface for accessing an index.IndexReaderContext
forLeafReader
instances.A list of per-document numeric values, sorted according toLong.compare(long, long)
.An interface for implementations that support 2-phase commit. -
Classes in org.apache.lucene.index used by org.apache.lucene.facet.taxonomy.directoryClassDescriptionDirectoryReader is an implementation of
CompositeReader
that can read indexes in aDirectory
.IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.AnIndexWriter
creates and maintains an index.Holds all the configuration that is used to create anIndexWriter
.Specifies the open mode forIndexWriter
.Utility class to safely shareDirectoryReader
instances across multiple threads, while periodically reopening.An interface for implementations that support 2-phase commit. -
Classes in org.apache.lucene.index used by org.apache.lucene.geoClassDescriptionUsed by
PointValues.intersect(org.apache.lucene.index.PointValues.IntersectVisitor)
to check how each recursive cell corresponds to the query. -
Classes in org.apache.lucene.index used by org.apache.lucene.indexClassDescriptionAn approximate priority queue, which attempts to poll items by decreasing log of the weight, though exact ordering is not guaranteed.Base class for implementing
CompositeReader
s based on an array of sub-readers.A base TermsEnum that adds default implementations forBaseTermsEnum.attributes()
BaseTermsEnum.termState()
BaseTermsEnum.seekExact(BytesRef)
BaseTermsEnum.seekExact(BytesRef, TermState)
In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.A per-document numeric value.Holds buffered deletes and updates, by docID, term or query for a single segment.Tracks the stream ofFrozenBufferedUpdates
.Tracks the contiguous range of packets that have finished resolving.Holds all per-segment internal state used while resolving deletions.Class that Posting and PostingVector use to write interleaved byte streams into shared fixed-size byte[] arrays.IndexInput that knows how to read the byte slices written by Posting and PostingVector.This class provides access to per-document floating point vector values indexed asKnnByteVectorField
.Run-time configuration options for CheckIndex commands.Returned fromCheckIndex.checkIndex()
detailing the health and status of the index.Status from testing DocValuesStatus from testing field infos.Status from testing field norms.Status from testing index sortStatus from testing livedocsStatus from testing PointValuesHolds the status of each segment in the index.Status from testing soft deletesStatus from testing stored fields.Status from testing term index.Status from testing stored fields.Status from testing vector valuesLeafReader implemented by codec APIs.Instances of this reader type can only be used to get stored fields from the underlying LeafReaders, but it is not possible to directly retrieve postings.IndexReaderContext
forCompositeReader
instance.Concurrent version ofApproximatePriorityQueue
, which trades a bit more of ordering for better concurrency by maintaining multiple subApproximatePriorityQueue
s that are locked independently.This executor provides intra-merge threads for parallel execution of merge tasks.Runs a merge thread to execute a single merge, then exits.DirectoryReader is an implementation ofCompositeReader
that can read indexes in aDirectory
.Utility class to help merging documents from sub-readers according to either simple concatenated (unsorted) order, or by a specified index-time sort, skipping deleted documents and remapping non-deleted documents.Represents one sub-reader being mergedAccumulator for documents that have a value for a field.This class accepts multiple added documents and directly writes segment files.DocumentsWriterDeleteQueue
is a non-blocking linked pending deletes queue.This class controlsDocumentsWriterPerThread
flushing during indexing.DocumentsWriterPerThreadPool
controlsDocumentsWriterPerThread
instances and their thread assignments during indexing.Controls the health status of aDocumentsWriter
sessions.Holds updates of a single DocValues field, for a set of documents within one segment.An iterator over documents and their updated values.Options for skip indexes on doc values.Skipper forDocValues
.DocValues types.An in-place update to a DocValues field.An in-place update to a binary DocValues fieldAn in-place update to a numeric DocValues fieldAccess to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).This class tracks the number and position / offset parameters of terms being added to the index.Provides aTerms
index for fields that have it, and lists which fields do.Iterates over terms in across multiple fields.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.Struct like class that is used to iterate over all updates in this bufferAn iterator that iterates over all updates in insertion orderAFilterCodecReader
contains another CodecReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.A FilterDirectoryReader wraps another DirectoryReader, allowing implementations to transform or extend it.Factory class passed to FilterDirectoryReader constructor that allows subclasses to wrap the filtered DirectoryReader's subreaders.Abstract class for enumerating a subset of all terms.Return value, if term should be accepted or the iteration shouldEND
.AFilterLeafReader
contains another LeafReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.Base class for filteringFields
implementations.Base class for filteringTerms
implementations.Base class for filteringTermsEnum
implementations.A wrapper forMergePolicy
instances.This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.FlushPolicy
controls when segments are flushed from a RAM resident internal data-structure to theIndexWriter
sDirectory
.ATimSorter
which sorts two parallel arrays of doc IDs and offsets in one go.Holds buffered deletes and updates by term or query, once pushed.Per-document scoring factors.Information about upcoming impacts, ie.Extension ofPostingsEnum
which also provides information about upcoming impacts.Source ofImpacts
.Represents a single field for indexing.Describes the properties of a field.Expert: represents a single commit into an index as seen by theIndexDeletionPolicy
orIndexReader
.Expert: policy for deletion of staleindex commits
.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.Holds details for each commit point.Default general purpose indexing chain, which handles indexing all types of fields.A schema of the field in the current document.NOTE: not static: accesses at least docState, termsHash.Controls how much information is stored in the postings lists.IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.A utility class that gives hooks in order to help build a cache based on the data that is contained in this index.A cache key identifying a resource that is being cached on.A listener that is called when a resource gets closed.A struct like class that represents a hierarchical relationship betweenIndexReader
instances.Handles how documents should be sorted in an index, both within a segment and between segments.Used for sorting documents across segmentsA comparator of doc IDs, used for sorting documents within a segmentProvide a NumericDocValues instance for a LeafReaderProvide a SortedDocValues instance for a LeafReaderThis is an easy-to-use tool that upgrades all segments of an index from previous Lucene versions to the current segment file format.AnIndexWriter
creates and maintains an index.DocStats for this indexInterface for internal atomic events.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.Holds all the configuration that is used to create anIndexWriter
.Specifies the open mode forIndexWriter
.A callback event listener for recording key events happened inside IndexWriterThis class abstracts addressing of document vector values indexed asKnnFloatVectorField
orKnnByteVectorField
.A DocIdSetIterator that also provides an index() method tracking a distinct ordinal for a vector associated with each doc.Provides read-only metadata about a leaf.LeafReader
is an abstract class, providing an interface for accessing an index.IndexReaderContext
forLeafReader
instances.Holds all the configuration used byIndexWriter
with few setters for settings that can be changed on anIndexWriter
instance "live".AConcurrentApproximatePriorityQueue
ofLock
objects.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.Exposes flex API, merged from flex API of sub-segments, remapping docIDs (this is used for segment merging).Expert: a MergePolicy determines the sequence of primitive merge operations.Thrown when a merge was explicitly aborted becauseIndexWriter.abortMerges()
was called.This interface represents the current context of the merge selection process.A MergeSpecification instance provides the information necessary to perform multiple merges.OneMerge provides the information necessary to perform an individual primitive merge operation, resulting in a single new segment.Progress and state for an executing merge.Reason for pausing the merge thread.This is theRateLimiter
thatIndexWriter
assigns to each running merge, to giveMergeScheduler
s ionice like control.Expert:IndexWriter
uses an instance implementing this interface to execute the merges selected by aMergePolicy
.Provides access to new merges and executes the actual mergeHolds common state used during segment merging.A map of doc IDs.MergeTrigger is passed toMergePolicy.findMerges(MergeTrigger, SegmentInfos, MergePolicy.MergeContext)
to indicate the event that triggered the merge.Provides a singleFields
term index view over anIndexReader
.ExposesPostingsEnum
, merged fromPostingsEnum
API of sub-segments.Holds aPostingsEnum
along with the correspondingReaderSlice
.Exposes flex API, merged from flex API of sub-segments.Buffers up pending long per doc, then flushes when segment flushes.A per-document numeric value.A wrapping merge policy that wraps theMergePolicy.OneMerge
objects returned by the wrapped merge policy.Maps per-segment ordinals to/from global ordinal space, using a compact packed-ints representation.This class handles accounting and applying pending deletes for live segment readersAccess to indexed numeric values.We recurse thePointValues.PointTree
, using a provided instance of this to guide the recursion.Basic operations to read the KD-tree.Used byPointValues.intersect(org.apache.lucene.index.PointValues.IntersectVisitor)
to check how each recursive cell corresponds to the query.Buffers up pending byte[][] value(s) per doc, then flushes when segment flushes.Iterates through the postings.Prefix codes term instances (prefixes are shared).An iterator over the list of terms stored in aPrefixCodedTerms
.Query timeout abstraction that controls whether a query should continue or be stopped.Holds shared SegmentReader instances.Subreader slice from a parent composite reader.Embeds a [read-only] SegmentInfo and adds per-commit fields.Holds core readers that are shared (unchanged) when SegmentReader is cloned or reopenedManages theDocValuesProducer
held bySegmentReader
and keeps track of their reference counting.Information about a segment such as its name, directory, and files related to the segment.A collection of segmentInfo objects with methods for operating on those segments in relation to the file system.The SegmentMerger class combines two or more Segments, represented by an IndexReader, into a single Segment.IndexReader implementation over a single segment.Holder class for common parameters used during read.Holder class for common parameters used during write.AnIndexDeletionPolicy
that wraps any otherIndexDeletionPolicy
and adds the ability to hold and later release snapshots of an index.A per-document byte[] with presorted values.A list of per-document numeric values, sorted according toLong.compare(long, long)
.A multi-valued version ofSortedDocValues
.A permutation of doc IDs.Reads/Writes a named SortField from a segment info file, used to record index sortsFactory for SortingValuesIterator.Iterator over KnnVectorValues accepting a mapping to differently-sorted docs.Default implementation ofDirectoryReader
.API for reading stored fields.Expert: provides a low-level means of accessing the stored field values in an index.Enumeration of possible return values forStoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo)
.A Term represents a word from text.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef)
,TermsEnum.seekExact(BytesRef)
) or step through (BytesRefIterator.next()
terms to obtain frequency information (TermsEnum.docFreq()
),PostingsEnum
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.Wrapper around aTermsEnum
and an integer that identifies it.Wrapper around a term that allows for quick equals comparisons.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.This class stores streams of information per term without knowing the size of the stream ahead of time.Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking.API for reading term vectors.Merges segments of approximately equal size, subject to an allowed number of segments per tier.Holds score and explanation for a single candidate merge.An interface for implementations that support 2-phase commit.Thrown byTwoPhaseCommitTool.execute(TwoPhaseCommit...)
when an object fails to commit().Thrown byTwoPhaseCommitTool.execute(TwoPhaseCommit...)
when an object fails to prepareCommit().The numeric datatype of the vector values.Vector similarity function; used in search to return top K most similar vectors to a target vector.Streams vector values for indexing to the given codec's vectors writer. -
Classes in org.apache.lucene.index used by org.apache.lucene.index.memoryClassDescriptionA base TermsEnum that adds default implementations for
BaseTermsEnum.attributes()
BaseTermsEnum.termState()
BaseTermsEnum.seekExact(BytesRef)
BaseTermsEnum.seekExact(BytesRef, TermState)
In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.A per-document numeric value.This class provides access to per-document floating point vector values indexed asKnnByteVectorField
.Skipper forDocValues
.DocValues types.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).Provides aTerms
index for fields that have it, and lists which fields do.This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.Extension ofPostingsEnum
which also provides information about upcoming impacts.Represents a single field for indexing.Describes the properties of a field.IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.A utility class that gives hooks in order to help build a cache based on the data that is contained in this index.This class abstracts addressing of document vector values indexed asKnnFloatVectorField
orKnnByteVectorField
.A DocIdSetIterator that also provides an index() method tracking a distinct ordinal for a vector associated with each doc.Provides read-only metadata about a leaf.LeafReader
is an abstract class, providing an interface for accessing an index.A per-document numeric value.Access to indexed numeric values.Basic operations to read the KD-tree.Iterates through the postings.A per-document byte[] with presorted values.A list of per-document numeric values, sorted according toLong.compare(long, long)
.A multi-valued version ofSortedDocValues
.API for reading stored fields.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef)
,TermsEnum.seekExact(BytesRef)
) or step through (BytesRefIterator.next()
terms to obtain frequency information (TermsEnum.docFreq()
),PostingsEnum
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking.API for reading term vectors. -
Classes in org.apache.lucene.index used by org.apache.lucene.internal.testsClassDescriptionA
MergeScheduler
that runs each merge using a separate thread.DirectoryReader is an implementation ofCompositeReader
that can read indexes in aDirectory
.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).Information about upcoming impacts, ie.A cache key identifying a resource that is being cached on.AnIndexWriter
creates and maintains an index.Embeds a [read-only] SegmentInfo and adds per-commit fields.IndexReader implementation over a single segment. -
Classes in org.apache.lucene.index used by org.apache.lucene.miscClassDescriptionIndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.Holds all the configuration that is used to create an
IndexWriter
.A Term represents a word from text.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.documentClassDescriptionAccess to the Field Info file that describes document fields and whether or not they are indexed.Represents a single field for indexing.Describes the properties of a field.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.indexClassDescriptionBase class for implementing
CompositeReader
s based on an array of sub-readers.LeafReader implemented by codec APIs.Instances of this reader type can only be used to get stored fields from the underlying LeafReaders, but it is not possible to directly retrieve postings.DirectoryReader is an implementation ofCompositeReader
that can read indexes in aDirectory
.AFilterCodecReader
contains another CodecReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.A wrapper forMergePolicy
instances.IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.A utility class that gives hooks in order to help build a cache based on the data that is contained in this index.AnIndexWriter
creates and maintains an index.Holds all the configuration that is used to create anIndexWriter
.LeafReader
is an abstract class, providing an interface for accessing an index.IndexReaderContext
forLeafReader
instances.Expert: a MergePolicy determines the sequence of primitive merge operations.This interface represents the current context of the merge selection process.A MergeSpecification instance provides the information necessary to perform multiple merges.MergeTrigger is passed toMergePolicy.findMerges(MergeTrigger, SegmentInfos, MergePolicy.MergeContext)
to indicate the event that triggered the merge.Embeds a [read-only] SegmentInfo and adds per-commit fields.A collection of segmentInfo objects with methods for operating on those segments in relation to the file system.A permutation of doc IDs.A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.misc.searchClassDescription
IndexReaderContext
forLeafReader
instances.A per-document numeric value.A per-document byte[] with presorted values.A list of per-document numeric values, sorted according toLong.compare(long, long)
.A multi-valued version ofSortedDocValues
. -
Classes in org.apache.lucene.index used by org.apache.lucene.monitorClassDescriptionA per-document numeric value.IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.A cache key identifying a resource that is being cached on.An
IndexWriter
creates and maintains an index.Holds all the configuration that is used to create anIndexWriter
.LeafReader
is an abstract class, providing an interface for accessing an index.IndexReaderContext
forLeafReader
instances.A per-document byte[] with presorted values.A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.payloadsClassDescriptionA struct like class that represents a hierarchical relationship between
IndexReader
instances.Iterates through the postings.A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.queriesClassDescriptionIndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
IndexReaderContext
forLeafReader
instances.A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.queries.functionClassDescriptionIndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
IndexReaderContext
forLeafReader
instances.A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.queries.function.docvaluesClassDescription
IndexReaderContext
forLeafReader
instances.A per-document byte[] with presorted values. -
Classes in org.apache.lucene.index used by org.apache.lucene.queries.function.valuesourceClassDescription
LeafReader
is an abstract class, providing an interface for accessing an index.IndexReaderContext
forLeafReader
instances.A per-document numeric value.The numeric datatype of the vector values.Vector similarity function; used in search to return top K most similar vectors to a target vector. -
Classes in org.apache.lucene.index used by org.apache.lucene.queries.intervalsClassDescription
IndexReaderContext
forLeafReader
instances.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.mltClassDescriptionIndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.Access to the terms in a specific field.
-
Classes in org.apache.lucene.index used by org.apache.lucene.queries.payloadsClassDescription
IndexReaderContext
forLeafReader
instances.A per-document numeric value.Iterates through the postings.A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.queries.spansClassDescription
IndexReaderContext
forLeafReader
instances.A per-document numeric value.Iterates through the postings.A Term represents a word from text.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.queryparser.classic
-
Classes in org.apache.lucene.index used by org.apache.lucene.queryparser.complexPhrase
-
Classes in org.apache.lucene.index used by org.apache.lucene.queryparser.surround.queryClassDescriptionIndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.A Term represents a word from text.
-
Classes in org.apache.lucene.index used by org.apache.lucene.sandbox.codecs.idversionClassDescriptionA base TermsEnum that adds default implementations for
BaseTermsEnum.attributes()
BaseTermsEnum.termState()
BaseTermsEnum.seekExact(BytesRef)
BaseTermsEnum.seekExact(BytesRef, TermState)
In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection ofFieldInfo
s (accessible by number or by name).Provides aTerms
index for fields that have it, and lists which fields do.Extension ofPostingsEnum
which also provides information about upcoming impacts.A per-document numeric value.An ordinal basedTermState
Iterates through the postings.Holder class for common parameters used during read.Holder class for common parameters used during write.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef)
,TermsEnum.seekExact(BytesRef)
) or step through (BytesRefIterator.next()
terms to obtain frequency information (TermsEnum.docFreq()
),PostingsEnum
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking. -
Classes in org.apache.lucene.index used by org.apache.lucene.sandbox.codecs.quantizationClassDescriptionThis class provides access to per-document floating point vector values indexed as
KnnFloatVectorField
.This class abstracts addressing of document vector values indexed asKnnFloatVectorField
orKnnByteVectorField
.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.sandbox.documentClassDescriptionRepresents a single field for indexing.Access to indexed numeric values.We recurse the
PointValues.PointTree
, using a provided instance of this to guide the recursion.Basic operations to read the KD-tree.Used byPointValues.intersect(org.apache.lucene.index.PointValues.IntersectVisitor)
to check how each recursive cell corresponds to the query. -
Classes in org.apache.lucene.index used by org.apache.lucene.sandbox.facet
-
Classes in org.apache.lucene.index used by org.apache.lucene.sandbox.facet.cuttersClassDescription
IndexReaderContext
forLeafReader
instances.A list of per-document numeric values, sorted according toLong.compare(long, long)
. -
Classes in org.apache.lucene.index used by org.apache.lucene.sandbox.facet.cutters.ranges
-
Classes in org.apache.lucene.index used by org.apache.lucene.sandbox.facet.recorders
-
Classes in org.apache.lucene.index used by org.apache.lucene.sandbox.indexClassDescriptionA wrapper for
MergePolicy
instances.Expert: a MergePolicy determines the sequence of primitive merge operations.This interface represents the current context of the merge selection process.A MergeSpecification instance provides the information necessary to perform multiple merges.MergeTrigger is passed toMergePolicy.findMerges(MergeTrigger, SegmentInfos, MergePolicy.MergeContext)
to indicate the event that triggered the merge.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.queriesClassDescriptionIndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.A Term represents a word from text.
-
Classes in org.apache.lucene.index used by org.apache.lucene.sandbox.searchClassDescriptionIndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
LeafReader
is an abstract class, providing an interface for accessing an index.IndexReaderContext
forLeafReader
instances.A per-document numeric value.Used byPointValues.intersect(org.apache.lucene.index.PointValues.IntersectVisitor)
to check how each recursive cell corresponds to the query.Iterates through the postings.A Term represents a word from text.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef)
,TermsEnum.seekExact(BytesRef)
) or step through (BytesRefIterator.next()
terms to obtain frequency information (TermsEnum.docFreq()
),PostingsEnum
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking. -
Classes in org.apache.lucene.index used by org.apache.lucene.searchClassDescriptionA base TermsEnum that adds default implementations for
BaseTermsEnum.attributes()
BaseTermsEnum.termState()
BaseTermsEnum.seekExact(BytesRef)
BaseTermsEnum.seekExact(BytesRef, TermState)
In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.A per-document numeric value.DirectoryReader is an implementation ofCompositeReader
that can read indexes in aDirectory
.Skipper forDocValues
.Access to the Field Info file that describes document fields and whether or not they are indexed.Abstract class for enumerating a subset of all terms.Return value, if term should be accepted or the iteration shouldEND
.Per-document scoring factors.Information about upcoming impacts, ie.Extension ofPostingsEnum
which also provides information about upcoming impacts.Source ofImpacts
.IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.A utility class that gives hooks in order to help build a cache based on the data that is contained in this index.A cache key identifying a resource that is being cached on.A struct like class that represents a hierarchical relationship betweenIndexReader
instances.Handles how documents should be sorted in an index, both within a segment and between segments.AnIndexWriter
creates and maintains an index.LeafReader
is an abstract class, providing an interface for accessing an index.IndexReaderContext
forLeafReader
instances.A per-document numeric value.Access to indexed numeric values.We recurse thePointValues.PointTree
, using a provided instance of this to guide the recursion.Basic operations to read the KD-tree.Used byPointValues.intersect(org.apache.lucene.index.PointValues.IntersectVisitor)
to check how each recursive cell corresponds to the query.Iterates through the postings.Prefix codes term instances (prefixes are shared).An iterator over the list of terms stored in aPrefixCodedTerms
.Query timeout abstraction that controls whether a query should continue or be stopped.A per-document byte[] with presorted values.A list of per-document numeric values, sorted according toLong.compare(long, long)
.A multi-valued version ofSortedDocValues
.Reads/Writes a named SortField from a segment info file, used to record index sortsAPI for reading stored fields.A Term represents a word from text.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef)
,TermsEnum.seekExact(BytesRef)
) or step through (BytesRefIterator.next()
terms to obtain frequency information (TermsEnum.docFreq()
),PostingsEnum
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.Encapsulates all required internal state to position the associatedTermsEnum
without re-seeking. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.comparatorsClassDescription
IndexReaderContext
forLeafReader
instances.A per-document numeric value.Access to indexed numeric values.Basic operations to read the KD-tree.Iterates through the postings.A per-document byte[] with presorted values.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.groupingClassDescription
IndexReaderContext
forLeafReader
instances.A per-document byte[] with presorted values.A multi-valued version ofSortedDocValues
.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.highlightClassDescriptionA per-document numeric value.This class provides access to per-document floating point vector values indexed as
KnnByteVectorField
.Skipper forDocValues
.Collection ofFieldInfo
s (accessible by number or by name).Provides aTerms
index for fields that have it, and lists which fields do.AFilterLeafReader
contains another LeafReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.A utility class that gives hooks in order to help build a cache based on the data that is contained in this index.Provides read-only metadata about a leaf.LeafReader
is an abstract class, providing an interface for accessing an index.IndexReaderContext
forLeafReader
instances.A per-document numeric value.Access to indexed numeric values.A per-document byte[] with presorted values.A list of per-document numeric values, sorted according toLong.compare(long, long)
.A multi-valued version ofSortedDocValues
.API for reading stored fields.A Term represents a word from text.Access to the terms in a specific field.API for reading term vectors. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.joinClassDescriptionAbstract class for enumerating a subset of all terms.Return value, if term should be accepted or the iteration should
END
.IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.A cache key identifying a resource that is being cached on.LeafReader
is an abstract class, providing an interface for accessing an index.IndexReaderContext
forLeafReader
instances.A per-document numeric value.Maps per-segment ordinals to/from global ordinal space, using a compact packed-ints representation.We recurse thePointValues.PointTree
, using a provided instance of this to guide the recursion.Used byPointValues.intersect(org.apache.lucene.index.PointValues.IntersectVisitor)
to check how each recursive cell corresponds to the query.Prefix codes term instances (prefixes are shared).An iterator over the list of terms stored in aPrefixCodedTerms
.Query timeout abstraction that controls whether a query should continue or be stopped.A per-document byte[] with presorted values.A list of per-document numeric values, sorted according toLong.compare(long, long)
.A multi-valued version ofSortedDocValues
.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef)
,TermsEnum.seekExact(BytesRef)
) or step through (BytesRefIterator.next()
terms to obtain frequency information (TermsEnum.docFreq()
),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
-
Classes in org.apache.lucene.index used by org.apache.lucene.search.matchhighlightClassDescriptionAccess to the Field Info file that describes document fields and whether or not they are indexed.IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
LeafReader
is an abstract class, providing an interface for accessing an index.IndexReaderContext
forLeafReader
instances.Expert: provides a low-level means of accessing the stored field values in an index.Enumeration of possible return values forStoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo)
. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.similaritiesClassDescriptionThis class tracks the number and position / offset parameters of terms being added to the index.
-
Classes in org.apache.lucene.index used by org.apache.lucene.search.spellClassDescriptionIndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.Holds all the configuration that is used to create an
IndexWriter
.A Term represents a word from text.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.suggestClassDescriptionRepresents a single field for indexing.IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
IndexReaderContext
forLeafReader
instances.A per-document numeric value.API for reading stored fields. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.suggest.analyzingClassDescriptionAn
IndexWriter
creates and maintains an index.Holds all the configuration that is used to create anIndexWriter
.Specifies the open mode forIndexWriter
.API for reading term vectors. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.suggest.documentClassDescriptionProvides a
Terms
index for fields that have it, and lists which fields do.Base class for filteringTerms
implementations.Represents a single field for indexing.IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.LeafReader
is an abstract class, providing an interface for accessing an index.IndexReaderContext
forLeafReader
instances.Iterates through the postings.Holder class for common parameters used during read.Holder class for common parameters used during write.A Term represents a word from text.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef)
,TermsEnum.seekExact(BytesRef)
) or step through (BytesRefIterator.next()
terms to obtain frequency information (TermsEnum.docFreq()
),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.uhighlightClassDescriptionAccess to the Field Info file that describes document fields and whether or not they are indexed.Collection of
FieldInfo
s (accessible by number or by name).Provides aTerms
index for fields that have it, and lists which fields do.AFilterLeafReader
contains another LeafReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.Base class for filteringTerms
implementations.Base class for filteringTermsEnum
implementations.IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.A utility class that gives hooks in order to help build a cache based on the data that is contained in this index.LeafReader
is an abstract class, providing an interface for accessing an index.A per-document numeric value.Iterates through the postings.Expert: provides a low-level means of accessing the stored field values in an index.Enumeration of possible return values forStoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo)
.A Term represents a word from text.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef)
,TermsEnum.seekExact(BytesRef)
) or step through (BytesRefIterator.next()
terms to obtain frequency information (TermsEnum.docFreq()
),PostingsEnum
orPostingsEnum
for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum)
.API for reading term vectors. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.vectorhighlightClassDescriptionIndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.A Term represents a word from text.
-
Classes in org.apache.lucene.index used by org.apache.lucene.spatial3dClassDescriptionAccess to the Field Info file that describes document fields and whether or not they are indexed.Represents a single field for indexing.
IndexReaderContext
forLeafReader
instances.We recurse thePointValues.PointTree
, using a provided instance of this to guide the recursion.Used byPointValues.intersect(org.apache.lucene.index.PointValues.IntersectVisitor)
to check how each recursive cell corresponds to the query.A list of per-document numeric values, sorted according toLong.compare(long, long)
. -
Classes in org.apache.lucene.index used by org.apache.lucene.utilClassDescriptionAccess to indexed numeric values.A Term represents a word from text.Access to the terms in a specific field.
-
Classes in org.apache.lucene.index used by org.apache.lucene.util.automatonClassDescriptionAccess to the terms in a specific field.Iterator to seek (
TermsEnum.seekCeil(BytesRef)
,TermsEnum.seekExact(BytesRef)
) or step through (BytesRefIterator.next()
terms to obtain frequency information (TermsEnum.docFreq()
),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.bkdClassDescriptionA map of doc IDs.Access to indexed numeric values.We recurse the
PointValues.PointTree
, using a provided instance of this to guide the recursion.Basic operations to read the KD-tree.Used byPointValues.intersect(org.apache.lucene.index.PointValues.IntersectVisitor)
to check how each recursive cell corresponds to the query. -
Classes in org.apache.lucene.index used by org.apache.lucene.util.graph
-
Classes in org.apache.lucene.index used by org.apache.lucene.util.hnswClassDescriptionAccess to the Field Info file that describes document fields and whether or not they are indexed.IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.This class abstracts addressing of document vector values indexed as
KnnFloatVectorField
orKnnByteVectorField
.A map of doc IDs. -
Classes in org.apache.lucene.index used by org.apache.lucene.util.quantizationClassDescriptionThis class provides access to per-document floating point vector values indexed as
KnnByteVectorField
.This class provides access to per-document floating point vector values indexed asKnnFloatVectorField
.This class abstracts addressing of document vector values indexed asKnnFloatVectorField
orKnnByteVectorField
.Vector similarity function; used in search to return top K most similar vectors to a target vector.