The MultiReader type exposes the following members.

Constructors

	Name	Description
	MultiReader(array<IndexReader>[]()[][])	Construct a MultiReader aggregating the named set of (sub)readers. Directory locking for delete, undeleteAll, and setNorm operations is left to the subreaders. Note that all subreaders are closed if this Multireader is closed.
	MultiReader(array<IndexReader>[]()[][], Boolean)	Construct a MultiReader aggregating the named set of (sub)readers. Directory locking for delete, undeleteAll, and setNorm operations is left to the subreaders.

Methods

	Name	Description
	AcquireWriteLock	Does nothing by default. Subclasses that require a write lock for index modifications must implement this method. (Inherited from IndexReader.)
	Clone()()()()	Clones the subreaders. (see {@link IndexReader#clone()}). If subreaders are shared, then the reference count of those readers is increased to ensure that the subreaders remain open until the last referring reader is closed. (Overrides IndexReader..::..Clone()()()().)
	Clone(Boolean)	Clones the IndexReader and optionally changes readOnly. A readOnly reader cannot open a writeable reader. (Inherited from IndexReader.)
	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. (Inherited from IndexReader.)
	Commit()()()()	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). (Inherited from IndexReader.)
	Commit(IDictionary<(Of <<'(String, String>)>>))	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). (Inherited from IndexReader.)
	DecRef	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. (Inherited from IndexReader.)
	DeleteDocument	Deletes the document numbered CopyC# 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. (Inherited from IndexReader.)
	DeleteDocuments	Deletes all documents that have a given CopyC# 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. (Inherited from IndexReader.)
	Directory	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. (Inherited from IndexReader.)
	Dispose	.NET (Inherited from IndexReader.)
	DocFreq	(Overrides IndexReader..::..DocFreq(Term).)
	DoClose	(Overrides IndexReader..::..DoClose()()()().)
	DoCommit()()()()	Obsolete. (Overrides IndexReader..::..DoCommit()()()().)
	DoCommit(IDictionary<(Of <<'(String, String>)>>))	(Overrides IndexReader..::..DoCommit(IDictionary<(Of <<'(String, String>)>>)).)
	Document(Int32)	Returns the stored fields of the CopyC# n ^th CopyC# Document in this index. NOTE: for performance reasons, this method does not check if the requested document is deleted, and therefore asking for a deleted document may yield unspecified results. Usually this is not required, however you can call {@link #IsDeleted(int)} with the requested document ID to verify the document is not deleted. (Inherited from IndexReader.)
	Document(Int32, FieldSelector)	(Overrides IndexReader..::..Document(Int32, FieldSelector).)
	DoDelete	(Overrides IndexReader..::..DoDelete(Int32).)
	DoReopen	If clone is true then we clone each of the subreaders
	DoSetNorm	(Overrides IndexReader..::..DoSetNorm(Int32, String, Byte).)
	DoUndeleteAll	(Overrides IndexReader..::..DoUndeleteAll()()()().)
	EnsureOpen	(Inherited from IndexReader.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	Flush()()()()	(Inherited from IndexReader.)
	Flush(IDictionary<(Of <<'(String, String>)>>))	(Inherited from IndexReader.)
	GetCommitUserData()()()()	Retrieve the String userData optionally passed to IndexWriter#commit. This will return null if {@link IndexWriter#Commit(Map)} has never been called for this index. (Inherited from IndexReader.)
	GetDeletesCacheKey	(Inherited from IndexReader.)
	GetDisableFakeNorms	Obsolete. Expert: Return the state of the flag that disables fakes norms in favor of representing the absence of field norms with null. (Inherited from IndexReader.)
	GetFieldCacheKey	Obsolete. Expert (Inherited from IndexReader.)
	GetFieldNames	(Overrides IndexReader..::..GetFieldNames(IndexReader..::..FieldOption).)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetIndexCommit	Expert: return the IndexCommit that this reader has opened. 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. (Inherited from IndexReader.)
	GetRefCount	Expert: returns the current refCount for this reader (Inherited from IndexReader.)
	GetSequentialSubReaders	(Overrides IndexReader..::..GetSequentialSubReaders()()()().)
	GetTermFreqVector(Int32, TermVectorMapper)	(Overrides IndexReader..::..GetTermFreqVector(Int32, TermVectorMapper).)
	GetTermFreqVector(Int32, String)	(Overrides IndexReader..::..GetTermFreqVector(Int32, String).)
	GetTermFreqVector(Int32, String, TermVectorMapper)	(Overrides IndexReader..::..GetTermFreqVector(Int32, String, TermVectorMapper).)
	GetTermFreqVectors	(Overrides IndexReader..::..GetTermFreqVectors(Int32).)
	GetTermInfosIndexDivisor	For IndexReader implementations that use TermInfosReader to read terms, this returns the current indexDivisor as specified when the reader was opened. (Inherited from IndexReader.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUniqueTermCount	Returns the number of unique terms (across all fields) in this reader. This method returns long, even though internally Lucene cannot handle more than 2^31 unique terms, for a possible future when this limitation is removed. (Inherited from IndexReader.)
	GetVersion	Not implemented. (Overrides IndexReader..::..GetVersion()()()().)
	HasDeletions	(Overrides IndexReader..::..HasDeletions()()()().)
	HasNorms	(Overrides IndexReader..::..HasNorms(String).)
	IncRef	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. (Inherited from IndexReader.)
	IsCurrent	Checks recursively if all subreaders are up to date. (Overrides IndexReader..::..IsCurrent()()()().)
	IsDeleted	(Overrides IndexReader..::..IsDeleted(Int32).)
	IsOptimized	(Overrides IndexReader..::..IsOptimized()()()().)
	MaxDoc	(Overrides IndexReader..::..MaxDoc()()()().)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Norms(String)	(Overrides IndexReader..::..Norms(String).)
	Norms(String, array<Byte>[]()[][], Int32)	(Overrides IndexReader..::..Norms(String, array<Byte>[]()[][], Int32).)
	NumDeletedDocs	Returns the number of deleted documents. (Inherited from IndexReader.)
	NumDocs	(Overrides IndexReader..::..NumDocs()()()().)
	Reopen()()()()	Tries to reopen the subreaders. If one or more subreaders could be re-opened (i. e. subReader.reopen() returned a new instance != subReader), then a new MultiReader instance is returned, otherwise this instance is returned. A re-opened instance might share one or more subreaders with the old instance. Index modification operations result in undefined behavior when performed before the old instance is closed. (see {@link IndexReader#Reopen()}). If subreaders are shared, then the reference count of those readers is increased to ensure that the subreaders remain open until the last referring reader is closed. (Overrides IndexReader..::..Reopen()()()().)
	Reopen(Boolean)	Just like {@link #Reopen()}, except you can change the readOnly of the original reader. If the index is unchanged but readOnly is different then a new reader will be returned. (Inherited from IndexReader.)
	Reopen(IndexCommit)	Expert: reopen this reader on a specific commit point. This always returns a readOnly reader. If the specified commit point matches what this reader is already on, and this reader is already readOnly, then this same instance is returned; if it is not already readOnly, a readOnly clone is returned. (Inherited from IndexReader.)
	SetDisableFakeNorms	Obsolete. Expert: Set the state of the flag that disables fakes norms in favor of representing the absence of field norms with null. (Inherited from IndexReader.)
	SetNorm(Int32, String, Byte)	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. NOTE: If this field does not store norms, then this method call will silently do nothing. (Inherited from IndexReader.)
	SetNorm(Int32, String, Single)	Expert: Resets the normalization factor for the named field of the named document. (Inherited from IndexReader.)
	SetTermInfosIndexDivisor	Obsolete. 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 NtermIndexInterval 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. (Inherited from IndexReader.)
	TermDocs()()()()	(Overrides IndexReader..::..TermDocs()()()().)
	TermDocs(Term)	Returns an enumeration of all the documents which contain CopyC# term . For each document, the document number, the frequency of the term in that document is also provided, for use in search scoring. If term is null, then all non-deleted docs are returned with freq=1. Thus, this method implements the mapping: Term => <docNum, freq>^* The enumeration is ordered by document number. Each document number is greater than all that precede it in the enumeration. (Inherited from IndexReader.)
	TermPositions()()()()	(Overrides IndexReader..::..TermPositions()()()().)
	TermPositions(Term)	Returns an enumeration of all the documents which contain CopyC# term . For each document, in addition to the document number and frequency of the term in that document, a list of all of the ordinal positions of the term in the document is available. Thus, this method implements the mapping: Term => <docNum, freq, <pos₁, pos₂, ... pos_freq-1> >^* This positional information facilitates phrase and proximity searching. The enumeration is ordered by document number. Each document number is greater than all that precede it in the enumeration. (Inherited from IndexReader.)
	Terms()()()()	(Overrides IndexReader..::..Terms()()()().)
	Terms(Term)	(Overrides IndexReader..::..Terms(Term).)
	ToString	Returns a String that represents the current Object. (Inherited from Object.)
	UndeleteAll	Undeletes all documents currently marked as deleted in this index. (Inherited from IndexReader.)

Fields

	Name	Description
	hasChanges	(Inherited from IndexReader.)
	subReaders

Properties

	Name	Description
	hasChanges_ForNUnit	(Inherited from IndexReader.)

Constructors

Methods

Fields

Properties

See Also