SegmentReader

Clones the IndexReader and optionally changes readOnly. A readOnly reader cannot open a writeable reader.

Efficiently clones the IndexReader (sharing most internal state).

On cloning a reader with pending changes (deletions, norms), the original reader transfers its write lock to the cloned reader. This means only the cloned reader may make further changes to the index, and commit the changes to the index on close, but the old reader still reflects all changes made up until it was cloned.

Like reopen(), it's safe to make changes to either the original or the cloned reader: all shared mutable state obeys "copy on write" semantics to ensure the changes are not seen by other readers.

Returns the directory this index resides in.

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.

Expert. Warning: this returns null if the reader has no deletions

Expert

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

Return the name of the segment this reader is reading.

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 vector returned contains term numbers and frequencies for all terms in the specified field of this document, if the field had storeTermVector flag set. If the flag was not set, the method returns null.

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 vector contains term numbers and frequencies for all terms in a given vectorized field. If no such fields existed, the method returns null.

For IndexReader implementations that use TermInfosReader to read terms, this returns the current indexDivisor as specified when the reader was opened.

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.

Returns true if any documents have been deleted

Returns true if there are norms stored for this field.

Returns true if document n has been deleted

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.

Read norms into a pre-allocated array.

Returns the number of documents in this index.

Returns an unpositioned TermDocs enumerator.

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().

Clones the deleteDocs BitVector. May be overridden by subclasses. New and experimental.

Clones the norm bytes. May be overridden by subclasses. New and experimental.

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.