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 new documents.
|
org.apache.lucene.classification.utils |
Utilities for evaluation, data preparation, etc.
|
org.apache.lucene.codecs |
Codecs for testing (simulate old disk formats, wacky theoretical use cases, etc)
|
org.apache.lucene.codecs.appending |
Codec for on append-only outputs, such as plain output streams and append-only filesystems.
|
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 Lucene41, except the terms dictionary also
supports ords, i.e.
|
org.apache.lucene.codecs.bloom |
Support for generating test indexes using the BloomFilteringPostingsFormat
|
org.apache.lucene.codecs.compressing |
Support for testing
CompressingStoredFieldsFormat . |
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.lucene3x |
Support for generating test indexes in the Lucene 3.x index format.
|
org.apache.lucene.codecs.lucene40 |
Support for testing
Lucene40PostingsFormat . |
org.apache.lucene.codecs.lucene41 |
Support for testing
Lucene41Codec . |
org.apache.lucene.codecs.lucene410 |
Lucene 4.10 file format.
|
org.apache.lucene.codecs.lucene41ords |
Codec for testing that supports
TermsEnum.ord() |
org.apache.lucene.codecs.lucene42 |
Support for testing
Lucene42Codec . |
org.apache.lucene.codecs.lucene45 |
Support for testing
Lucene45Codec . |
org.apache.lucene.codecs.lucene46 |
Support for testing
Lucene46Codec . |
org.apache.lucene.codecs.lucene49 |
Support for testing
Lucene49Codec . |
org.apache.lucene.codecs.memory |
Term dictionary, DocValues or Postings formats that are read entirely into memory.
|
org.apache.lucene.codecs.mockintblock |
Integer encoder implementations for testing.
|
org.apache.lucene.codecs.mockrandom |
Frankenstein codec for testing that pieces together random components.
|
org.apache.lucene.codecs.mocksep |
Very simple implementations of
org.apache.lucene.codecs.sep for testing. |
org.apache.lucene.codecs.nestedpulsing |
Codec for testing that wraps
PulsingPostingsFormat with itself. |
org.apache.lucene.codecs.perfield |
Postings format that can delegate to different formats per-field.
|
org.apache.lucene.codecs.pulsing |
Pulsing Codec: inlines low frequency terms' postings into terms dictionary.
|
org.apache.lucene.codecs.ramonly |
Codec for testing that never writes to disk.
|
org.apache.lucene.codecs.sep |
Sep: base support for separate files (doc,frq,pos,skp,pyl)
|
org.apache.lucene.codecs.simpletext |
Simpletext Codec: writes human readable postings.
|
org.apache.lucene.collation |
Unicode Collation support.
|
org.apache.lucene.document |
Misc extensions of the Document/Field API.
|
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.index |
Misc index tools and index support.
|
org.apache.lucene.index.sorter |
Provides index sorting capablities.
|
org.apache.lucene.misc |
Miscellaneous index tools.
|
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.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.sandbox.queries |
Additional queries (some may have caveats or limitations)
|
org.apache.lucene.sandbox.queries.regex |
Regular expression Query.
|
org.apache.lucene.search |
This package contains a single proximity query, TermAutomatonQuery.
|
org.apache.lucene.search.grouping |
This module enables search result grouping with Lucene, where hits
with the same value in the specified single-valued group field are
grouped together.
|
org.apache.lucene.search.grouping.function |
Support for grouping by
ValueSource . |
org.apache.lucene.search.grouping.term |
Support for grouping by indexed terms via
FieldCache . |
org.apache.lucene.search.highlight |
The highlight package contains classes to provide "keyword in context" features
typically used to highlight search terms in the text of results pages.
|
org.apache.lucene.search.join |
This modules support index-time and query-time joins.
|
org.apache.lucene.search.payloads |
The payloads package provides Query mechanisms for finding and using payloads.
|
org.apache.lucene.search.similarities |
This package contains the various ranking models that can be used in Lucene.
|
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.vectorhighlight |
This is an another highlighter implementation.
|
org.apache.lucene.spatial |
Lucene spatial search
|
org.apache.lucene.spatial.bbox |
Bounding Box Spatial Strategy
|
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.util |
General test support.
|
org.apache.lucene.util.automaton |
Support for testing automata.
|
org.apache.lucene.util.packed |
Packed integer arrays and streams.
|
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 |
---|
AtomicReader
AtomicReader is an abstract class, providing an interface for accessing an
index. |
Class and Description |
---|
AtomicReader
AtomicReader is an abstract class, providing an interface for accessing an
index. |
Terms
Access to the terms in a specific field.
|
Class and Description |
---|
BinaryDocValues
A per-document byte[]
|
DocsAndPositionsEnum
Also iterates through positions.
|
DocsEnum
Iterates through the documents and term freqs.
|
FieldInfo
Access to the Field Info file that describes document fields and whether or
not they are indexed.
|
FieldInfo.IndexOptions
Controls how much information is stored in the postings lists.
|
FieldInfos
Collection of
FieldInfo s (accessible by number or by name). |
Fields
Flex API for access to fields and terms
|
IndexableField
Represents a single field for indexing.
|
MergeState
Holds common state used during segment merging.
|
MultiDocsAndPositionsEnum.EnumWithSlice
Holds a
DocsAndPositionsEnum along with the
corresponding ReaderSlice . |
MultiDocsEnum.EnumWithSlice
Holds a
DocsEnum along with the
corresponding ReaderSlice . |
NumericDocValues
A per-document numeric value.
|
OrdTermState
An ordinal based
TermState |
SegmentCommitInfo
Embeds a [read-only] SegmentInfo and adds per-commit
fields.
|
SegmentInfo
Information about a segment such as it's 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 per-document set of presorted byte[] values.
|
StoredFieldVisitor
Expert: provides a low-level means of accessing the stored field
values in an index.
|
TermsEnum
Iterator to seek (
TermsEnum.seekCeil(BytesRef) , TermsEnum.seekExact(BytesRef) ) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq() ), DocsEnum or DocsAndPositionsEnum for the current term (TermsEnum.docs(org.apache.lucene.util.Bits, org.apache.lucene.index.DocsEnum) . |
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). |
Fields
Flex API for access to fields and terms
|
SegmentInfo
Information about a segment such as it's name, directory, and files related
to the segment.
|
Class and Description |
---|
FieldInfos
Collection of
FieldInfo s (accessible by number or by name). |
SegmentInfo
Information about a segment such as it's 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). |
Fields
Flex API for access to fields and terms
|
SegmentInfo
Information about a segment such as it's name, directory, and files related
to the segment.
|
SegmentWriteState
Holder class for common parameters used during write.
|
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). |
Fields
Flex API for access to fields and terms
|
SegmentInfo
Information about a segment such as it's name, directory, and files related
to the segment.
|
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() ), DocsEnum or DocsAndPositionsEnum for the current term (TermsEnum.docs(org.apache.lucene.util.Bits, org.apache.lucene.index.DocsEnum) . |
Class and Description |
---|
DocsAndPositionsEnum
Also iterates through positions.
|
DocsEnum
Iterates through the documents and term freqs.
|
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
Flex API for access to fields and terms
|
SegmentInfo
Information about a segment such as it's name, directory, and files related
to the segment.
|
SegmentReadState
Holder class for common parameters used during read.
|
SegmentWriteState
Holder class for common parameters used during write.
|
Terms
Access to the terms in a specific field.
|
TermsEnum
Iterator to seek (
TermsEnum.seekCeil(BytesRef) , TermsEnum.seekExact(BytesRef) ) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq() ), DocsEnum or DocsAndPositionsEnum for the current term (TermsEnum.docs(org.apache.lucene.util.Bits, org.apache.lucene.index.DocsEnum) . |
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
Flex API for access to fields and terms
|
IndexableField
Represents a single field for indexing.
|
MergeState
Holds common state used during segment merging.
|
SegmentInfo
Information about a segment such as it's 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 |
---|
DocsAndPositionsEnum
Also iterates through positions.
|
DocsEnum
Iterates through the documents and term freqs.
|
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
Flex API for access to fields and terms
|
SegmentInfo
Information about a segment such as it's name, directory, and files related
to the segment.
|
SegmentReadState
Holder class for common parameters used during read.
|
SegmentWriteState
Holder class for common parameters used during write.
|
Terms
Access to the terms in a specific field.
|
TermsEnum
Iterator to seek (
TermsEnum.seekCeil(BytesRef) , TermsEnum.seekExact(BytesRef) ) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq() ), DocsEnum or DocsAndPositionsEnum for the current term (TermsEnum.docs(org.apache.lucene.util.Bits, org.apache.lucene.index.DocsEnum) . |
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 |
---|
SegmentInfo
Information about a segment such as it's 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.
|
Class and Description |
---|
DocsAndPositionsEnum
Also iterates through positions.
|
DocsEnum
Iterates through the documents and term freqs.
|
FieldInfo
Access to the Field Info file that describes document fields and whether or
not they are indexed.
|
FieldInfo.DocValuesType
DocValues types.
|
FieldInfos
Collection of
FieldInfo s (accessible by number or by name). |
Fields
Flex API for access to fields and terms
|
IndexableField
Represents a single field for indexing.
|
MergeState
Holds common state used during segment merging.
|
SegmentCommitInfo
Embeds a [read-only] SegmentInfo and adds per-commit
fields.
|
SegmentInfo
Information about a segment such as it's 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 |
---|
DocsAndPositionsEnum
Also iterates through positions.
|
DocsEnum
Iterates through the documents and term freqs.
|
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). |
SegmentInfo
Information about a segment such as it's 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 |
---|
SegmentReadState
Holder class for common parameters used during read.
|
SegmentWriteState
Holder class for common parameters used during write.
|
Class and Description |
---|
FieldInfos
Collection of
FieldInfo s (accessible by number or by name). |
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 |
---|
FieldInfos
Collection of
FieldInfo s (accessible by number or by name). |
SegmentInfo
Information about a segment such as it's name, directory, and files related
to the segment.
|
Class and Description |
---|
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
Flex API for access to fields and terms
|
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 |
---|
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 |
---|
DocsAndPositionsEnum
Also iterates through positions.
|
DocsEnum
Iterates through the documents and term freqs.
|
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 |
---|
SegmentReadState
Holder class for common parameters used during read.
|
SegmentWriteState
Holder class for common parameters used during write.
|
Class and Description |
---|
DocsAndPositionsEnum
Also iterates through positions.
|
DocsEnum
Iterates through the documents and term freqs.
|
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). |
SegmentInfo
Information about a segment such as it's name, directory, and files related
to the segment.
|
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.
|
FieldInfo.DocValuesType
DocValues types.
|
FieldInfos
Collection of
FieldInfo s (accessible by number or by name). |
Fields
Flex API for access to fields and terms
|
IndexableField
Represents a single field for indexing.
|
SegmentCommitInfo
Embeds a [read-only] SegmentInfo and adds per-commit
fields.
|
SegmentInfo
Information about a segment such as it's 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 |
---|
FieldInfo
Access to the Field Info file that describes document fields and whether or
not they are indexed.
|
FieldInfo.DocValuesType
DocValues types.
|
FieldInfo.IndexOptions
Controls how much information is stored in the postings lists.
|
IndexableField
Represents a single field for indexing.
|
IndexableFieldType
Describes the properties of a field.
|
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
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 |
---|
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
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.
|
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 per-document set of presorted byte[] values.
|
Class and Description |
---|
AtomicReader
AtomicReader is an abstract class, providing an interface for accessing an
index. |
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
BinaryDocValues
A per-document byte[]
|
FilterAtomicReader
A
FilterAtomicReader contains another AtomicReader, 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.
|
IndexWriter
An
IndexWriter creates and maintains an index. |
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 |
---|
AtomicReader
AtomicReader is an abstract class, providing an interface for accessing an
index. |
AtomicReader.CoreClosedListener
Called when the shared core for this
AtomicReader
is closed. |
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
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.
|
BaseTermVectorsFormatTestCase.Options
A combination of term vectors options.
|
BaseTermVectorsFormatTestCase.RandomDocument |
BaseTermVectorsFormatTestCase.RandomTokenStream |
BinaryDocValues
A per-document byte[]
|
CheckIndex.Status
Returned from
CheckIndex.checkIndex() detailing the health and status of the index. |
CheckIndex.Status.DocValuesStatus
Status from testing DocValues
|
CheckIndex.Status.FieldNormStatus
Status from testing field norms.
|
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.
|
CompositeReader
Instances of this reader type can only
be used to get stored fields from the underlying AtomicReaders,
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, which may run one or more merges
in sequence.
|
CorruptIndexException
This exception is thrown when Lucene detects
an inconsistency in the index.
|
DirectoryReader
DirectoryReader is an implementation of
CompositeReader
that can read indexes in a Directory . |
DocsAndPositionsEnum
Also iterates through positions.
|
DocsEnum
Iterates through the documents and term freqs.
|
FieldInfo
Access to the Field Info file that describes document fields and whether or
not they are indexed.
|
FieldInfo.DocValuesType
DocValues types.
|
FieldInfo.IndexOptions
Controls how much information is stored in the postings lists.
|
FieldInfos
Collection of
FieldInfo s (accessible by number or by name). |
Fields
Flex API for access to fields and terms
|
FilterAtomicReader
A
FilterAtomicReader contains another AtomicReader, which it
uses as its basic source of data, possibly transforming the data along the
way or providing additional functionality. |
FilterAtomicReader.FilterDocsEnum
Base class for filtering
DocsEnum implementations. |
FilterAtomicReader.FilterFields
Base class for filtering
Fields
implementations. |
FilterAtomicReader.FilterTerms
Base class for filtering
Terms implementations. |
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 . |
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 . |
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
IndexReader.ReaderClosedListener
A custom listener that's invoked when the IndexReader
is closed.
|
IndexReaderContext
A struct like class that represents a hierarchical relationship between
IndexReader instances. |
IndexWriter
An
IndexWriter creates and maintains an index. |
IndexWriter.IndexReaderWarmer
If
DirectoryReader.open(IndexWriter,boolean) 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 . |
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.DocMap
A map of doc IDs.
|
MergePolicy.MergeAbortedException
Thrown when a merge was explicity aborted because
IndexWriter.close(boolean) was called with
false . |
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.
|
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.CheckAbort
Class for recording units of work when merging segments.
|
MergeState.DocMap
Remaps docids around deletes during merge
|
MergeTrigger
MergeTrigger is passed to
MergePolicy.findMerges(MergeTrigger, org.apache.lucene.index.SegmentInfos, IndexWriter) to indicate the
event that triggered the merge. |
MultiDocsAndPositionsEnum
Exposes flex API, merged from flex API of sub-segments.
|
MultiDocsAndPositionsEnum.EnumWithSlice
Holds a
DocsAndPositionsEnum along with the
corresponding ReaderSlice . |
MultiDocsEnum.EnumWithSlice
Holds a
DocsEnum along with the
corresponding ReaderSlice . |
MultiDocValues.OrdinalMap
maps per-segment ordinals to/from global ordinal space
|
MultiTermsEnum |
NumericDocValues
A per-document numeric value.
|
RandomAccessOrds
Extension of
SortedSetDocValues that supports random access
to the ordinals of a document. |
RandomIndexWriter.TestPoint
Simple interface that is executed for each TP
InfoStream component
message. |
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 it's 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.
|
SegmentReader
IndexReader implementation over a single segment.
|
SegmentReadState
Holder class for common parameters used during read.
|
SegmentWriteState
Holder class for common parameters used during write.
|
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 per-document set of presorted byte[] values.
|
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.
|
TermContext |
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() ), DocsEnum or DocsAndPositionsEnum for the current term (TermsEnum.docs(org.apache.lucene.util.Bits, org.apache.lucene.index.DocsEnum) . |
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. |
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 |
---|
AtomicReader
AtomicReader is an abstract class, providing an interface for accessing an
index. |
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
BinaryDocValues
A per-document byte[]
|
Fields
Flex API for access to fields and terms
|
FilterAtomicReader
A
FilterAtomicReader contains another AtomicReader, 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.
|
IndexWriter
An
IndexWriter creates and maintains an index. |
MergePolicy
Expert: a MergePolicy determines the sequence of
primitive merge operations.
|
MergePolicy.MergeSpecification
A MergeSpecification instance provides the information
necessary to perform multiple merges.
|
MergeTrigger
MergeTrigger is passed to
MergePolicy.findMerges(MergeTrigger, org.apache.lucene.index.SegmentInfos, IndexWriter) to indicate the
event that triggered the merge. |
NumericDocValues
A per-document numeric value.
|
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.
|
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 per-document set of presorted byte[] values.
|
StoredFieldVisitor
Expert: provides a low-level means of accessing the stored field
values in an index.
|
Class and Description |
---|
FieldInvertState
This class tracks the number and position / offset parameters of terms
being added to the index.
|
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 |
---|
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
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.
|
TermContext |
Class and Description |
---|
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
DocsEnum
Iterates through the documents and term freqs.
|
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 |
---|
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
IndexReader
IndexReader is an abstract class, providing an interface for accessing a
point-in-time view of an index.
|
SortedDocValues
A per-document byte[] with presorted values.
|
Class and Description |
---|
AtomicReaderContext
IndexReaderContext for AtomicReader 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 |
---|
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 |
---|
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
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.
|
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() ), DocsEnum or DocsAndPositionsEnum for the current term (TermsEnum.docs(org.apache.lucene.util.Bits, org.apache.lucene.index.DocsEnum) . |
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 . |
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() ), DocsEnum or DocsAndPositionsEnum for the current term (TermsEnum.docs(org.apache.lucene.util.Bits, org.apache.lucene.index.DocsEnum) . |
Class and Description |
---|
AtomicReader
AtomicReader is an abstract class, providing an interface for accessing an
index. |
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
BaseCompositeReader
Base class for implementing
CompositeReader s based on an array
of sub-readers. |
BinaryDocValues
A per-document byte[]
|
CompositeReader
Instances of this reader type can only
be used to get stored fields from the underlying AtomicReaders,
but it is not possible to directly retrieve postings.
|
DocsAndPositionsEnum
Also iterates through positions.
|
DocsEnum
Iterates through the documents and term freqs.
|
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.
|
IndexReaderContext
A struct like class that represents a hierarchical relationship between
IndexReader instances. |
IndexWriter
An
IndexWriter creates and maintains an index. |
MultiReader
A
CompositeReader which reads multiple indexes, appending
their content. |
NumericDocValues
A per-document numeric value.
|
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 per-document set of presorted byte[] values.
|
StoredFieldVisitor
Expert: provides a low-level means of accessing the stored field
values in an index.
|
Term
A Term represents a word from text.
|
TermContext |
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() ), DocsEnum or DocsAndPositionsEnum for the current term (TermsEnum.docs(org.apache.lucene.util.Bits, org.apache.lucene.index.DocsEnum) . |
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. |
TrackingIndexWriter
Class that tracks changes to a delegated
IndexWriter, used by
ControlledRealTimeReopenThread to ensure specific
changes are visible. |
Class and Description |
---|
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
Class and Description |
---|
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
Class and Description |
---|
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
Class and Description |
---|
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
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 |
---|
AtomicReader
AtomicReader is an abstract class, providing an interface for accessing an
index. |
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
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 |
---|
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
DocsEnum
Iterates through the documents and term freqs.
|
IndexReaderContext
A struct like class that represents a hierarchical relationship between
IndexReader instances. |
Term
A Term represents a word from text.
|
Class and Description |
---|
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
FieldInvertState
This class tracks the number and position / offset parameters of terms
being added to the index.
|
Class and Description |
---|
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
DocsAndPositionsEnum
Also iterates through positions.
|
DocsEnum
Iterates through the documents and term freqs.
|
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.
|
TermContext |
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.
|
Class and Description |
---|
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 |
---|
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
Class and Description |
---|
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
Class and Description |
---|
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
DocsEnum
Iterates through the documents and term freqs.
|
TermsEnum
Iterator to seek (
TermsEnum.seekCeil(BytesRef) , TermsEnum.seekExact(BytesRef) ) or step through (BytesRefIterator.next() terms to obtain frequency information (TermsEnum.docFreq() ), DocsEnum or DocsAndPositionsEnum for the current term (TermsEnum.docs(org.apache.lucene.util.Bits, org.apache.lucene.index.DocsEnum) . |
Class and Description |
---|
AtomicReader
AtomicReader is an abstract class, providing an interface for accessing an
index. |
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
Class and Description |
---|
AtomicReaderContext
IndexReaderContext for AtomicReader instances. |
Class and Description |
---|
AlcoholicMergePolicy
Merge policy for testing, it is like an alcoholic.
|
AtomicReader
AtomicReader is an abstract class, providing an interface for accessing an
index. |
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 . |
DocsAndPositionsEnum
Also iterates through positions.
|
DocsEnum
Iterates through the documents and term freqs.
|
Fields
Flex API for access to fields and terms
|
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 . |
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.
|
SegmentReader
IndexReader implementation over a single segment.
|
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() ), DocsEnum or DocsAndPositionsEnum for the current term (TermsEnum.docs(org.apache.lucene.util.Bits, org.apache.lucene.index.DocsEnum) . |
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() ), DocsEnum or DocsAndPositionsEnum for the current term (TermsEnum.docs(org.apache.lucene.util.Bits, org.apache.lucene.index.DocsEnum) . |
Class and Description |
---|
NumericDocValues
A per-document numeric value.
|
Copyright © 2000–2022 The Apache Software Foundation. All rights reserved.