FilterIndexReader

Construct a FilterIndexReader based on the specified base reader. Directory locking for delete, undeleteAll, and setNorm operations is left to the base reader.

Note that base reader is closed if this FilterIndexReader is closed.

Expert: adds a IndexReader.ReaderFinishedListener. The provided listener is also added to any sub-readers, if this is a composite reader. Also, any reader reopened or cloned from this one will also copy the listeners at the time of reopen.

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.

Returns the number of documents containing the term t.

Get the Document at the n ^th position. The FieldSelector may be used to determine what Fields to load and how they should be loaded. NOTE: If this Reader (more specifically, the underlying FieldsReader) is closed before the lazy Field is loaded an exception may be thrown. If you want the value of a lazy Field to be available after closing you must explicitly load it or fetch the Document again with a new loader.

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 isDeleted(int) with the requested document ID to verify the document is not deleted.

If the subclass of FilteredIndexReader modifies the contents of the FieldCache, you must override this method to provide a different key

If the subclass of FilteredIndexReader modifies the deleted docs, you must override this method to provide a different key

Get a list of unique field names that exist in this index and have the specified field option information.

Expert: returns the sequential sub readers that this reader is logically composed of. For example, IndexSearcher uses this API to drive searching by one sub reader at a time. If this reader is not composed of sequential child readers, it should return null. If this method returns an empty array, that means this reader is a null reader (for example a MultiReader that has no sub readers).

NOTE: You should not try using sub-readers returned by this method to make any changes (setNorm, deleteDocument, etc.). While this might succeed for one composite reader (like MultiReader), it will most likely lead to index corruption for other readers (like DirectoryReader obtained through open(IndexCommit, boolean). Use the parent reader directly.

Load the Term Vector into a user-defined data structure instead of relying on the parallel arrays of the TermFreqVector.

Map all the term vectors for all fields in a Document

Return a term frequency vector for the specified document and field. The returned vector contains terms and frequencies for the terms in the specified field of this document, if the field had the storeTermVector flag set. If termvectors had been stored with positions or offsets, a TermPositionVector is returned.

Return an array of term frequency vectors for the specified document. The array contains a vector for each vectorized field in the document. Each vector contains terms and frequencies for all terms in a given vectorized field. If no such fields existed, the method returns null. The term vectors that are returned may either be of type TermFreqVector or of type TermPositionVector if positions or offsets have been stored.

Version number when this IndexReader was opened. Not implemented in the IndexReader base class.

If this reader is based on a Directory (ie, was created by calling open(IndexCommit, boolean), or reopen() on a reader based on a Directory), then this method returns the version recorded in the commit that the reader opened. This version is advanced every time commit() is called.

If instead this reader is a near real-time reader (ie, obtained by a call to getReader(), or by calling reopen() on a near real-time reader), then this method returns the version of the last commit done by the writer. Note that even as further changes are made with the writer, the version will not changed until a commit is completed. Thus, you should not rely on this method to determine when a near real-time reader should be opened. Use isCurrent() instead.

Returns true if any documents have been deleted

Returns true if there are norms stored for this field.

Check whether any new changes have occurred to the index since this reader was opened.

If this reader is based on a Directory (ie, was created by calling open(IndexCommit, boolean), or reopen() on a reader based on a Directory), then this method checks if any further commits (see commit() have occurred in that directory).

If instead this reader is a near real-time reader (ie, obtained by a call to getReader(), or by calling reopen() on a near real-time reader), then this method checks if either a new commmit has occurred, or any new uncommitted changes have taken place via the writer. Note that even if the writer has only performed merging, this method will still return false.

In any event, if this returns false, you should call reopen() to get a new reader that sees the changes.

Returns true if document n has been deleted

Checks is the index is optimized (if it has a single segment and no deletions). Not implemented in the IndexReader base class.

Returns one greater than the largest possible document number. This may be used to, e.g., determine how big to allocate an array which will have an element for every document number in an index.

Returns the byte-encoded normalization factor for the named field of every document. This is used by the search code to score documents. Returns null if norms were not indexed for this field.

Reads the byte-encoded normalization factor for the named field of every document. This is used by the search code to score documents.

Returns the number of documents in this index.

Expert: remove a previously added IndexReader.ReaderFinishedListener.

Returns an unpositioned TermDocs enumerator.

Note: the TermDocs returned is unpositioned. Before using it, ensure that you first position it with seek(Term) or seek(TermEnum).

Returns an enumeration of all the documents which contain 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.

Returns an unpositioned TermPositions enumerator.

Returns an enumeration of all terms starting at a given term. If the given term does not exist, the enumeration is positioned at the first term greater than the supplied term. The enumeration is ordered by Term.compareTo(). Each term is greater than all that precede it in the enumeration.

Returns an enumeration of all the terms in the index. The enumeration is ordered by Term.compareTo(). Each term is greater than all that precede it in the enumeration. Note that after calling terms(), next() must be called on the resulting enumeration before calling other methods such as term().

Implements close.

Implements commit.

Implements deletion of the document numbered docNum. Applications should call deleteDocument(int) or deleteDocuments(Term).

Implements setNorm in subclass.

Implements actual undeleteAll() in subclass.