The ReadOnlyDirectoryReader type exposes the following members.

Methods

  NameDescription
Protected methodAcquireWriteLock (Overrides DirectoryReader..::..AcquireWriteLock()()()().)
Public methodClone()()()() (Inherited from DirectoryReader.)
Public methodClone(Boolean) (Inherited from DirectoryReader.)
Public methodClose
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.)
Public methodCommit()()()()
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.)
Public methodCommit(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.)
Public methodDecRef
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.)
Public methodDeleteDocument
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.)
Public methodDeleteDocuments
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.)
Public methodDirectory
Returns the directory this index resides in.
(Inherited from DirectoryReader.)
Public methodDispose
.NET
(Inherited from IndexReader.)
Public methodDocFreq (Inherited from DirectoryReader.)
Protected methodDoClose (Inherited from DirectoryReader.)
Protected methodDoCommit()()()() Obsolete. (Inherited from DirectoryReader.)
Protected methodDoCommit(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 DirectoryReader.)
Public methodDocument(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.)
Public methodDocument(Int32, FieldSelector) (Inherited from DirectoryReader.)
Protected methodDoDelete (Inherited from DirectoryReader.)
Protected methodDoSetNorm (Inherited from DirectoryReader.)
Protected methodDoUndeleteAll (Inherited from DirectoryReader.)
Protected methodEnsureOpen (Inherited from IndexReader.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFlush()()()()
(Inherited from IndexReader.)
Public methodFlush(IDictionary<(Of <<'(String, String>)>>)) (Inherited from IndexReader.)
Public methodGetCommitUserData (Inherited from DirectoryReader.)
Public methodGetDeletesCacheKey (Inherited from IndexReader.)
Public methodGetDisableFakeNorms 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.)
Public methodGetFieldCacheKey Obsolete.
Expert
(Inherited from IndexReader.)
Public methodGetFieldNames (Inherited from DirectoryReader.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetIndexCommit
Expert: return the IndexCommit that this reader has opened.

WARNING: this API is new and experimental and may suddenly change.

(Inherited from DirectoryReader.)
Public methodGetRefCount
Expert: returns the current refCount for this reader
(Inherited from IndexReader.)
Public methodGetSequentialSubReaders (Inherited from DirectoryReader.)
Public methodGetTermFreqVector(Int32, TermVectorMapper) (Inherited from DirectoryReader.)
Public methodGetTermFreqVector(Int32, String) (Inherited from DirectoryReader.)
Public methodGetTermFreqVector(Int32, String, TermVectorMapper) (Inherited from DirectoryReader.)
Public methodGetTermFreqVectors (Inherited from DirectoryReader.)
Public methodGetTermInfosIndexDivisor (Inherited from DirectoryReader.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUniqueTermCount
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.)
Public methodGetVersion
Version number when this IndexReader was opened.
(Inherited from DirectoryReader.)
Public methodHasDeletions (Inherited from DirectoryReader.)
Public methodHasNorms (Inherited from DirectoryReader.)
Public methodIncRef
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.)
Public methodIsCurrent (Inherited from DirectoryReader.)
Public methodIsDeleted (Inherited from DirectoryReader.)
Public methodIsOptimized
Checks is the index is optimized (if it has a single segment and no deletions)
(Inherited from DirectoryReader.)
Public methodMaxDoc (Inherited from DirectoryReader.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNorms(String) (Inherited from DirectoryReader.)
Public methodNorms(String, array<Byte>[]()[][], Int32) (Inherited from DirectoryReader.)
Public methodNumDeletedDocs
Returns the number of deleted documents.
(Inherited from IndexReader.)
Public methodNumDocs (Inherited from DirectoryReader.)
Public methodReopen()()()() (Inherited from DirectoryReader.)
Public methodReopen(Boolean) (Inherited from DirectoryReader.)
Public methodReopen(IndexCommit) (Inherited from DirectoryReader.)
Public methodSetDisableFakeNorms Obsolete. (Inherited from DirectoryReader.)
Public methodSetNorm(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.)
Public methodSetNorm(Int32, String, Single)
Expert: Resets the normalization factor for the named field of the named document.
(Inherited from IndexReader.)
Public methodSetTermInfosIndexDivisor 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.)
Public methodTermDocs()()()() (Inherited from DirectoryReader.)
Public methodTermDocs(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.)
Public methodTermPositions()()()() (Inherited from DirectoryReader.)
Public methodTermPositions(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, <pos1, pos2, ... posfreq-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.)
Public methodTerms()()()() (Inherited from DirectoryReader.)
Public methodTerms(Term) (Inherited from DirectoryReader.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodUndeleteAll
Undeletes all documents currently marked as deleted in this index.
(Inherited from IndexReader.)

See Also