## 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.index: Code to maintain and access indices.
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.

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.index
CorruptIndexException This exception is thrown when Lucene detects an inconsistency in the index.
FilterIndexReader.FilterTermDocs Base class for filtering `TermDocs` implementations.
IndexCommitPoint
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)`.
IndexWriter An `IndexWriter` creates and maintains an index.
LogMergePolicy This class implements a `MergePolicy` that tries to merge segments into levels of exponentially increasing size, where each level has < mergeFactor segments in it.
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`.
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.
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.search
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.
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.

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.

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.

Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.