| Package | Description |
|---|---|
| org.apache.lucene.analysis |
API and code to convert text into indexable/searchable tokens.
|
| org.apache.lucene.analysis.tokenattributes |
Useful
Attributes for text analysis. |
| org.apache.lucene.document |
The logical representation of a
Document for indexing and searching. |
| org.apache.lucene.index |
Code to maintain and access indices.
|
| org.apache.lucene.queryParser |
A simple query parser implemented with JavaCC.
|
| org.apache.lucene.search |
Code to search indices.
|
| org.apache.lucene.search.function |
Programmatic control over documents scores.
|
| org.apache.lucene.search.payloads |
The payloads package provides Query mechanisms for finding and using payloads.
|
| org.apache.lucene.search.spans |
The calculus of spans.
|
| org.apache.lucene.store |
Binary i/o API, used for all index data.
|
| org.apache.lucene.util |
Some utility classes.
|
| Class and Description |
|---|
| Payload
A Payload is metadata that can be stored together with each occurrence
of a term.
|
| Class and Description |
|---|
| Payload
A Payload is metadata that can be stored together with each occurrence
of a term.
|
| Class and Description |
|---|
| FieldInfo.IndexOptions
Controls how much information is stored in the postings lists.
|
| Class and Description |
|---|
| CheckIndex.Status
Returned from
CheckIndex.checkIndex() detailing the health and status of the index. |
| 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.
|
| ConcurrentMergeScheduler.MergeThread |
| CorruptIndexException
This exception is thrown when Lucene detects
an inconsistency in the index.
|
| FieldInfo
Access to the Fieldable 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
FieldInfos (accessible by number or by name). |
| FilterIndexReader.FilterTermDocs
Base class for filtering
TermDocs implementations. |
| 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. |
| IndexFileNameFilter
Filename filter that accept filenames and extensions only created by Lucene.
|
| IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
| IndexReader.ReaderClosedListener
A custom listener that's invoked when the IndexReader
is closed.
|
| IndexWriter
An
IndexWriter creates and maintains an index. |
| IndexWriter.IndexReaderWarmer
If
IndexWriter.getReader() has been called (ie, this writer
is in near real-time mode), then after a merge
completes, this class can be invoked to warm the
reader on the newly merged segment, before the merge
commits. |
| IndexWriter.MaxFieldLength
Deprecated.
use
LimitTokenCountAnalyzer instead. |
| IndexWriterConfig
Holds all the configuration of
IndexWriter. |
| IndexWriterConfig.OpenMode
Specifies the open mode for
IndexWriter:
IndexWriterConfig.OpenMode.CREATE - creates a new index or overwrites an existing one. |
| 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.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. |
| PayloadProcessorProvider
Provides a
PayloadProcessorProvider.ReaderPayloadProcessor to be used for a Directory. |
| PayloadProcessorProvider.DirPayloadProcessor
Deprecated.
Use
PayloadProcessorProvider.ReaderPayloadProcessor instead. |
| PayloadProcessorProvider.PayloadProcessor
Processes the given payload.
|
| PayloadProcessorProvider.ReaderPayloadProcessor
Returns a
PayloadProcessorProvider.ReaderPayloadProcessor for a given Term which allows
processing the payloads of different terms differently. |
| PositionBasedTermVectorMapper.TVPositionInfo
Container for a term at a position
|
| 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.
|
| SegmentReader.CoreClosedListener
Called when the shared core for this SegmentReader
is closed.
|
| SnapshotDeletionPolicy
An
IndexDeletionPolicy that wraps around any other
IndexDeletionPolicy and adds the ability to hold and later release
snapshots of an index. |
| StaleReaderException
This exception is thrown when an
IndexReader
tries to make changes to the index (via IndexReader.deleteDocument(int), IndexReader.undeleteAll() or IndexReader.setNorm(int, java.lang.String, byte))
but changes have already been committed to the index
since this reader was instantiated. |
| Term
A Term represents a word from text.
|
| TermDocs
TermDocs provides an interface for enumerating <document, frequency>
pairs for a term.
|
| TermEnum
Abstract class for enumerating terms.
|
| TermFreqVector
Provides access to stored term vector of
a document field.
|
| TermPositions
TermPositions provides an interface for enumerating the <document,
frequency, <position>* > tuples for a term.
|
| TermVectorEntry
Convenience class for holding TermVector information.
|
| TermVectorMapper
The TermVectorMapper can be used to map Term Vectors into your own
structure instead of the parallel array structure used by
IndexReader.getTermFreqVector(int,String). |
| TermVectorOffsetInfo
The TermVectorOffsetInfo class holds information pertaining to a Term in a
TermPositionVector's
offset information. |
| 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.
|
| Class and Description |
|---|
| Term
A Term represents a word from text.
|
| Class and Description |
|---|
| CorruptIndexException
This exception is thrown when Lucene detects
an inconsistency in the index.
|
| 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 an
index.
|
| IndexWriter
An
IndexWriter creates and maintains an index. |
| Term
A Term represents a word from text.
|
| TermEnum
Abstract class for enumerating terms.
|
| TermFreqVector
Provides access to stored term vector of
a document field.
|
| Class and Description |
|---|
| IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
| Term
A Term represents a word from text.
|
| Class and Description |
|---|
| IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
| Term
A Term represents a word from text.
|
| TermPositions
TermPositions provides an interface for enumerating the <document,
frequency, <position>* > tuples for a term.
|
| Class and Description |
|---|
| IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
| Term
A Term represents a word from text.
|
| TermPositions
TermPositions provides an interface for enumerating the <document,
frequency, <position>* > tuples for a term.
|
| Class and Description |
|---|
| MergeScheduler
Expert:
IndexWriter uses an instance
implementing this interface to execute the merges
selected by a MergePolicy. |
| Class and Description |
|---|
| FieldInfos
Collection of
FieldInfos (accessible by number or by name). |
| IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|