Apache Lucene.Net 2.4.0 Class Library API

ParallelReader Members

ParallelReader overview

Public Instance Constructors

ParallelReader Overloaded. Initializes a new instance of the ParallelReader class.

Public Instance Methods

AddOverloaded. Add an IndexReader.
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 IndexReader) Returns the directory associated with this index. The Default implementation returns the directory specified by subclasses when delegating to the IndexReader(Directory) constructor, or throws an UnsupportedOperationException if one was not specified.
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 IndexReader) Expert: Return the IndexCommit that this reader has open. This method is only implemented by those readers that correspond to a Directory with its own segments_N file. WARNING: This API is new and experimental and may suddenly change.
GetRefCount (inherited from IndexReader) 
GetSubReaders 
GetTermFreqVectorOverloaded.  
GetTermFreqVectors 
GetTermInfosIndexDivisor (inherited from IndexReader) 
GetType (inherited from Object)Gets the Type of the current instance.
GetVersionNot implemented.
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 Checks recursively if all subreaders are up to date.
IsDeleted 
IsOptimized Checks recursively if all subindexes are optimized
MaxDoc 
NormsOverloaded.  
NumDeletedDocs (inherited from IndexReader) Returns the number of deleted docs.
NumDocs 
Reopen 
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 (inherited from IndexReader)For IndexReader implementations that use TermInfosReader to read terms, this sets the indexDivisor to subsample the number of indexed terms loaded into memory. This has the same effect as {@link IndexWriter#setTermIndexInterval} except that setting must be done at indexing time while this setting can be set per reader. When set to N, then one in every N*termIndexInterval terms in the index is loaded into memory. By setting this to a value > 1 you can reduce memory usage, at the expense of higher latency when loading a TermInfo. The default value is 1. NOTE: you must call this before the term index is loaded. If the index is already loaded, an IllegalStateException is thrown.
TermDocsOverloaded.  
TermPositionsOverloaded.  
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 Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

Protected Internal Instance Fields

hasChanges (inherited from IndexReader) 

Protected Internal Instance Methods

AcquireWriteLock (inherited from IndexReader)Does nothing by default. Subclasses that require a write lock for index modifications must implement this method.
DoClose 
DoCommit 
DoDelete 
DoSetNorm 
DoUndeleteAll 

See Also

ParallelReader Class | Lucene.Net.Index Namespace