Home » lucene-3.0.1-src » org.apache » lucene » index »

org.apache.lucene.index

Sub Packages:

org.apache.lucene.index.memory   High-performance single-document main memory Apache Lucene fulltext search index.  
org.apache.lucene.index.store    

Interfaces:

IndexCommitPoint     code | html
IndexDeletionPolicy  

Expert: policy for deletion of stale index commits

code | html
TermDocs   TermDocs provides an interface for enumerating <document, frequency> pairs for a term.  code | html
TermFreqVector   Provides access to stored term vector of a document field.  code | html
TermPositionVector   Extends TermFreqVector to provide additional information about positions in which each of the terms is found.  code | html
TermPositions   TermPositions provides an interface for enumerating the <document, frequency, <position>* > tuples for a term.  code | html

Abstract Classes:

AbstractAllTermDocs   Base class for enumerating all but deleted docs.  code | html
ByteBlockPool.Allocator     code | html
DirectoryIndexReader   IndexReader implementation that has access to a Directory.  code | html
DocConsumer   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
DocConsumerPerThread   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
DocFieldConsumer   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
DocFieldConsumerPerField   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
DocFieldConsumerPerThread   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
DocumentsWriter.DocWriter   Consumer returns this on each doc.  code | html
DocumentsWriter.IndexingChain   The IndexingChain must define the #getChain(DocumentsWriter) method which returns the DocConsumer that the DocumentsWriter calls to process the documents.  code | html
FormatPostingsDocsConsumer   NOTE: this API is experimental and will likely change  code | html
FormatPostingsFieldsConsumer   Abstract API that consumes terms, doc, freq, prox and payloads postings.  code | html
FormatPostingsPositionsConsumer   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
FormatPostingsTermsConsumer   NOTE: this API is experimental and will likely change  code | html
IndexCommit  

Expert: represents a single commit into an index as seen by the IndexDeletionPolicy or IndexReader .

Changes to the content of an index are made visible only after the writer who made that change commits by writing a new segments file (segments_N). 

code | html
IndexReader   IndexReader is an abstract class, providing an interface for accessing an index.  code | html
IndexWriter.IndexReaderWarmer   If #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.  code | html
InvertedDocConsumer   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
InvertedDocConsumerPerField   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
InvertedDocConsumerPerThread   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
InvertedDocEndConsumer   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
InvertedDocEndConsumerPerField   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
InvertedDocEndConsumerPerThread   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
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. 

code | html
MergePolicy  

Expert: a MergePolicy determines the sequence of primitive merge operations to be used for overall merge and optimize operations.

Whenever the segments in an index have been altered by IndexWriter , either the addition of a newly flushed segment, addition of many segments from addIndexes* calls, or a previous merge that may now need to cascade, IndexWriter invokes #findMerges to give the MergePolicy a chance to pick merges that are now required. 

code | html
MergeScheduler  

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

code | html
MultiLevelSkipListReader   This abstract class reads skip lists with multiple levels.  code | html
MultiLevelSkipListWriter   This abstract class writes skip lists with multiple levels.  code | html
RawPostingList   This is the base class for an in-memory posting list, keyed by a Token.  code | html
SegmentInfos.FindSegmentsFile   Utility class for executing code that needs to do something with the current segments file.  code | html
TermEnum   Abstract class for enumerating terms.  code | html
TermVectorMapper   The TermVectorMapper can be used to map Term Vectors into your own structure instead of the parallel array structure used by org.apache.lucene.index.IndexReader#getTermFreqVector(int,String) code | html
TermsHashConsumer   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
TermsHashConsumerPerField   Implement this class to plug into the TermsHash processor, which inverts & stores Tokens into a hash table and provides an API for writing bytes into multiple streams for each unique Token.  code | html
TermsHashConsumerPerThread   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html

Classes:

