Package | Description |
---|---|
org.apache.lucene.analysis.query |
Automatically filter high-frequency stopwords.
|
org.apache.lucene.benchmark.byTask |
Benchmarking Lucene By Tasks
|
org.apache.lucene.benchmark.byTask.tasks |
Extendable benchmark tasks.
|
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.asserting |
Codec for testing that asserts various contracts of the codec apis.
|
org.apache.lucene.codecs.blockterms |
Pluggable term index / block terms dictionary implementations.
|
org.apache.lucene.codecs.blocktree |
BlockTree terms dictionary.
|
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 |
StoredFieldsFormat that allows cross-document and cross-field compression of stored fields.
|
org.apache.lucene.codecs.idversion |
A primary-key postings format that associates a version (long) with each term and
can provide fail-fast lookups by ID and version.
|
org.apache.lucene.codecs.lucene50 |
Components from the Lucene 5.0 index format
See
org.apache.lucene.codecs.lucene80 for an overview
of the index format. |
org.apache.lucene.codecs.lucene60 |
Components from the Lucene 6.0 index format.
|
org.apache.lucene.codecs.lucene70 |
Components from the Lucene 7.0 index format.
|
org.apache.lucene.codecs.lucene80 |
Lucene 8.0 file format.
|
org.apache.lucene.codecs.memory |
Term dictionary, DocValues or Postings formats that are read
entirely into memory.
|
org.apache.lucene.codecs.mockrandom |
Frankenstein codec for testing that pieces together random components.
|
org.apache.lucene.codecs.perfield |
Postings format that can delegate to different formats per-field.
|
org.apache.lucene.codecs.ramonly |
Codec for testing that never writes to disk.
|
org.apache.lucene.codecs.simpletext |
Simpletext Codec: writes human readable postings.
|
org.apache.lucene.collation |
Unicode collation support.
|
org.apache.lucene.document |
The logical representation of a
Document for indexing and searching. |
org.apache.lucene.facet |
Faceted search.
|
org.apache.lucene.facet.sortedset |
Provides faceting capabilities over facets that were indexed
with
SortedSetDocValuesFacetField . |
org.apache.lucene.facet.taxonomy |
Taxonomy of Categories.
|
org.apache.lucene.facet.taxonomy.directory |
Taxonomy index implementation using on top of a Directory.
|
org.apache.lucene.geo |
Geospatial Utility Implementations for Lucene Core
|
org.apache.lucene.index |
Code to maintain and access indices.
|
org.apache.lucene.index.memory |
High-performance single-document main memory Apache Lucene fulltext search index.
|
org.apache.lucene.misc |
Miscellaneous index tools.
|
org.apache.lucene.payloads |
Experimental classes for interacting with payloads
|
org.apache.lucene.queries |
Filters and Queries that add to core Lucene.
|
org.apache.lucene.queries.function |
Queries that compute score based upon a function.
|
org.apache.lucene.queries.function.docvalues |
FunctionValues for different data types.
|
org.apache.lucene.queries.function.valuesource |
A variety of functions to use with FunctionQuery.
|
org.apache.lucene.queries.mlt |
Document similarity query generators.
|
org.apache.lucene.queries.payloads |
The payloads package provides Query mechanisms for finding and using payloads.
|
org.apache.lucene.queryparser.classic |
A simple query parser implemented with JavaCC.
|
org.apache.lucene.queryparser.complexPhrase |
QueryParser which permits complex phrase query syntax eg "(john jon jonathan~) peters*"
|
org.apache.lucene.queryparser.surround.query |
This package contains SrndQuery and its subclasses.
|
org.apache.lucene.replicator |
Files replication framework
|
org.apache.lucene.replicator.nrt |
Near-real-time replication framework
|
org.apache.lucene.sandbox.queries |
Additional queries (some may have caveats or limitations)
|
org.apache.lucene.search |
Code to search indices.
|
org.apache.lucene.search.grouping |
Grouping.
|
org.apache.lucene.search.highlight |
Highlighting search terms.
|
org.apache.lucene.search.intervals |
Intervals queries
|
org.apache.lucene.search.join |
Support for index-time and query-time joins.
|
org.apache.lucene.search.similarities |
This package contains the various ranking models that can be used in Lucene.
|
org.apache.lucene.search.similarity |
Misc similarity implementations.
|
org.apache.lucene.search.spans |
The calculus of spans.
|
org.apache.lucene.search.spell |
Suggest alternate spellings for words.
|
org.apache.lucene.search.suggest |
Support for Autocomplete/Autosuggest
|
org.apache.lucene.search.suggest.analyzing |
Analyzer based autosuggest.
|
org.apache.lucene.search.suggest.document |
Support for document suggestion
|
org.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.spatial |
Lucene spatial search
|
org.apache.lucene.spatial.bbox |
Bounding Box Spatial Strategy
|
org.apache.lucene.spatial.composite |
Composite strategies.
|
org.apache.lucene.spatial.prefix |
Prefix Tree Strategy.
|
org.apache.lucene.spatial.util |
Various spatial utilities.
|
org.apache.lucene.spatial.vector |
Spatial strategy that uses two fields.
|
org.apache.lucene.spatial3d |
Lucene field & query support for the spatial geometry implemented in
org.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.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
Term
A Term represents a word from text.
|
Class and Description |
---|
DirectoryReader
DirectoryReader is an implementation of
CompositeReader
that can read indexes in a Directory . |
IndexWriter
An
IndexWriter creates and maintains an index. |
Class and Description |
---|
IndexCommit
Expert: represents a single commit into an index as seen by the
IndexDeletionPolicy or IndexReader . |
IndexDeletionPolicy
Expert: policy for deletion of stale
index commits . |
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
IndexWriter
An
IndexWriter creates and maintains an index. |
IndexWriterConfig
Holds all the configuration that is used to create an
IndexWriter . |
IndexWriterConfig.OpenMode
Specifies the open mode for
IndexWriter . |
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
Terms
Access to the terms in a specific field.
|
Class and Description |
---|
BinaryDocValues
A per-document numeric value.
|
FieldInfo
Access to the Field Info file that describes document fields and whether or
not they are indexed.
|
FieldInfos
Collection of
FieldInfo s (accessible by number or by name). |
Fields
Provides a
Terms index for fields that have it, and lists which fields do. |
Impact
Per-document scoring factors.
|
ImpactsEnum
Extension of
PostingsEnum which also provides information about
upcoming impacts. |
IndexableField
Represents a single field for indexing.
|
IndexableFieldType
Describes the properties of a field.
|
IndexOptions
Controls how much information is stored in the postings lists.
|
MergeState
Holds common state used during segment merging.
|
NumericDocValues
A per-document numeric value.
|
OrdTermState
An ordinal based
TermState |
PointValues
Access to indexed numeric values.
|
PostingsEnum
Iterates through the postings.
|
SegmentCommitInfo
Embeds a [read-only] SegmentInfo and adds per-commit
fields.
|
SegmentInfo
Information about a segment such as its name, directory, and files related
to the segment.
|
SegmentReadState
Holder class for common parameters used during read.
|
SegmentWriteState
Holder class for common parameters used during write.
|
SortedDocValues
A per-document byte[] with presorted values.
|
SortedNumericDocValues
A list of per-document numeric values, sorted
according to
Long.compare(long, long) . |
SortedSetDocValues
A multi-valued version of
SortedDocValues . |
StoredFieldVisitor
Expert: provides a low-level means of accessing the stored field
values in an index.
|
StoredFieldVisitor.Status
Enumeration of possible return values for
StoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo) . |
TermsEnum
Iterator to seek (
TermsEnum.seekCeil(BytesRef) , TermsEnum.seekExact(BytesRef) ) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq() ), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum) . |
TermState
Encapsulates all required internal state to position the associated
TermsEnum without re-seeking. |
Class and Description |
---|
FieldInfos
Collection of
FieldInfo s (accessible by number or by name). |
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.
|
Class and Description |
---|
FieldInfo
Access to the Field Info file that describes document fields and whether or
not they are indexed.
|
Fields
Provides a
Terms index for fields that have it, and lists which fields do. |
SegmentReadState
Holder class for common parameters used during read.
|
SegmentWriteState
Holder class for common parameters used during write.
|
Terms
Access to the terms in a specific field.
|
Class and Description |
---|
Fields
Provides a
Terms index for fields that have it, and lists which fields do. |
SegmentReadState
Holder class for common parameters used during read.
|
SegmentWriteState
Holder class for common parameters used during write.
|
Terms
Access to the terms in a specific field.
|
TermsEnum
Iterator to seek (
TermsEnum.seekCeil(BytesRef) , TermsEnum.seekExact(BytesRef) ) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq() ), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum) . |
Class and Description |
---|
BaseTermsEnum
A 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. |
Fields
Provides a
Terms index for fields that have it, and lists which fields do. |
ImpactsEnum
Extension of
PostingsEnum 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 or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum) . |
TermsEnum.SeekStatus
Represents returned result from
TermsEnum.seekCeil(org.apache.lucene.util.BytesRef) . |
TermState
Encapsulates all required internal state to position the associated
TermsEnum without re-seeking. |
Class and Description |
---|
FieldInfo
Access to the Field Info file that describes document fields and whether or
not they are indexed.
|
SegmentReadState
Holder class for common parameters used during read.
|
SegmentWriteState
Holder class for common parameters used during write.
|
Class and Description |
---|
FieldInfo
Access to the Field Info file that describes document fields and whether or
not they are indexed.
|
FieldInfos
Collection of
FieldInfo s (accessible by number or by name). |
Fields
Provides a
Terms index for fields that have it, and lists which fields do. |
IndexableField
Represents a single field for indexing.
|
MergeState
Holds common state used during segment merging.
|
SegmentInfo
Information about a segment such as its name, directory, and files related
to the segment.
|
StoredFieldVisitor
Expert: provides a low-level means of accessing the stored field
values in an index.
|
Class and Description |
---|
BaseTermsEnum
A 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. |
Fields
Provides a
Terms index for fields that have it, and lists which fields do. |
ImpactsEnum
Extension of
PostingsEnum 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 or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum) . |
TermsEnum.SeekStatus
Represents returned result from
TermsEnum.seekCeil(org.apache.lucene.util.BytesRef) . |
TermState
Encapsulates all required internal state to position the associated
TermsEnum without re-seeking. |
Class and Description |
---|
FieldInfo
Access to the Field Info file that describes document fields and whether or
not they are indexed.
|
FieldInfos
Collection of
FieldInfo s (accessible by number or by name). |
ImpactsEnum
Extension of
PostingsEnum which also provides information about
upcoming impacts. |
NumericDocValues
A per-document numeric value.
|
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.
|
Class and Description |
---|
FieldInfo
Access to the Field Info file that describes document fields and whether or
not they are indexed.
|
FieldInfos
Collection of
FieldInfo s (accessible by number or by name). |
MergeState
Holds common state used during segment merging.
|
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.
|
Class and Description |
---|
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.
|
Class and Description |
---|
SegmentReadState
Holder class for common parameters used during read.
|
SegmentWriteState
Holder class for common parameters used during write.
|
Class and Description |
---|
Fields
Provides a
Terms index for fields that have it, and lists which fields do. |
SegmentReadState
Holder class for common parameters used during read.
|
SegmentWriteState
Holder class for common parameters used during write.
|
Terms
Access to the terms in a specific field.
|
Class and Description |
---|
SegmentReadState
Holder class for common parameters used during read.
|
SegmentWriteState
Holder class for common parameters used during write.
|
Class and Description |
---|
SegmentReadState
Holder class for common parameters used during read.
|
SegmentWriteState
Holder class for common parameters used during write.
|
Class and Description |
---|
SegmentReadState
Holder class for common parameters used during read.
|
SegmentWriteState
Holder class for common parameters used during write.
|
Class and Description |
---|
DocValuesType
DocValues types.
|
FieldInfo
Access to the Field Info file that describes document fields and whether or
not they are indexed.
|
FieldInfos
Collection of
FieldInfo s (accessible by number or by name). |
Fields
Provides a
Terms index for fields that have it, and lists which fields do. |
IndexableField
Represents a single field for indexing.
|
NumericDocValues
A per-document numeric value.
|
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.
|
StoredFieldVisitor
Expert: provides a low-level means of accessing the stored field
values in an index.
|
Class and Description |
---|
IndexableField
Represents a single field for indexing.
|
Class and Description |
---|
DocValuesType
DocValues types.
|
FieldInfo
Access to the Field Info file that describes document fields and whether or
not they are indexed.
|
IndexableField
Represents a single field for indexing.
|
IndexableFieldType
Describes the properties of a field.
|
IndexOptions
Controls how much information is stored in the postings lists.
|
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
StoredFieldVisitor
Expert: provides a low-level means of accessing the stored field
values in an index.
|
StoredFieldVisitor.Status
Enumeration of possible return values for
StoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo) . |
Class and 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 for LeafReader instances. |
Term
A Term represents a word from text.
|
Class and 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.
|
SortedSetDocValues
A multi-valued version of
SortedDocValues . |
Class and Description |
---|
BinaryDocValues
A per-document numeric value.
|
FilterLeafReader
A
FilterLeafReader contains another LeafReader, which it
uses as its basic source of data, possibly transforming the data along the
way or providing additional functionality. |
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.
|
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
An
IndexWriter creates and maintains an index. |
LeafReader
LeafReader is an abstract class, providing an interface for accessing an
index. |
LeafReaderContext
IndexReaderContext for LeafReader instances. |
TwoPhaseCommit
An interface for implementations that support 2-phase commit.
|
Class and Description |
---|
DirectoryReader
DirectoryReader is an implementation of
CompositeReader
that can read indexes in a Directory . |
IndexWriter
An
IndexWriter creates and maintains an index. |
IndexWriterConfig
Holds all the configuration that is used to create an
IndexWriter . |
IndexWriterConfig.OpenMode
Specifies the open mode for
IndexWriter . |
TwoPhaseCommit
An interface for implementations that support 2-phase commit.
|
Class and Description |
---|
PointValues.Relation
Used by
PointValues.intersect(org.apache.lucene.index.PointValues.IntersectVisitor) to check how each recursive cell corresponds to the query. |
Class and Description |
---|
BaseCompositeReader
Base class for implementing
CompositeReader s based on an array
of sub-readers. |
BaseDocValuesFormatTestCase
Abstract class to do basic tests for a docvalues format.
|
BaseMergePolicyTestCase.IOStats
Statistics about bytes written to storage.
|
BaseTermsEnum
A 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. |
BaseTermVectorsFormatTestCase.Options
A combination of term vectors options.
|
BaseTermVectorsFormatTestCase.RandomDocument |
BaseTermVectorsFormatTestCase.RandomTokenStream
Produces a random TokenStream based off of provided terms.
|
BinaryDocValues
A per-document numeric value.
|
CheckIndex.Options
Run-time configuration options for CheckIndex commands.
|
CheckIndex.Status
Returned from
CheckIndex.checkIndex() detailing the health and status of the index. |
CheckIndex.Status.DocValuesStatus
Status from testing DocValues
|
CheckIndex.Status.FieldInfoStatus
Status from testing field infos.
|
CheckIndex.Status.FieldNormStatus
Status from testing field norms.
|
CheckIndex.Status.IndexSortStatus
Status from testing index sort
|
CheckIndex.Status.LiveDocStatus
Status from testing livedocs
|
CheckIndex.Status.PointsStatus
Status from testing PointValues
|
CheckIndex.Status.SegmentInfoStatus
Holds the status of each segment in the index.
|
CheckIndex.Status.StoredFieldStatus
Status from testing stored fields.
|
CheckIndex.Status.TermIndexStatus
Status from testing term index.
|
CheckIndex.Status.TermVectorStatus
Status from testing stored fields.
|
CodecReader
LeafReader implemented by codec APIs.
|
CompositeReader
Instances of this reader type can only
be used to get stored fields from the underlying LeafReaders,
but it is not possible to directly retrieve postings.
|
CompositeReaderContext
IndexReaderContext for CompositeReader instance. |
ConcurrentMergeScheduler
A
MergeScheduler that runs each merge using a
separate thread. |
ConcurrentMergeScheduler.MergeThread
Runs a merge thread to execute a single merge, then exits.
|
DirectoryReader
DirectoryReader is an implementation of
CompositeReader
that can read indexes in a Directory . |
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 merged
|
DocValuesType
DocValues types.
|
FieldInfo
Access to the Field Info file that describes document fields and whether or
not they are indexed.
|
FieldInfos
Collection of
FieldInfo s (accessible by number or by name). |
Fields
Provides a
Terms index for fields that have it, and lists which fields do. |
FilterCodecReader
A
FilterCodecReader contains another CodecReader, which it
uses as its basic source of data, possibly transforming the data along the
way or providing additional functionality. |
FilterDirectoryReader
A FilterDirectoryReader wraps another DirectoryReader, allowing implementations
to transform or extend it.
|
FilterDirectoryReader.SubReaderWrapper
Factory class passed to FilterDirectoryReader constructor that allows
subclasses to wrap the filtered DirectoryReader's subreaders.
|
FilteredTermsEnum
Abstract class for enumerating a subset of all terms.
|
FilteredTermsEnum.AcceptStatus
Return value, if term should be accepted or the iteration should
END . |
FilterLeafReader
A
FilterLeafReader contains another LeafReader, which it
uses as its basic source of data, possibly transforming the data along the
way or providing additional functionality. |
FilterLeafReader.FilterFields
Base class for filtering
Fields
implementations. |
FilterLeafReader.FilterPostingsEnum
Base class for filtering
PostingsEnum implementations. |
FilterLeafReader.FilterTerms
Base class for filtering
Terms implementations. |
FilterLeafReader.FilterTermsEnum
Base class for filtering
TermsEnum implementations. |
FilterMergePolicy
A wrapper for
MergePolicy instances. |
Impact
Per-document scoring factors.
|
Impacts
Information about upcoming impacts, ie.
|
ImpactsEnum
Extension of
PostingsEnum which also provides information about
upcoming impacts. |
ImpactsSource
Source of
Impacts . |
IndexableField
Represents a single field for indexing.
|
IndexableFieldType
Describes the properties of a field.
|
IndexCommit
Expert: represents a single commit into an index as seen by the
IndexDeletionPolicy or IndexReader . |
IndexDeletionPolicy
Expert: policy for deletion of stale
index commits . |
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 between
IndexReader instances. |
IndexWriter
An
IndexWriter creates and maintains an index. |
IndexWriter.DocStats
DocStats for this index
|
IndexWriter.IndexReaderWarmer
If
DirectoryReader.open(IndexWriter) has
been called (ie, this writer is in near real-time
mode), then after a merge completes, this class can be
invoked to warm the reader on the newly merged
segment, before the merge commits. |
IndexWriterConfig
Holds all the configuration that is used to create an
IndexWriter . |
IndexWriterConfig.OpenMode
Specifies the open mode for
IndexWriter . |
LeafMetaData
Provides read-only metadata about a leaf.
|
LeafReader
LeafReader is an abstract class, providing an interface for accessing an
index. |
LeafReaderContext
IndexReaderContext for LeafReader instances. |
LiveIndexWriterConfig
Holds all the configuration used by
IndexWriter with few setters for
settings that can be changed on an IndexWriter instance "live". |
LogMergePolicy
This class implements a
MergePolicy that tries
to merge segments into levels of exponentially
increasing size, where each level has fewer segments than
the value of the merge factor. |
MergePolicy
Expert: a MergePolicy determines the sequence of
primitive merge operations.
|
MergePolicy.MergeAbortedException
Thrown when a merge was explicitly aborted because
IndexWriter.abortMerges() was called. |
MergePolicy.MergeContext
This interface represents the current context of the merge selection process.
|
MergePolicy.MergeSpecification
A MergeSpecification instance provides the information
necessary to perform multiple merges.
|
MergePolicy.OneMerge
OneMerge provides the information necessary to perform
an individual primitive merge operation, resulting in
a single new segment.
|
MergePolicy.OneMergeProgress
Progress and state for an executing merge.
|
MergePolicy.OneMergeProgress.PauseReason
Reason for pausing the merge thread.
|
MergeScheduler
Expert:
IndexWriter uses an instance
implementing this interface to execute the merges
selected by a MergePolicy . |
MergeState
Holds common state used during segment merging.
|
MergeState.DocMap
A map of doc IDs.
|
MergeTrigger
MergeTrigger is passed to
MergePolicy.findMerges(MergeTrigger, SegmentInfos, MergePolicy.MergeContext) to indicate the
event that triggered the merge. |
MultiFields
Provides a single
Fields term index view over an
IndexReader . |
MultiPostingsEnum
Exposes
PostingsEnum , merged from PostingsEnum
API of sub-segments. |
MultiPostingsEnum.EnumWithSlice
Holds a
PostingsEnum along with the
corresponding ReaderSlice . |
MultiReader
A
CompositeReader which reads multiple indexes, appending
their content. |
MultiTermsEnum |
NumericDocValues
A per-document numeric value.
|
OneMergeWrappingMergePolicy
A wrapping merge policy that wraps the
MergePolicy.OneMerge
objects returned by the wrapped merge policy. |
OrdinalMap
Maps per-segment ordinals to/from global ordinal space, using a compact packed-ints representation.
|
PointsStackTracker.Cell |
PointValues
Access to indexed numeric values.
|
PointValues.IntersectVisitor
We recurse the BKD tree, using a provided instance of this to guide the recursion.
|
PointValues.Relation
Used by
PointValues.intersect(org.apache.lucene.index.PointValues.IntersectVisitor) to check how each recursive cell corresponds to the query. |
PostingsEnum
Iterates through the postings.
|
PrefixCodedTerms
Prefix codes term instances (prefixes are shared).
|
PrefixCodedTerms.TermIterator
An iterator over the list of terms stored in a
PrefixCodedTerms . |
QueryTimeout
Base for query timeout implementations, which will provide a
shouldExit() method,
used with ExitableDirectoryReader . |
RandomIndexWriter.TestPoint
Simple interface that is executed for each TP
InfoStream component
message. |
RandomPostingsTester.Option
Which features to test.
|
RandomPostingsTester.SeedPostings
Given the same random seed this always enumerates the
same random postings
|
ReaderSlice
Subreader slice from a parent composite reader.
|
SegmentCommitInfo
Embeds a [read-only] SegmentInfo and adds per-commit
fields.
|
SegmentInfo
Information about a segment such as its name, directory, and files related
to the segment.
|
SegmentInfos
A collection of segmentInfo objects with methods for operating on those
segments in relation to the file system.
|
SegmentReadState
Holder class for common parameters used during read.
|
SegmentWriteState
Holder class for common parameters used during write.
|
SnapshotDeletionPolicy
An
IndexDeletionPolicy that wraps any other
IndexDeletionPolicy and adds the ability to hold and later release
snapshots of an index. |
SortedDocValues
A per-document byte[] with presorted values.
|
SortedNumericDocValues
A list of per-document numeric values, sorted
according to
Long.compare(long, long) . |
SortedSetDocValues
A multi-valued version of
SortedDocValues . |
StoredFieldVisitor
Expert: provides a low-level means of accessing the stored field
values in an index.
|
StoredFieldVisitor.Status
Enumeration of possible return values for
StoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo) . |
Term
A Term represents a word from text.
|
Terms
Access to the terms in a specific field.
|
TermsEnum
Iterator to seek (
TermsEnum.seekCeil(BytesRef) , TermsEnum.seekExact(BytesRef) ) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq() ), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum) . |
TermsEnum.SeekStatus
Represents returned result from
TermsEnum.seekCeil(org.apache.lucene.util.BytesRef) . |
TermState
Encapsulates all required internal state to position the associated
TermsEnum without re-seeking. |
TermStates |
TieredMergePolicy
Merges segments of approximately equal size, subject to
an allowed number of segments per tier.
|
TieredMergePolicy.MergeScore
Holds score and explanation for a single candidate
merge.
|
TwoPhaseCommit
An interface for implementations that support 2-phase commit.
|
TwoPhaseCommitTool.CommitFailException
Thrown by
TwoPhaseCommitTool.execute(TwoPhaseCommit...) when an
object fails to commit(). |
TwoPhaseCommitTool.PrepareCommitFailException
Thrown by
TwoPhaseCommitTool.execute(TwoPhaseCommit...) when an
object fails to prepareCommit(). |
Class and Description |
---|
IndexableField
Represents a single field for indexing.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
Term
A Term represents a word from text.
|
Class and Description |
---|
IndexReaderContext
A struct like class that represents a hierarchical relationship between
IndexReader instances. |
PostingsEnum
Iterates through the postings.
|
Term
A Term represents a word from text.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
LeafReaderContext
IndexReaderContext for LeafReader instances. |
Term
A Term represents a word from text.
|
TermStates |
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
LeafReaderContext
IndexReaderContext for LeafReader instances. |
Term
A Term represents a word from text.
|
Class and Description |
---|
LeafReaderContext
IndexReaderContext for LeafReader instances. |
SortedDocValues
A per-document byte[] with presorted values.
|
Class and Description |
---|
LeafReaderContext
IndexReaderContext for LeafReader instances. |
NumericDocValues
A per-document numeric value.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
LeafReaderContext
IndexReaderContext for LeafReader instances. |
Term
A Term represents a word from text.
|
TermStates |
Class and Description |
---|
Term
A Term represents a word from text.
|
Class and Description |
---|
Term
A Term represents a word from text.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
Term
A Term represents a word from text.
|
Class and Description |
---|
IndexCommit
Expert: represents a single commit into an index as seen by the
IndexDeletionPolicy or IndexReader . |
IndexWriter
An
IndexWriter creates and maintains an index. |
IndexWriterConfig
Holds all the configuration that is used to create an
IndexWriter . |
IndexWriterConfig.OpenMode
Specifies the open mode for
IndexWriter . |
SnapshotDeletionPolicy
An
IndexDeletionPolicy that wraps any other
IndexDeletionPolicy and adds the ability to hold and later release
snapshots of an index. |
TwoPhaseCommit
An interface for implementations that support 2-phase commit.
|
Class and Description |
---|
IndexWriter
An
IndexWriter creates and maintains an index. |
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.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
Class and Description |
---|
BaseTermsEnum
A 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. |
BinaryDocValues
A per-document numeric value.
|
DirectoryReader
DirectoryReader is an implementation of
CompositeReader
that can read indexes in a Directory . |
ImpactsEnum
Extension of
PostingsEnum which also provides information about
upcoming impacts. |
ImpactsSource
Source of
Impacts . |
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
IndexReaderContext
A struct like class that represents a hierarchical relationship between
IndexReader instances. |
IndexWriter
An
IndexWriter creates and maintains an index. |
LeafReader
LeafReader is an abstract class, providing an interface for accessing an
index. |
LeafReaderContext
IndexReaderContext for LeafReader instances. |
NumericDocValues
A per-document numeric value.
|
PostingsEnum
Iterates through the postings.
|
PrefixCodedTerms
Prefix codes term instances (prefixes are shared).
|
SortedDocValues
A per-document byte[] with presorted values.
|
SortedNumericDocValues
A list of per-document numeric values, sorted
according to
Long.compare(long, long) . |
SortedSetDocValues
A multi-valued version of
SortedDocValues . |
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 or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum) . |
TermsEnum.SeekStatus
Represents returned result from
TermsEnum.seekCeil(org.apache.lucene.util.BytesRef) . |
TermState
Encapsulates all required internal state to position the associated
TermsEnum without re-seeking. |
TermStates |
Class and Description |
---|
LeafReaderContext
IndexReaderContext for LeafReader instances. |
Class and Description |
---|
BinaryDocValues
A per-document numeric value.
|
FieldInfos
Collection of
FieldInfo s (accessible by number or by name). |
Fields
Provides a
Terms index for fields that have it, and lists which fields do. |
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 for LeafReader instances. |
NumericDocValues
A per-document numeric value.
|
PointValues
Access to indexed numeric values.
|
SortedDocValues
A per-document byte[] with presorted values.
|
SortedNumericDocValues
A list of per-document numeric values, sorted
according to
Long.compare(long, long) . |
SortedSetDocValues
A multi-valued version of
SortedDocValues . |
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.
|
Class and Description |
---|
LeafReaderContext
IndexReaderContext for LeafReader instances. |
Class and Description |
---|
FilteredTermsEnum
Abstract class for enumerating a subset of all terms.
|
FilteredTermsEnum.AcceptStatus
Return value, if term should be accepted or the iteration should
END . |
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
LeafReaderContext
IndexReaderContext for LeafReader instances. |
NumericDocValues
A per-document numeric value.
|
OrdinalMap
Maps per-segment ordinals to/from global ordinal space, using a compact packed-ints representation.
|
SortedDocValues
A per-document byte[] with presorted values.
|
SortedNumericDocValues
A list of per-document numeric values, sorted
according to
Long.compare(long, long) . |
SortedSetDocValues
A multi-valued version of
SortedDocValues . |
TermsEnum
Iterator to seek (
TermsEnum.seekCeil(BytesRef) , TermsEnum.seekExact(BytesRef) ) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq() ), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum) . |
Class and Description |
---|
FieldInvertState
This class tracks the number and position / offset parameters of terms
being added to the index.
|
Class and Description |
---|
FieldInvertState
This class tracks the number and position / offset parameters of terms
being added to the index.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
LeafReaderContext
IndexReaderContext for LeafReader instances. |
PostingsEnum
Iterates through the postings.
|
Term
A Term represents a word from text.
|
TermStates |
Class and 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 an
IndexWriter . |
Term
A Term represents a word from text.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
LeafReaderContext
IndexReaderContext for LeafReader instances. |
Class and Description |
---|
IndexWriter
An
IndexWriter creates and maintains an index. |
IndexWriterConfig
Holds all the configuration that is used to create an
IndexWriter . |
IndexWriterConfig.OpenMode
Specifies the open mode for
IndexWriter . |
Class and Description |
---|
FilterLeafReader.FilterTerms
Base class for filtering
Terms 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 for LeafReader instances. |
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.
|
Class and Description |
---|
FieldInfo
Access to the Field Info file that describes document fields and whether or
not they are indexed.
|
FieldInfos
Collection of
FieldInfo s (accessible by number or by name). |
FilterLeafReader
A
FilterLeafReader contains another LeafReader, which it
uses as its basic source of data, possibly transforming the data along the
way or providing additional functionality. |
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
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. |
PostingsEnum
Iterates through the postings.
|
StoredFieldVisitor
Expert: provides a low-level means of accessing the stored field
values in an index.
|
StoredFieldVisitor.Status
Enumeration of possible return values for
StoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo) . |
Term
A Term represents a word from text.
|
Terms
Access to the terms in a specific field.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
Class and Description |
---|
LeafReaderContext
IndexReaderContext for LeafReader instances. |
Class and Description |
---|
LeafReaderContext
IndexReaderContext for LeafReader instances. |
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
Class and Description |
---|
IndexReaderContext
A struct like class that represents a hierarchical relationship between
IndexReader instances. |
LeafReaderContext
IndexReaderContext for LeafReader instances. |
PostingsEnum
Iterates through the postings.
|
Terms
Access to the terms in a specific field.
|
TermsEnum
Iterator to seek (
TermsEnum.seekCeil(BytesRef) , TermsEnum.seekExact(BytesRef) ) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq() ), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum) . |
Class and Description |
---|
LeafReader
LeafReader is an abstract class, providing an interface for accessing an
index. |
LeafReaderContext
IndexReaderContext for LeafReader instances. |
Class and Description |
---|
LeafReaderContext
IndexReaderContext for LeafReader instances. |
Class and Description |
---|
IndexableField
Represents a single field for indexing.
|
Class and Description |
---|
AlcoholicMergePolicy
Merge policy for testing, it is like an alcoholic.
|
CheckIndex.Status
Returned from
CheckIndex.checkIndex() detailing the health and status of the index. |
DirectoryReader
DirectoryReader is an implementation of
CompositeReader
that can read indexes in a Directory . |
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.
|
IndexWriter
An
IndexWriter creates and maintains an index. |
IndexWriterConfig
Holds all the configuration that is used to create an
IndexWriter . |
LeafReader
LeafReader is an abstract class, providing an interface for accessing an
index. |
LiveIndexWriterConfig
Holds all the configuration used by
IndexWriter with few setters for
settings that can be changed on an IndexWriter instance "live". |
LogMergePolicy
This class implements a
MergePolicy that tries
to merge segments into levels of exponentially
increasing size, where each level has fewer segments than
the value of the merge factor. |
MergePolicy
Expert: a MergePolicy determines the sequence of
primitive merge operations.
|
MergeScheduler
Expert:
IndexWriter uses an instance
implementing this interface to execute the merges
selected by a MergePolicy . |
NumericDocValues
A per-document numeric value.
|
PointValues
Access to indexed numeric values.
|
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 or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum) . |
TieredMergePolicy
Merges segments of approximately equal size, subject to
an allowed number of segments per tier.
|
Class and Description |
---|
Terms
Access to the terms in a specific field.
|
TermsEnum
Iterator to seek (
TermsEnum.seekCeil(BytesRef) , TermsEnum.seekExact(BytesRef) ) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq() ), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum) . |
Class and Description |
---|
MergeState.DocMap
A map of doc IDs.
|
PointValues
Access to indexed numeric values.
|
PointValues.IntersectVisitor
We recurse the BKD tree, using a provided instance of this to guide the recursion.
|
Class and Description |
---|
Term
A Term represents a word from text.
|
Copyright © 2000–2020 The Apache Software Foundation. All rights reserved.