Apache Lucene.Net 2.1 Class Library API

MultiReader Methods

The methods of the MultiReader class are listed below. For a complete list of MultiReader class members, see the MultiReader 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.
DeleteDocument (inherited from IndexReader)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.
DeleteDocuments (inherited from IndexReader)Deletes all documents that have a given
term
indexed. This is useful if one uses a document field to hold a unique ID string for the document. Then to delete such a document, one merely constructs a term with the appropriate field and the unique ID string as its text and passes it to this method. See {@link #DeleteDocument(int)} for information about when this deletion will become effective.
Directory (inherited from IndexReader)Returns the directory this index resides in.
DocFreq 
DocumentOverloaded.  
Document (inherited from IndexReader)Overloaded. Get the {@link Lucene.Net.Documents.Document} at the
n
th position. The {@link Lucene.Net.Documents.FieldSelector} may be used to determine what {@link Lucene.Net.Documents.Field}s to load and how they should be loaded. NOTE: If this Reader (more specifically, the underlying {@link FieldsReader} is closed before the lazy {@link Lucene.Net.Documents.Field} is loaded an exception may be thrown. If you want the value of a lazy {@link Lucene.Net.Documents.Field} to be available after closing you must explicitly load it or fetch the Document again with a new loader.
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
GetFieldNames 
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.
GetTermFreqVector 
GetTermFreqVectorsReturn 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.
GetVersion (inherited from IndexReader) Version number when this IndexReader was opened.
HasDeletions 
HasNorms 
IsCurrent (inherited from IndexReader) Check whether this IndexReader still works on a current version of the index. If this is not the case you will need to re-open the IndexReader to make sure you see the latest changes made to the index.
IsDeleted 
IsOptimized (inherited from IndexReader) Checks is the index is optimized (if it has a single segment and no deletions)
MaxDoc 
NormsOverloaded.  
NumDocs 
SetNorm (inherited from IndexReader)Overloaded. Expert: Resets the normalization factor for the named field of the named document.
TermDocsOverloaded.  
TermDocs (inherited from IndexReader)Overloaded. Returns an unpositioned {@link TermDocs} enumerator.
TermPositionsOverloaded.  
TermPositions (inherited from IndexReader)Overloaded. Returns an unpositioned {@link TermPositions} enumerator.
TermsOverloaded.  
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 Instance Methods

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

Protected Internal Instance Methods

Commit (inherited from IndexReader) Commit changes resulting from delete, undeleteAll, or setNorm operations If an exception is hit, then either no changes or all changes will have been committed to the index (transactional semantics).
DoClose 
DoCommit 
DoDelete 
DoSetNorm 
DoUndeleteAll 
GetDeleter (inherited from IndexReader) 
SetDeleter 

See Also

MultiReader Class | Lucene.Net.Index Namespace