Package org.apache.lucene.index

Code to maintain and access indices.

See: Description

Interface Summary

Interface	Description
[source] IndexDeletionPolicy	Expert: policy for deletion of stale index commits.
[source] TermDocs	TermDocs provides an interface for enumerating <document, frequency> pairs for a term.
[source] TermFreqVector	Provides access to stored term vector of a document field.
[source] TermPositions	TermPositions provides an interface for enumerating the <document, frequency, <position>* > tuples for a term.
[source] TermPositionVector	Extends TermFreqVector to provide additional information about positions in which each of the terms is found.

Class Summary

Class	Description
[source] AbstractAllTermDocs	Base class for enumerating all but deleted docs.
[source] AllTermDocs
[source] BalancedSegmentMergePolicy	Merge policy that tries to balance not doing large segment merges with not accumulating too many segments in the index, to provide for better performance in near real-time setting.
[source] BalancedSegmentMergePolicy.MergePolicyParams
[source] BufferedDeletes	Holds buffered deletes, by docID, term or query.
[source] BufferedDeletes.Num
[source] ByteBlockPool
[source] ByteBlockPool.Allocator
[source] ByteSliceReader
[source] ByteSliceWriter	Class to write byte streams into slices of shared byte[].
[source] CharBlockPool	Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
[source] CheckIndex	Basic tool and API to check the health of an index and write a new segments file that removes reference to problematic segments.
[source] CheckIndex.Status	Returned from CheckIndex.checkIndex() detailing the health and status of the index.
[source] CheckIndex.Status.FieldNormStatus	Status from testing field norms.
[source] CheckIndex.Status.SegmentInfoStatus	Holds the status of each segment in the index.
[source] CheckIndex.Status.StoredFieldStatus	Status from testing stored fields.
[source] CheckIndex.Status.TermIndexStatus	Status from testing term index.
[source] CheckIndex.Status.TermVectorStatus	Status from testing stored fields.
[source] CompoundFileReader	Class for accessing a compound stream.
[source] CompoundFileReader.CSIndexInput	Implementation of an IndexInput that reads from a portion of the compound file.
[source] CompoundFileWriter	Combines multiple files into a single compound file.
[source] ConcurrentMergeScheduler	A MergeScheduler that runs each merge using a separate thread, up until a maximum number of threads (ConcurrentMergeScheduler.setMaxThreadCount(int)) at which when a merge is needed, the thread(s) that are updating the index will pause until one or more merges completes.
[source] DefaultSkipListReader	Implements the skip list reader for the default posting list format that stores positions and payloads.
[source] DefaultSkipListWriter	Implements the skip list writer for the default posting list format that stores positions and payloads.
[source] DirectoryReader	An IndexReader which reads indexes with multiple segments.
[source] DirectoryReader.MultiTermDocs
[source] DirectoryReader.MultiTermEnum
[source] DirectoryReader.MultiTermPositions
[source] DocConsumer
[source] DocConsumerPerThread
[source] DocFieldConsumer
[source] DocFieldConsumerPerField
[source] DocFieldConsumerPerThread
[source] DocFieldConsumers	This is just a "splitter" class: it lets you wrap two DocFieldConsumer instances as a single consumer.
[source] DocFieldConsumersPerField
[source] DocFieldConsumersPerThread
[source] DocFieldProcessor	This is a DocConsumer that gathers all fields under the same name, and calls per-field consumers to process field by field.
[source] DocFieldProcessorPerField	Holds all per thread, per field state.
[source] DocFieldProcessorPerThread	Gathers all Fieldables for a document under the same name, updates FieldInfos, and calls per-field consumers to process field by field.
[source] DocHelper
[source] DocInverter	This is a DocFieldConsumer that inverts each field, separately, from a Document, and accepts a InvertedTermsConsumer to process those terms.
[source] DocInverterPerField	Holds state for inverting all occurrences of a single field in the document.
[source] DocInverterPerThread	This is a DocFieldConsumer that inverts each field, separately, from a Document, and accepts a InvertedTermsConsumer to process those terms.
[source] DocInverterPerThread.SingleTokenAttributeSource
[source] DocumentsWriter	This class accepts multiple added documents and directly writes a single segment file.
[source] DocumentsWriter.DocState
[source] DocumentsWriter.DocWriter	Consumer returns this on each doc.
[source] DocumentsWriter.IndexingChain	The IndexingChain must define the DocumentsWriter.IndexingChain.getChain(DocumentsWriter) method which returns the DocConsumer that the DocumentsWriter calls to process the documents.
[source] DocumentsWriterThreadState	Used by DocumentsWriter to maintain per-thread state.
[source] FieldInfo	Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
[source] FieldInfos	Access to the Fieldable Info file that describes document fields and whether or not they are indexed.
[source] FieldInvertState	This class tracks the number and position / offset parameters of terms being added to the index.
[source] FieldNormModifier	Given a directory and a list of fields, updates the fieldNorms in place for every document.
[source] FieldSortedTermVectorMapper	For each Field, store a sorted collection of TermVectorEntrys This is not thread-safe.
[source] FieldsReader	Class responsible for access to stored document fields.
[source] FieldsWriter
[source] 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.
[source] FilterIndexReader.FilterTermDocs	Base class for filtering TermDocs implementations.
[source] FilterIndexReader.FilterTermEnum	Base class for filtering TermEnum implementations.
[source] FilterIndexReader.FilterTermPositions	Base class for filtering TermPositions implementations.
[source] FormatPostingsDocsConsumer	NOTE: this API is experimental and will likely change
[source] FormatPostingsDocsWriter
[source] FormatPostingsFieldsConsumer	Abstract API that consumes terms, doc, freq, prox and payloads postings.
[source] FormatPostingsFieldsWriter
[source] FormatPostingsPositionsConsumer
[source] FormatPostingsPositionsWriter
[source] FormatPostingsTermsConsumer	NOTE: this API is experimental and will likely change
[source] FormatPostingsTermsWriter
[source] FreqProxFieldMergeState	Used by DocumentsWriter to merge the postings from multiple ThreadStates when creating a segment
[source] FreqProxTermsWriter
[source] FreqProxTermsWriter.PostingList
[source] FreqProxTermsWriterPerField
[source] FreqProxTermsWriterPerThread	Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
[source] IndexCommit	Expert: represents a single commit into an index as seen by the IndexDeletionPolicy or IndexReader.
[source] IndexFileDeleter
[source] IndexFileNameFilter	Filename filter that accept filenames and extensions only created by Lucene.
[source] IndexFileNames	Useful constants representing filenames and extensions used by lucene
[source] IndexReader	IndexReader is an abstract class, providing an interface for accessing an index.
[source] IndexReader.FieldOption	Constants describing field properties, for example used for IndexReader.getFieldNames(FieldOption).
[source] IndexSplitter	Command-line tool that enables listing segments in an index, copying specific segments to another index, and deleting segments from an index.
[source] IndexWriter	An IndexWriter creates and maintains an index.
[source] 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.
[source] IndexWriter.MaxFieldLength	Specifies maximum field length (in number of tokens/terms) in IndexWriter constructors.
[source] IntBlockPool	Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
[source] InvertedDocConsumer
[source] InvertedDocConsumerPerField
[source] InvertedDocConsumerPerThread
[source] InvertedDocEndConsumer
[source] InvertedDocEndConsumerPerField	Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
[source] InvertedDocEndConsumerPerThread	Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
[source] KeepOnlyLastCommitDeletionPolicy	This IndexDeletionPolicy implementation that keeps only the most recent commit and immediately removes all prior commits after a new commit is done.
[source] LogByteSizeMergePolicy	This is a LogMergePolicy that measures size of a segment as the total byte size of the segment's files.
[source] LogDocMergePolicy	This is a LogMergePolicy that measures size of a segment as the number of documents (not taking deletions into account).
[source] 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.
[source] MergeDocIDRemapper	Remaps docIDs after a merge has completed, where the merged segments had at least one deletion.
[source] MergePolicy	Expert: a MergePolicy determines the sequence of primitive merge operations to be used for overall merge and optimize operations.
[source] MergePolicy.MergeSpecification	A MergeSpecification instance provides the information necessary to perform multiple merges.
[source] MergePolicy.OneMerge	OneMerge provides the information necessary to perform an individual primitive merge operation, resulting in a single new segment.
[source] MergeScheduler	Expert: IndexWriter uses an instance implementing this interface to execute the merges selected by a MergePolicy.
[source] MockIndexInput
[source] MultiLevelSkipListReader	This abstract class reads skip lists with multiple levels.
[source] MultiLevelSkipListWriter	This abstract class writes skip lists with multiple levels.
[source] MultiPassIndexSplitter	This tool splits input index into multiple equal parts.
[source] MultiPassIndexSplitter.FakeDeleteIndexReader	This class pretends that it can write deletions to the underlying index.
[source] MultipleTermPositions	Allows you to iterate over the TermPositions for multiple Terms as a single TermPositions.
[source] MultiReader	An IndexReader which reads multiple indexes, appending their content.
[source] NormsWriter	Writes norms.
[source] NormsWriterPerField	Taps into DocInverter, as an InvertedDocEndConsumer, which is called at the end of inverting each field.
[source] NormsWriterPerThread	Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
[source] ParallelArrayTermVectorMapper	Models the existing parallel array structure
[source] ParallelReader	An IndexReader which reads multiple, parallel indexes.
[source] Payload	A Payload is metadata that can be stored together with each occurrence of a term.
[source] PositionBasedTermVectorMapper	For each Field, store position by position information.
[source] PositionBasedTermVectorMapper.TVPositionInfo	Container for a term at a position
[source] RawPostingList	This is the base class for an in-memory posting list, keyed by a Token.
[source] ReadOnlyDirectoryReader
[source] ReadOnlySegmentReader	Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
[source] RepeatingTokenStream
[source] ReusableStringReader	Used by DocumentsWriter to implemented a StringReader that can be reset to a new string; we use this when tokenizing the string value from a Field.
[source] SegmentInfo	Information about a segment such as it's name, directory, and files related to the segment.
[source] SegmentInfos	A collection of segmentInfo objects with methods for operating on those segments in relation to the file system.
[source] SegmentInfos.FindSegmentsFile	Utility class for executing code that needs to do something with the current segments file.
[source] SegmentMergeInfo
[source] SegmentMergeQueue
[source] SegmentMerger	The SegmentMerger class combines two or more Segments, represented by an IndexReader (SegmentMerger.add(org.apache.lucene.index.IndexReader), into a single Segment.
[source] SegmentMerger.CheckAbort
[source] SegmentReader	NOTE: This API is new and still experimental (subject to change suddenly in the next release)
[source] SegmentReader.CoreReaders
[source] SegmentReader.Ref
[source] SegmentTermDocs
[source] SegmentTermEnum
[source] SegmentTermPositions
[source] SegmentTermPositionVector	Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
[source] SegmentTermVector
[source] SegmentWriteState
[source] SerialMergeScheduler	A MergeScheduler that simply does each merge sequentially, using the current thread.
[source] SnapshotDeletionPolicy	A IndexDeletionPolicy that wraps around any other IndexDeletionPolicy and adds the ability to hold and later release a single "snapshot" of an index.
[source] SortedTermVectorMapper	Store a sorted collection of TermVectorEntrys.
[source] StoredFieldsWriter	This is a DocFieldConsumer that writes stored fields.
[source] StoredFieldsWriterPerThread
[source] Term	A Term represents a word from text.
[source] TermBuffer
[source] TermEnum	Abstract class for enumerating terms.
[source] TermInfo	A TermInfo is the record of information stored for a term.
[source] TermInfosReader	This stores a monotonically increasing set of pairs in a Directory.
[source] TermInfosWriter	This stores a monotonically increasing set of pairs in a Directory.
[source] TermsHash	This class implements InvertedDocConsumer, which is passed each token produced by the analyzer on each field.
[source] TermsHashConsumer
[source] TermsHashConsumerPerField
[source] TermsHashConsumerPerThread
[source] TermsHashPerField
[source] TermsHashPerThread
[source] TermVectorAccessor	Transparent access to the vector space model, either via TermFreqVector or by resolving it from the inverted index.
[source] TermVectorEntry	Convenience class for holding TermVector information.
[source] TermVectorEntryFreqSortedComparator	Compares TermVectorEntrys first by frequency and then by the term (case-sensitive)
[source] 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).
[source] TermVectorOffsetInfo	The TermVectorOffsetInfo class holds information pertaining to a Term in a TermPositionVector's offset information.
[source] TermVectorsReader
[source] TermVectorsTermsWriter
[source] TermVectorsTermsWriter.PostingList
[source] TermVectorsTermsWriterPerField
[source] TermVectorsTermsWriterPerThread
[source] TermVectorsWriter
[source] TestAddIndexesNoOptimize
[source] TestAtomicUpdate
[source] TestBackwardsCompatibility
[source] TestByteSlices
[source] TestCheckIndex
[source] TestCompoundFile
[source] TestConcurrentMergeScheduler
[source] TestCrash
[source] TestDeletionPolicy
[source] TestDirectoryReader
[source] TestDoc	JUnit adaptation of an older test case DocTest.
[source] TestDocumentWriter
[source] TestFieldInfos
[source] TestFieldNormModifier	Tests changing of field norms with a custom similarity and with fake norms.
[source] TestFieldsReader
[source] TestFieldsReader.FaultyFSDirectory
[source] TestFilterIndexReader
[source] TestIndexFileDeleter
[source] TestIndexInput
[source] TestIndexReader
[source] TestIndexReaderClone	Tests cloning multiple types of readers, modifying the deletedDocs and norms and verifies copy on write semantics of the deletedDocs and norms is implemented properly
[source] TestIndexReaderCloneNorms	Tests cloning IndexReader norms
[source] TestIndexReaderReopen
[source] TestIndexSplitter
[source] TestIndexWriter
[source] TestIndexWriterDelete
[source] TestIndexWriterExceptions
[source] TestIndexWriterLockRelease	This tests the patch for issue #LUCENE-715 (IndexWriter does not release its write lock when trying to open an index which does not yet exist).
[source] TestIndexWriterMergePolicy
[source] TestIndexWriterMerging
[source] TestIndexWriterReader
[source] TestIndexWriterReader.HeavyAtomicInt
[source] TestLazyBug	Test demonstrating EOF bug on the last field of the last doc if other docs have allready been accessed.
[source] TestLazyProxSkipping	Tests lazy skipping on the proximity file.
[source] TestMultiLevelSkipList	This testcase tests whether multi-level skipping is being used to reduce I/O while skipping through posting lists.
[source] TestMultiPassIndexSplitter
[source] TestMultiReader
[source] TestNorms	Test that norms info is preserved during index life - including separate norms, addDocument, addIndexesNoOptimize, optimize.
[source] TestNRTReaderWithThreads
[source] TestOmitTf
[source] TestOmitTf.CountingHitCollector
[source] TestOmitTf.SimpleSimilarity
[source] TestParallelReader
[source] TestParallelReaderEmptyIndex	Some tests for ParallelReaders with empty indexes
[source] TestParallelTermEnum
[source] TestPayloads
[source] TestPositionBasedTermVectorMapper
[source] TestSegmentMerger
[source] TestSegmentReader
[source] TestSegmentTermDocs
[source] TestSegmentTermEnum
[source] TestStressIndexing
[source] TestStressIndexing2
[source] TestStressIndexing2.DocsAndWriter
[source] TestTerm
[source] TestTermdocPerf
[source] TestTermVectorAccessor
[source] TestTermVectorsReader
[source] TestTermVectorsReader.DocNumAwareMapper
[source] TestThreadedOptimize
[source] TestTransactionRollback	Test class to illustrate using IndexDeletionPolicy to provide multi-level rollback capability.
[source] TestTransactions
[source] TestWordlistLoader

Exception Summary

Exception	Description
[source] CorruptIndexException	This exception is thrown when Lucene detects an inconsistency in the index.
[source] FieldReaderException
[source] MergePolicy.MergeAbortedException
[source] MergePolicy.MergeException	Exception thrown if there are any problems while executing a merge.
[source] 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.

Package org.apache.lucene.index Description

Code to maintain and access indices.