Apache Lucene.Net 2.4.0 Class Library API

MultiSegmentReader Methods

The methods of the MultiSegmentReader class are listed below. For a complete list of MultiSegmentReader class members, see the MultiSegmentReader 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.
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).
DecRef (inherited from IndexReader) Expert: decreases the refCount of this IndexReader instance. If the refCount drops to 0, then pending changes (if any) are committed to the index and this reader is closed.
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 DirectoryIndexReader)Returns the directory this index resides in.
DocFreq 
DocumentOverloaded.  
Document (inherited from IndexReader)Overloaded. Returns the stored fields of the
n
th
Document
in this index.
EnsureOpen (inherited from IndexReader) 
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
Flush (inherited from IndexReader)
GetFieldNames 
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetIndexCommit (inherited from DirectoryIndexReader) 
GetRefCount (inherited from IndexReader) 
GetSubReaders 
GetTermFreqVectorOverloaded.  
GetTermFreqVectors 
GetTermInfosIndexDivisor 
GetType (inherited from Object)Gets the Type of the current instance.
GetVersion (inherited from DirectoryIndexReader) Version number when this IndexReader was opened.
HasDeletions 
HasNorms 
IncRef (inherited from IndexReader) Expert: increments the refCount of this IndexReader instance. RefCounts are used to determine when a reader can be closed safely, i.e. as soon as there are no more references. Be sure to always call a corresponding {@link #decRef}, in a finally clause; otherwise the reader may never be closed. Note that {@link #close} simply calls decRef(), which means that the IndexReader will not really be closed until {@link #decRef} has been called for all outstanding references.
IsCurrent (inherited from DirectoryIndexReader) Check whether this IndexReader is still using the current (i.e., most recently committed) version of the index. If a writer has committed any changes to the index since this reader was opened, this will return
false
, in which case you must open a new IndexReader in order to see the changes. See the description of the
autoCommit
flag which controls when the {@link IndexWriter} actually commits changes to the index.
IsDeleted 
IsOptimized 
MaxDoc 
NormsOverloaded.  
NumDeletedDocs (inherited from IndexReader) Returns the number of deleted docs.
NumDocs 
Reopen (inherited from DirectoryIndexReader) 
SetDeletionPolicy (inherited from DirectoryIndexReader) 
SetNorm (inherited from IndexReader)Overloaded. Expert: Resets the normalization factor for the named field of the named document. The norm represents the product of the field's {@link Lucene.Net.Documents.Fieldable#SetBoost(float) boost} and its {@link Similarity#LengthNorm(String, int) length normalization}. Thus, to preserve the length normalization values when resetting this, one should base the new value upon the old.
SetTermInfosIndexDivisor 
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 DirectoryIndexReader)Release the write lock, if needed.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

Protected Internal Instance Methods

AcquireWriteLock (inherited from DirectoryIndexReader) Tries to acquire the WriteLock on this directory. this method is only valid if this IndexReader is directory owner.
CommitChanges 
DoClose 
DoCommit (inherited from DirectoryIndexReader) 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).
DoDelete 
DoReopen 
DoSetNorm 
DoUndeleteAll 

See Also

MultiSegmentReader Class | Lucene.Net.Index Namespace