DotLucene 1.4 API Documentation |

# Lucene.Net.Index Namespace

Namespace hierarchy

### Classes

Class | Description
--- | ---
CompoundFileReader | Class for accessing a compound stream. This class implements a directory, but is limited to only read operations. Directory methods that would normally modify data throw an exception.
CompoundFileReader.CSInputStream | Implementation of an InputStream that reads from a portion of the compound file. The visibility is left as "package" *only* because this helps with testing since JUnit test cases in a different class can then access package fields of this class.
CompoundFileWriter |
DocumentWriter |
FieldInfo |
FieldInfos | Access to the Field Info file that describes document fields and whether or not they are indexed. Each segment has a separate Field Info file. Objects of this class are thread-safe for multiple readers, but only one thread can be adding documents at a time, with no other reader or writer threads accessing this object.
FieldsReader | Class responsible for access to stored document fields. It uses <segment>.fdt and <segment>.fdx; files.
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. The class `FilterIndexReader` itself simply implements all abstract methods of `IndexReader` with versions that pass all requests to the contained index reader. Subclasses of `FilterIndexReader` may further override some of these methods and may also provide additional methods and fields.
FilterIndexReader.FilterTermDocs | Base class for filtering {@link TermDocs} implementations.
FilterIndexReader.FilterTermEnum | Base class for filtering {@link TermEnum} implementations.
FilterIndexReader.FilterTermPositions | Base class for filtering {@link TermPositions} implementations.
IndexReader |
IndexWriter | An IndexWriter creates and maintains an index. The third argument to the constructor determines whether a new index is created, or whether an existing index is opened for the addition of new documents. In either case, documents are added with the addDocument method. When finished adding documents, close should be called. If an index will not have more documents added for a while and optimal search performance is desired, then the optimize method should be called before the index is closed.
MultipleTermPositions | Describe class `MultipleTermPositions` here.
MultiReader | An IndexReader which reads multiple indexes, appending their content.
SegmentInfo |
SegmentInfos |
SegmentMerger |
SegmentReader | FIXME: Describe class `SegmentReader` here.
SegmentTermDocs |
SegmentTermEnum |
Term | A Term represents a word from text. This is the unit of search. It is composed of two elements, the text of the word, as a string, and the name of the Field that the text occured in, an interned string. Note that terms may represent more than words from text fields, but also things like dates, email addresses, urls, etc.
TermEnum |
TermInfo | A TermInfo is the record of information stored for a term.
TermInfosReader |
TermInfosWriter |
TermVectorsReader | TODO: relax synchro!
TermVectorsWriter | Writer works by opening a document and then opening the fields within the document and then writing out the vectors for each Field. Rough usage: `for each document { writer.openDocument(); for each Field on the document { writer.openField(Field); for all of the terms { writer.addTerm(...) } writer.closeField } writer.closeDocument() }`

### Interfaces

Interface | Description
--- | ---
TermDocs |
TermFreqVector | Provides access to stored term vector of a document Field.
TermPositions |
TermPositionVector | Extends `TermFreqVector` to provide additional information about positions in which each of the terms is found.