Uses of Package
org.apache.lucene.index

Packages that use org.apache.lucene.index

org.apache.lucene.analysis	API and code to convert text into indexable/searchable tokens.
org.apache.lucene.analysis.tokenattributes
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.

Classes in org.apache.lucene.index used by org.apache.lucene.analysis

Payload
A Payload is metadata that can be stored together with each occurrence of a term.

Classes in org.apache.lucene.index used by org.apache.lucene.analysis.tokenattributes

Payload
A Payload is metadata that can be stored together with each occurrence of a term.

Classes in org.apache.lucene.index used by org.apache.lucene.document

FieldInfo.IndexOptions
Controls how much information is stored in the postings lists.

Classes in org.apache.lucene.index used by org.apache.lucene.index

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.IndexOptions
Controls how much information is stored in the postings lists.

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.FieldOption
Constants describing field properties, for example used for IndexReader.getFieldNames(FieldOption).

IndexReader.ReaderFinishedListener
A custom listener that's invoked when the IndexReader is finished.

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.DirPayloadProcessor to be used for a Directory.

PayloadProcessorProvider.DirPayloadProcessor
Returns a PayloadProcessorProvider.DirPayloadProcessor for a given Term which allows processing the payloads of different terms differently.

PayloadProcessorProvider.PayloadProcessor
Processes the given payload.

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

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

Classes in org.apache.lucene.index used by org.apache.lucene.queryParser

Term
A Term represents a word from text.

Classes in org.apache.lucene.index used by org.apache.lucene.search

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.

Classes in org.apache.lucene.index used by org.apache.lucene.search.function

IndexReader
IndexReader is an abstract class, providing an interface for accessing an index.

Term
A Term represents a word from text.

Classes in org.apache.lucene.index used by org.apache.lucene.search.payloads

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.

Classes in org.apache.lucene.index used by org.apache.lucene.search.spans

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.

Classes in org.apache.lucene.index used by org.apache.lucene.store

MergeScheduler
Expert: IndexWriter uses an instance implementing this interface to execute the merges selected by a MergePolicy.

Classes in org.apache.lucene.index used by org.apache.lucene.util

IndexReader
IndexReader is an abstract class, providing an interface for accessing an index.