The FilterIndexReader type exposes the following members.
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()()()() | (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 (Inherited from IndexReader.) CopyC#docNum |
| DeleteDocuments | Deletes all documents that have a given (Inherited from IndexReader.)CopyC#term |
| Directory | (Overrides IndexReader..::..Directory()()()().) |
| 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 (Inherited from IndexReader.)CopyC#n CopyC#Document |
| Document(Int32, FieldSelector) | (Overrides IndexReader..::..Document(Int32, FieldSelector).) |
| DoDelete | (Overrides IndexReader..::..DoDelete(Int32).) |
| DoSetNorm | (Overrides IndexReader..::..DoSetNorm(Int32, String, Byte).) |
| DoUndeleteAll | (Overrides IndexReader..::..DoUndeleteAll()()()().) |
| EnsureOpen | (Inherited from IndexReader.) |
| Equals | (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 |
If the subclass of FilteredIndexReader modifies the
deleted docs, you must override this method to provide
a different key */
(Overrides IndexReader..::..GetDeletesCacheKey()()()().) |
| 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 |
If the subclass of FilteredIndexReader modifies the
contents of the FieldCache, you must override this
method to provide a different key */
(Overrides IndexReader..::..GetFieldCacheKey()()()().) |
| 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 | (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 | (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()()()() | Refreshes an IndexReader if the index has changed since this instance
was (re)opened.
Opening an IndexReader is an expensive operation. This method can be used
to refresh an existing IndexReader to reduce these costs. This method
tries to only load segments that have changed or were created after the
IndexReader was (re)opened.
If the index has not changed since this instance was (re)opened, then this
call is a NOOP and returns this instance. Otherwise, a new instance is
returned. The old instance is not closed and remains usable. (Inherited from IndexReader.)If the reader is reopened, even though they share resources internally, it's safe to make changes (deletions, norms) with the new reader. All shared mutable state obeys "copy on write" semantics to ensure the changes are not seen by other readers. You can determine whether a reader was actually reopened by comparing the old instance with the instance returned by this method:
IndexReader reader = ...
...
IndexReader newReader = r.reopen();
if (newReader != reader) {
... // reader was reopened
reader.close();
}
reader = newReader;
...
Be sure to synchronize that code so that other threads,
if present, can never use reader after it has been
closed and before it's switched to newReader.
NOTE: If this reader is a near real-time
reader (obtained from {@link IndexWriter#GetReader()},
reopen() will simply call writer.getReader() again for
you, though this may change in the future.
|
| 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
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.
(Inherited from IndexReader.) |
| TermDocs()()()() | (Overrides IndexReader..::..TermDocs()()()().) |
| TermDocs(Term) | (Overrides IndexReader..::..TermDocs(Term).) |
| TermPositions()()()() | (Overrides IndexReader..::..TermPositions()()()().) |
| TermPositions(Term) | Returns an enumeration of all the documents which contain
(Inherited from IndexReader.)CopyC#term
|
| Terms()()()() | (Overrides IndexReader..::..Terms()()()().) |
| Terms(Term) | (Overrides IndexReader..::..Terms(Term).) |
| ToString | (Inherited from Object.) |
| UndeleteAll | Undeletes all documents currently marked as deleted in this index.
(Inherited from IndexReader.) |