AllTermDocs   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
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.  code | html
BalancedSegmentMergePolicy.MergePolicyParams     code | html
BufferedDeletes   Holds buffered deletes, by docID, term or query.  code | html
BufferedDeletes.Num     code | html
ByteBlockPool   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
ByteSliceReader   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
ByteSliceWriter   Class to write byte streams into slices of shared byte[].  code | html
CharBlockPool   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
CheckIndex   Basic tool and API to check the health of an index and write a new segments file that removes reference to problematic segments.  code | html
CheckIndex.MySegmentTermDocs     code | html
CheckIndex.Status   Returned from #checkIndex() detailing the health and status of the index.  code | html
CheckIndex.Status.FieldNormStatus   Status from testing field norms.  code | html
CheckIndex.Status.SegmentInfoStatus   Holds the status of each segment in the index.  code | html
CheckIndex.Status.StoredFieldStatus   Status from testing stored fields.  code | html
CheckIndex.Status.TermIndexStatus   Status from testing term index.  code | html
CheckIndex.Status.TermVectorStatus   Status from testing stored fields.  code | html
CompoundFileReader   Class for accessing a compound stream.  code | html
CompoundFileReader.CSIndexInput   Implementation of an IndexInput that reads from a portion of the compound file.  code | html
CompoundFileReader.FileEntry     code | html
CompoundFileWriter   Combines multiple files into a single compound file.  code | html
CompoundFileWriter.FileEntry     code | html
ConcurrentMergeScheduler   A MergeScheduler that runs each merge using a separate thread, up until a maximum number of threads (#setMaxThreadCount ) at which when a merge is needed, the thread(s) that are updating the index will pause until one or more merges completes.  code | html
ConcurrentMergeScheduler.MergeThread     code | html
CorruptIndexException   This exception is thrown when Lucene detects an inconsistency in the index.  code | html
DefaultSkipListReader   Implements the skip list reader for the default posting list format that stores positions and payloads.  code | html
DefaultSkipListWriter   Implements the skip list writer for the default posting list format that stores positions and payloads.  code | html
DirectoryIndexReader.ReaderCommit     code | html
DirectoryReader   An IndexReader which reads indexes with multiple segments.  code | html
DirectoryReader.MultiTermDocs     code | html
DirectoryReader.MultiTermEnum     code | html
DirectoryReader.MultiTermPositions     code | html
DirectoryReader.ReaderCommit     code | html
DocFieldConsumers   This is just a "splitter" class: it lets you wrap two DocFieldConsumer instances as a single consumer.  code | html
DocFieldConsumers.PerDoc     code | html
DocFieldConsumersPerField   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
DocFieldConsumersPerThread   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
DocFieldProcessor   This is a DocConsumer that gathers all fields under the same name, and calls per-field consumers to process field by field.  code | html
DocFieldProcessorPerField   Holds all per thread, per field state.  code | html
DocFieldProcessorPerThread   Gathers all Fieldables for a document under the same name, updates FieldInfos, and calls per-field consumers to process field by field.  code | html
DocFieldProcessorPerThread.PerDoc     code | html
DocHelper     code | html
DocInverter   This is a DocFieldConsumer that inverts each field, separately, from a Document, and accepts a InvertedTermsConsumer to process those terms.  code | html
DocInverterPerField   Holds state for inverting all occurrences of a single field in the document.  code | html
DocInverterPerThread   This is a DocFieldConsumer that inverts each field, separately, from a Document, and accepts a InvertedTermsConsumer to process those terms.  code | html
DocInverterPerThread.SingleTokenAttributeSource     code | html
DocTest   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
DocumentWriter   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
DocumentsWriter   This class accepts multiple added documents and directly writes a single segment file.  code | html
DocumentsWriter.ByteBlockAllocator     code | html
DocumentsWriter.DocState     code | html
DocumentsWriter.SkipDocWriter     code | html
DocumentsWriter.WaitQueue     code | html
DocumentsWriterThreadState   Used by DocumentsWriter to maintain per-thread state.  code | html
FieldInfo   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
FieldInfos   Access to the Fieldable Info file that describes document fields and whether or not they are indexed.  code | html
FieldInvertState   This class tracks the number and position / offset parameters of terms being added to the index.  code | html
FieldNormModifier   Given a directory and a list of fields, updates the fieldNorms in place for every document.  code | html
FieldReaderException     code | html
FieldSortedTermVectorMapper   For each Field, store a sorted collection of TermVectorEntry s

This is not thread-safe. 

code | html
FieldsReader   Class responsible for access to stored document fields.  code | html
FieldsReader.LazyField   A Lazy implementation of Fieldable that differs loading of fields until asked for, instead of when the Document is loaded.  code | html
FieldsWriter   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
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.  code | html
FilterIndexReader.FilterTermDocs   Base class for filtering TermDocs implementations.  code | html
FilterIndexReader.FilterTermEnum   Base class for filtering TermEnum implementations.  code | html
FilterIndexReader.FilterTermPositions   Base class for filtering TermPositions implementations.  code | html
FormatPostingsDocsWriter   Consumes doc & freq, writing them using the current index file format  code | html
FormatPostingsFieldsWriter   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
FormatPostingsPositionsWriter   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
FormatPostingsTermsWriter   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
FreqProxFieldMergeState   Used by DocumentsWriter to merge the postings from multiple ThreadStates when creating a segment  code | html
FreqProxTermsWriter   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
FreqProxTermsWriter.PostingList     code | html
FreqProxTermsWriterPerField   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
FreqProxTermsWriterPerThread   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
GCJSegmentReader   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
GCJTermDocs   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
IndexFileDeleter   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
IndexFileDeleter.CommitPoint   Holds details for each commit point.  code | html
IndexFileDeleter.RefCount   Tracks the reference count for a single index file:  code | html
IndexFileNameFilter   Filename filter that accept filenames and extensions only created by Lucene.  code | html
IndexFileNames   Useful constants representing filenames and extensions used by lucene  code | html
IndexModifier  

[Note that as of 2.1, all but one of the methods in this class are available via IndexWriter

code | html
IndexReader.FieldOption   Constants describing field properties, for example used for IndexReader#getFieldNames(FieldOption) code | html
IndexSplitter   Command-line tool that enables listing segments in an index, copying specific segments to another index, and deleting segments from an index.  code | html
IndexWriter   An IndexWriter creates and maintains an index.  code | html
IndexWriter.MaxFieldLength   Specifies maximum field length (in number of tokens/terms) in IndexWriter constructors.  code | html
IndexWriter.ReaderPool   Holds shared SegmentReader instances.  code | html
IntBlockPool   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
KeepOnlyLastCommitDeletionPolicy   This IndexDeletionPolicy implementation that keeps only the most recent commit and immediately removes all prior commits after a new commit is done.  code | html
LogByteSizeMergePolicy   This is a LogMergePolicy that measures size of a segment as the total byte size of the segment's files.  code | html
LogDocMergePolicy   This is a LogMergePolicy that measures size of a segment as the number of documents (not taking deletions into account).  code | html
MergeDocIDRemapper   Remaps docIDs after a merge has completed, where the merged segments had at least one deletion.  code | html
MergePolicy.MergeAbortedException     code | html
MergePolicy.MergeException   Exception thrown if there are any problems while executing a merge.  code | html
MergePolicy.MergeSpecification   A MergeSpecification instance provides the information necessary to perform multiple merges.  code | html
MergePolicy.OneMerge   OneMerge provides the information necessary to perform an individual primitive merge operation, resulting in a single new segment.  code | html
MockInputStream   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
MultiLevelSkipListReader.SkipBuffer   used to buffer the top skip levels  code | html
MultiPassIndexSplitter   This tool splits input index into multiple equal parts.  code | html
MultiPassIndexSplitter.FakeDeleteIndexReader   This class pretends that it can write deletions to the underlying index.  code | html
MultiReader   An IndexReader which reads multiple indexes, appending their content.  code | html
MultiSegmentReader   An IndexReader which reads indexes with multiple segments.  code | html
MultiSegmentReader.MultiTermDocs     code | html
MultiSegmentReader.MultiTermEnum     code | html
MultiSegmentReader.MultiTermPositions     code | html
MultipleTermPositions   Allows you to iterate over the TermPositions for multiple Term s as a single TermPositions code | html
MultipleTermPositions.IntQueue     code | html
MultipleTermPositions.TermPositionsQueue     code | html
NormsWriter   Writes norms.  code | html
NormsWriterPerField   Taps into DocInverter, as an InvertedDocEndConsumer, which is called at the end of inverting each field.  code | html
NormsWriterPerThread   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
ParallelArrayTermVectorMapper   Models the existing parallel array structure  code | html
ParallelReader   An IndexReader which reads multiple, parallel indexes.  code | html
ParallelReader.ParallelTermDocs     code | html
ParallelReader.ParallelTermEnum     code | html
ParallelReader.ParallelTermPositions     code | html
Payload   A Payload is metadata that can be stored together with each occurrence of a term.  code | html
PositionBasedTermVectorMapper   For each Field, store position by position information.  code | html
PositionBasedTermVectorMapper.TVPositionInfo   Container for a term at a position  code | html
Posting     code | html
ReadOnlyDirectoryReader   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
ReadOnlyMultiSegmentReader   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
ReadOnlySegmentReader   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
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.  code | html
SegmentInfo   Information about a segment such as it's name, directory, and files related to the segment.  code | html
SegmentInfos   A collection of segmentInfo objects with methods for operating on those segments in relation to the file system.  code | html
SegmentMergeInfo   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
SegmentMergeQueue   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
SegmentMerger   The SegmentMerger class combines two or more Segments, represented by an IndexReader (#add , into a single Segment.  code | html
SegmentMerger.CheckAbort     code | html
SegmentReader  

NOTE: This API is new and still experimental (subject to change suddenly in the next release)

 
code | html
SegmentReader.CoreReaders     code | html
SegmentReader.FieldsReaderLocal   Sets the initial value  code | html
SegmentReader.Norm   Byte[] referencing is used because a new norm object needs to be created for each clone, and the byte array is all that is needed for sharing between cloned readers.  code | html
SegmentReader.Ref     code | html
SegmentTermDocs   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
SegmentTermEnum   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
SegmentTermPositionVector   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
SegmentTermPositions   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
SegmentTermVector   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
SegmentWriteState   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
SerialMergeScheduler   A MergeScheduler that simply does each merge sequentially, using the current thread.  code | html
SnapshotDeletionPolicy   A IndexDeletionPolicy that wraps around any other IndexDeletionPolicy and adds the ability to hold and later release a single "snapshot" of an index.  code | html
SnapshotDeletionPolicy.MyCommitPoint     code | html
SortedTermVectorMapper   Store a sorted collection of org.apache.lucene.index.TermVectorEntry s.  code | html
StaleReaderException   This exception is thrown when an IndexReader tries to make changes to the index (via IndexReader#deleteDocument , IndexReader#undeleteAll or IndexReader#setNorm ) but changes have already been committed to the index since this reader was instantiated.  code | html
StoredFieldsWriter   This is a DocFieldConsumer that writes stored fields.  code | html
StoredFieldsWriter.PerDoc     code | html
StoredFieldsWriterPerField   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
StoredFieldsWriterPerThread   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
Term   A Term represents a word from text.  code | html
TermBuffer   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
TermInfo   A TermInfo is the record of information stored for a term.  code | html
TermInfosReader   This stores a monotonically increasing set of pairs in a Directory.  code | html
TermInfosReader.ThreadResources   Per-thread resources managed by ThreadLocal  code | html
TermInfosTest   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
TermInfosWriter   This stores a monotonically increasing set of pairs in a Directory.  code | html
TermVectorAccessor   Transparent access to the vector space model, either via TermFreqVector or by resolving it from the inverted index.  code | html
TermVectorAccessor.TermVectorMapperDecorator     code | html
TermVectorEntry   Convenience class for holding TermVector information.  code | html
TermVectorEntryFreqSortedComparator   Compares org.apache.lucene.index.TermVectorEntry s first by frequency and then by the term (case-sensitive)  code | html
TermVectorOffsetInfo   The TermVectorOffsetInfo class holds information pertaining to a Term in a org.apache.lucene.index.TermPositionVector 's offset information.  code | html
TermVectorsReader   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
TermVectorsTermsWriter   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
TermVectorsTermsWriter.PerDoc     code | html
TermVectorsTermsWriter.PostingList     code | html
TermVectorsTermsWriterPerField   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
TermVectorsTermsWriterPerThread   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
TermVectorsWriter   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
TermsHash   This class implements InvertedDocConsumer , which is passed each token produced by the analyzer on each field.  code | html
TermsHashPerField   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
TermsHashPerThread   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
TestFilterIndexReader.TestReader     code | html
TestFilterIndexReader.TestReader.TestTermEnum   Filter that only permits terms containing 'e'.  code | html
TestFilterIndexReader.TestReader.TestTermPositions   Filter that only returns odd numbered documents.  code | html

All Test Cases:

TestCompoundFile     code | html
TestDoc   JUnit adaptation of an older test case DocTest.  code | html
TestDocumentWriter   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
TestFieldInfos     code | html
TestFieldsReader   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
TestFilterIndexReader   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
TestIndexReader   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
TestIndexWriter     code | html
TestInputStream   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
TestMultiReader   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
TestSegmentMerger   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
TestSegmentReader   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
TestSegmentTermDocs   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
TestSegmentTermEnum     code | html
TestTermVectorsReader     code | html
TestTermVectorsWriter   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html