DotLucene 1.4 API Documentation |

# IndexReader Members

IndexReader overview

#### Public Static Methods

GetCurrentVersion | Overloaded. Reads version number from segments files. The version number counts the number of changes of the index.
IndexExists | Overloaded. Returns `true` if an index exists at the specified directory. If the directory does not exist or if there is no index in it. `false` is returned.
IsLocked | Overloaded. Returns `true` iff the index in the named directory is currently locked.
LastModified | Overloaded. Returns the time the index in the named directory was last modified. Synchronization of IndexReader and IndexWriter instances is no longer done via time stamps of the segments file since the time resolution depends on the hardware platform. Instead, a version number is maintained within the segments file, which is incremented everytime when the index is changed.
Open | Overloaded. Returns an IndexReader reading the index in an FSDirectory in the named path.
Unlock |

#### Public Instance Methods

Close | 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 | 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 | Returns the directory this index resides in.
DocFreq | Returns the number of documents containing the term `t`.
Document | Returns the stored fields of the `n`th `Document` in this index.
Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
GetFieldNames | Overloaded. Returns a list of all unique Field names that exist in the index pointed to by this IndexReader. The boolean argument specifies whether the fields returned are indexed or not.
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 terms and frequencies for those 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 contains terms 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 | Returns true if any documents have been deleted
IsDeleted | Returns true if document n has been deleted
MaxDoc | Returns one greater than the largest possible document number. This may be used to, e.g., determine how big to allocate an array which will have an element for every document number in an index.
Norms | Overloaded. Reads the byte-encoded normalization factor for the named Field of every document. This is used by the search code to score documents.
NumDocs | Returns the number of documents in this index.
SetNorm | Overloaded. Expert: Resets the normalization factor for the named Field of the named document.
TermDocs | Overloaded. Returns an unpositioned {@link TermDocs} enumerator.
TermPositions | Overloaded. Returns an unpositioned {@link TermPositions} enumerator.
Terms | Overloaded. Returns an enumeration of all terms after a given term. The enumeration is ordered by Term.compareTo(). Each term is greater than all that precede it in the enumeration.
ToString (inherited from Object) | Returns a String that represents the current Object.
UndeleteAll | Undeletes all documents currently marked as deleted in this index.

#### Protected Instance Methods

Finalize | Release the write lock, if needed.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.

#### Protected Internal Instance Constructors

IndexReader Constructor | Constructor used if IndexReader is not owner of its directory. This is used for IndexReaders that are used within other IndexReaders that take care or locking directories.

#### Protected Internal Instance Methods

Commit | Commit changes resulting from delete, undeleteAll, or setNorm operations
DoClose | Implements close.
DoCommit | Implements commit.
DoDelete | Implements deletion of the document numbered `docNum`. Applications should call {@link .Delete(int)} or {@link .Delete(Term)}.
DoSetNorm | Implements setNorm in subclass.
DoUndeleteAll | Implements actual undeleteAll() in subclass.

#### See Also

IndexReader Class | Lucene.Net.Index Namespace