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.payloads	Provides various convenience classes for creating payloads on Tokens.
org.apache.lucene.analysis.query	Automatically filter high-frequency stopwords.
org.apache.lucene.analysis.tokenattributes
org.apache.lucene.benchmark.byTask	Benchmarking Lucene By Tasks.
org.apache.lucene.benchmark.byTask.tasks	Extendable benchmark tasks.
org.apache.lucene.index	Code to maintain and access indices.
org.apache.lucene.misc
org.apache.lucene.queryParser	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.search	Code to search indices.
org.apache.lucene.search.function	Programmatic control over documents scores.
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.payloads	The payloads package provides Query mechanisms for finding and using payloads.
org.apache.lucene.search.regex	Regular expression Query.
org.apache.lucene.search.similar	Document similarity query generators.
org.apache.lucene.search.spans	The calculus of spans.
org.apache.lucene.search.spell	Suggest alternate spellings for words.
org.apache.lucene.search.vectorhighlight	This is an another highlighter implementation.
org.apache.lucene.spatial.geohash	Support for Geohash encoding, decoding, and filtering.
org.apache.lucene.spatial.tier	Support for filtering based upon geographic location.
org.apache.lucene.store.instantiated	InstantiatedIndex, alternative RAM store for small corpora.
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.payloads

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.query

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.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.benchmark.byTask

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

IndexWriter
An IndexWriter creates and maintains an index.

Classes in org.apache.lucene.index used by org.apache.lucene.benchmark.byTask.tasks

CorruptIndexException
This exception is thrown when Lucene detects an inconsistency in the index.

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 an index.

IndexWriter
An IndexWriter creates and maintains an index.

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.

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

BalancedSegmentMergePolicy.MergePolicyParams

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.

FilterIndexReader
A FilterIndexReader contains another IndexReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.

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.

LogByteSizeMergePolicy
This is a LogMergePolicy that measures size of a segment as the total byte size of the segment's files.

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 to be used for overall merge and optimize 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.

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

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.

Term
A Term represents a word from text.

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.queryParser.complexPhrase

Term
A Term represents a word from text.

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

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

Term
A Term represents a word from text.

TermEnum
Abstract class for enumerating terms.

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.

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.highlight

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

TermPositionVector
Extends TermFreqVector to provide additional information about positions in which each of the terms is found.

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.regex

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

Term
A Term represents a word from text.

TermEnum
Abstract class for enumerating terms.

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

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

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.search.spell

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

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

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

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

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

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

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

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

CorruptIndexException
This exception is thrown when Lucene detects an inconsistency in the index.

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).

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.

TermPositionVector
Extends TermFreqVector to provide additional information about positions in which each of the terms is found.

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.

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.