Package org.apache.lucene.index

Interface Summary

Interface	Description
ImpactsSource	Source of Impacts.
IndexableField	Represents a single field for indexing.
IndexableFieldType	Describes the properties of a field.
IndexReader.CacheHelper	A utility class that gives hooks in order to help build a cache based on the data that is contained in this index.
IndexReader.ClosedListener	A listener that is called when a resource gets closed.
IndexWriter.IndexReaderWarmer	If DirectoryReader.open(IndexWriter) 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.
MergePolicy.MergeContext	This interface represents the current context of the merge selection process.
PointValues.IntersectVisitor	We recurse the BKD tree, using a provided instance of this to guide the recursion.
TwoPhaseCommit	An interface for implementations that support 2-phase commit.

Class Summary

Class	Description
AutomatonTermsEnum	A FilteredTermsEnum that enumerates terms based upon what is accepted by a DFA.
BaseCompositeReader<R extends IndexReader>	Base class for implementing CompositeReaders based on an array of sub-readers.
BaseTermsEnum	A base TermsEnum that adds default implementations for BaseTermsEnum.attributes() BaseTermsEnum.termState() BaseTermsEnum.seekExact(BytesRef) BaseTermsEnum.seekExact(BytesRef, TermState) In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.
BinaryDocValues	A per-document numeric value.
CheckIndex	Basic tool and API to check the health of an index and write a new segments file that removes reference to problematic segments.
CheckIndex.Options	Run-time configuration options for CheckIndex commands.
CheckIndex.Status	Returned from CheckIndex.checkIndex() detailing the health and status of the index.
CheckIndex.Status.DocValuesStatus	Status from testing DocValues
CheckIndex.Status.FieldInfoStatus	Status from testing field infos.
CheckIndex.Status.FieldNormStatus	Status from testing field norms.
CheckIndex.Status.IndexSortStatus	Status from testing index sort
CheckIndex.Status.LiveDocStatus	Status from testing livedocs
CheckIndex.Status.PointsStatus	Status from testing PointValues
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.
CheckIndex.VerifyPointsVisitor	Walks the entire N-dimensional points space, verifying that all points fall within the last cell's boundaries.
CodecReader	LeafReader implemented by codec APIs.
CompositeReader	Instances of this reader type can only be used to get stored fields from the underlying LeafReaders, 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.
DirectoryReader	DirectoryReader is an implementation of CompositeReader that can read indexes in a Directory.
DocIDMerger<T extends DocIDMerger.Sub>	Utility class to help merging documents from sub-readers according to either simple concatenated (unsorted) order, or by a specified index-time sort, skipping deleted documents and remapping non-deleted documents.
DocIDMerger.Sub	Represents one sub-reader being merged
DocValues	This class contains utility methods and constants for DocValues
EmptyDocValuesProducer	Abstract base class implementing a DocValuesProducer that has no doc values.
FieldInfo	Access to the Field Info file that describes document fields and whether or not they are indexed.
FieldInfos	Collection of FieldInfos (accessible by number or by name).
FieldInvertState	This class tracks the number and position / offset parameters of terms being added to the index.
Fields	Provides a Terms index for fields that have it, and lists which fields do.
FilterCodecReader	A FilterCodecReader contains another CodecReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.
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.
FilterLeafReader	A FilterLeafReader contains another LeafReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.
FilterLeafReader.FilterFields	Base class for filtering Fields implementations.
FilterLeafReader.FilterPostingsEnum	Base class for filtering PostingsEnum implementations.
FilterLeafReader.FilterTerms	Base class for filtering Terms implementations.
FilterLeafReader.FilterTermsEnum	Base class for filtering TermsEnum implementations.
FilterMergePolicy	A wrapper for MergePolicy instances.
FilterNumericDocValues	Delegates all methods to a wrapped NumericDocValues.
Impact	Per-document scoring factors.
Impacts	Information about upcoming impacts, ie.
ImpactsEnum	Extension of PostingsEnum which also provides information about upcoming impacts.
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.
IndexFileNames	This class contains useful constants representing filenames and extensions used by lucene, as well as convenience methods for querying whether a file name matches an extension (matchesExtension), as well as generating file names from a segment name, generation and extension ( fileNameFromGeneration, segmentFileName).
IndexReader	IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index.
IndexReader.CacheKey	A cache key identifying a resource that is being cached on.
IndexReaderContext	A struct like class that represents a hierarchical relationship between IndexReader instances.
IndexWriter	An IndexWriter creates and maintains an index.
IndexWriter.DocStats	DocStats for this index
IndexWriterConfig	Holds all the configuration that is used to create an IndexWriter.
KeepOnlyLastCommitDeletionPolicy	This IndexDeletionPolicy implementation that keeps only the most recent commit and immediately removes all prior commits after a new commit is done.
LeafMetaData	Provides read-only metadata about a leaf.
LeafReader	LeafReader is an abstract class, providing an interface for accessing an index.
LeafReaderContext	IndexReaderContext for LeafReader instances.
LiveIndexWriterConfig	Holds all the configuration used by IndexWriter with few setters for settings that can be changed on an IndexWriter instance "live".
MappedMultiFields	A Fields implementation that merges multiple Fields into one, and maps around deleted documents.
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.
MergePolicy.OneMergeProgress	Progress and state for an executing merge.
MergeRateLimiter	This is the RateLimiter that IndexWriter assigns to each running merge, to give MergeSchedulers ionice like control.
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.DocMap	A map of doc IDs.
MultiFields	Provides a single Fields term index view over an IndexReader.
MultiPostingsEnum	Exposes PostingsEnum, merged from PostingsEnum API of sub-segments.
MultiPostingsEnum.EnumWithSlice	Holds a PostingsEnum along with the corresponding ReaderSlice.
MultiReader	A CompositeReader which reads multiple indexes, appending their content.
MultiTerms	Exposes flex API, merged from flex API of sub-segments.
MultiTermsEnum	Exposes TermsEnum API, merged from TermsEnum API of sub-segments.
NoMergePolicy	A MergePolicy which never returns merges to execute.
NumericDocValues	A per-document numeric value.
OneMergeHelper	Allows pkg private access
OneMergeWrappingMergePolicy	A wrapping merge policy that wraps the MergePolicy.OneMerge objects returned by the wrapped merge policy.
OrdinalMap	Maps per-segment ordinals to/from global ordinal space, using a compact packed-ints representation.
OrdTermState	An ordinal based TermState
PointValues	Access to indexed numeric values.
PostingsEnum	Iterates through the postings.
PrefixCodedTerms	Prefix codes term instances (prefixes are shared).
PrefixCodedTerms.Builder	Builds a PrefixCodedTerms: call add repeatedly, then finish.
PrefixCodedTerms.TermIterator	An iterator over the list of terms stored in a PrefixCodedTerms.
ReaderSlice	Subreader slice from a parent composite reader.
ReaderUtil	Common util methods for dealing with IndexReaders and IndexReaderContexts.
SegmentCommitInfo	Embeds a [read-only] SegmentInfo and adds per-commit fields.
SegmentInfo	Information about a segment such as its 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.
SegmentInfos.FindSegmentsFile<T>	Utility class for executing code that needs to do something with the current segments file.
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.
SingleTermsEnum	Subclass of FilteredTermsEnum for enumerating a single term.
SlowImpactsEnum	ImpactsEnum that doesn't index impacts but implements the API in a legal way.
SoftDeletesDirectoryReaderWrapper	This reader filters out documents that have a doc values value in the given field and treat these documents as soft deleted.
SoftDeletesRetentionMergePolicy	This MergePolicy allows to carry over soft deleted documents across merges.
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 multi-valued version of SortedDocValues.
StandardDirectoryReader	Default implementation of DirectoryReader.
StoredFieldVisitor	Expert: provides a low-level means of accessing the stored field values in 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()), PostingsEnum or PostingsEnum for the current term (TermsEnum.postings(org.apache.lucene.index.PostingsEnum).
TermState	Encapsulates all required internal state to position the associated TermsEnum without re-seeking.
TermStates	Maintains a IndexReader TermState view over IndexReader instances containing a single term.
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.

Enum Summary

Enum	Description
DocValuesType	DocValues types.
FilteredTermsEnum.AcceptStatus	Return value, if term should be accepted or the iteration should END.
IndexOptions	Controls how much information is stored in the postings lists.
IndexWriterConfig.OpenMode	Specifies the open mode for IndexWriter.
MergePolicy.OneMergeProgress.PauseReason	Reason for pausing the merge thread.
MergeTrigger	MergeTrigger is passed to MergePolicy.findMerges(MergeTrigger, SegmentInfos, MergePolicy.MergeContext) to indicate the event that triggered the merge.
PointValues.Relation	Used by PointValues.intersect(org.apache.lucene.index.PointValues.IntersectVisitor) to check how each recursive cell corresponds to the query.
StoredFieldVisitor.Status	Enumeration of possible return values for StoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo).
TermsEnum.SeekStatus	Represents returned result from TermsEnum.seekCeil(org.apache.lucene.util.BytesRef).

Exception Summary

Exception	Description
CorruptIndexException	This exception is thrown when Lucene detects an inconsistency in the index.
IndexFormatTooNewException	This exception is thrown when Lucene detects an index that is newer than this Lucene version.
IndexFormatTooOldException	This exception is thrown when Lucene detects an index that is too old for this Lucene version
IndexNotFoundException	Signals that no index was found in the Directory.
MergePolicy.MergeAbortedException	Thrown when a merge was explicitly aborted because IndexWriter.abortMerges() was called.
MergePolicy.MergeException	Exception thrown if there are any problems while executing a merge.