DotLucene 1.4 API Documentation |

# SegmentReader Methods

The methods of the SegmentReader class are listed below. For a complete list of SegmentReader class members, see the SegmentReader Members topic.

#### Public Instance Methods

Close (inherited from IndexReader) | Closes files associated with this index. Also saves any new deletions to disk. No other methods should be called after this has been called.
Delete (inherited from IndexReader) | Overloaded. Deletes the document numbered `docNum`. Once a document is deleted it will not appear in TermDocs or TermPostitions enumerations. Attempts to read its Field with the {@link .document} method will result in an error. The presence of this document may still be reflected in the {@link .docFreq} statistic, though this will be corrected eventually as the index is further modified.
Directory (inherited from IndexReader) | Returns the directory this index resides in.
DocFreq |
Document |
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetFieldNames | Overloaded.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetIndexedFieldNames |
GetTermFreqVector | Return a term frequency vector for the specified document and Field. The vector returned contains term numbers and frequencies for all terms in the specified Field of this document, if the Field had storeTermVector flag set. If the flag was not set, the method returns null.
GetTermFreqVectors | Return an array of term frequency vectors for the specified document. The array contains a vector for each vectorized Field in the document. Each vector vector contains term numbers and frequencies for all terms in a given vectorized Field. If no such fields existed, the method returns null.
GetType (inherited from Object) | Gets the Type of the current instance.
HasDeletions |
IsDeleted |
MaxDoc |
Norms | Overloaded. Read norms into a pre-allocated array.
NumDocs |
SetNorm (inherited from IndexReader) | Overloaded. Expert: Resets the normalization factor for the named Field of the named document.
TermDocs | Overloaded.
TermDocs (inherited from IndexReader) | Overloaded. Returns an unpositioned {@link TermDocs} enumerator.
TermPositions | Overloaded.
TermPositions (inherited from IndexReader) | Overloaded. Returns an unpositioned {@link TermPositions} enumerator.
Terms | Overloaded.
ToString (inherited from Object) | Returns a String that represents the current Object.
UndeleteAll (inherited from IndexReader) | Undeletes all documents currently marked as deleted in this index.

#### Protected Internal Instance Methods

Commit (inherited from IndexReader) | Commit changes resulting from delete, undeleteAll, or setNorm operations
DoClose |
DoCommit |
DoDelete |
DoSetNorm |
DoUndeleteAll |

#### See Also

SegmentReader Class | Lucene.Net.Index Namespace