MultiReader

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.lucene.index
Class MultiReader

java.lang.Object
  org.apache.lucene.index.IndexReader
      org.apache.lucene.index.MultiReader

public class MultiReader
extends IndexReader
extends IndexReader

An IndexReader which reads multiple indexes, appending their content.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader
`IndexReader.FieldOption`

Field Summary
`protected IndexReader[]`	`subReaders`

Fields inherited from class org.apache.lucene.index.IndexReader
`hasChanges`

Constructor Summary
`MultiReader(IndexReader[] subReaders)` Construct a MultiReader aggregating the named set of (sub)readers.
`MultiReader(IndexReader[] subReaders, boolean closeSubReaders)` Construct a MultiReader aggregating the named set of (sub)readers.

Method Summary
`int`	`docFreq(Term t)` Returns the number of documents containing the term `t`.
`protected void`	`doClose()` Implements close.
`protected void`	`doCommit()` Implements commit.
`Document`	`document(int n, FieldSelector fieldSelector)` Get the `Document` at the `n`^th position.
`protected void`	`doDelete(int n)` Implements deletion of the document numbered `docNum`.
`protected void`	`doSetNorm(int n, java.lang.String field, byte value)` Implements setNorm in subclass.
`protected void`	`doUndeleteAll()` Implements actual undeleteAll() in subclass.
`java.util.Collection`	`getFieldNames(IndexReader.FieldOption fieldNames)` Get a list of unique field names that exist in this index and have the specified field option information.
`TermFreqVector`	`getTermFreqVector(int n, java.lang.String field)` Return a term frequency vector for the specified document and field.
`void`	`getTermFreqVector(int docNumber, java.lang.String field, TermVectorMapper mapper)` Load the Term Vector into a user-defined data structure instead of relying on the parallel arrays of the `TermFreqVector`.
`void`	`getTermFreqVector(int docNumber, TermVectorMapper mapper)` Map all the term vectors for all fields in a Document
`TermFreqVector[]`	`getTermFreqVectors(int n)` Return an array of term frequency vectors for the specified document.
`long`	`getVersion()` Not implemented.
`boolean`	`hasDeletions()` Returns true if any documents have been deleted
`boolean`	`hasNorms(java.lang.String field)` Returns true if there are norms stored for this field.
`boolean`	`isCurrent()` Checks recursively if all subreaders are up to date.
`boolean`	`isDeleted(int n)` Returns true if document n has been deleted
`boolean`	`isOptimized()` Checks is the index is optimized (if it has a single segment and no deletions).
`int`	`maxDoc()` Returns one greater than the largest possible document number.
`byte[]`	`norms(java.lang.String field)` Returns the byte-encoded normalization factor for the named field of every document.
`void`	`norms(java.lang.String field, byte[] result, int offset)` Reads the byte-encoded normalization factor for the named field of every document.
`int`	`numDocs()` Returns the number of documents in this index.
`IndexReader`	`reopen()` Tries to reopen the subreaders.
`TermDocs`	`termDocs()` Returns an unpositioned `TermDocs` enumerator.
`TermPositions`	`termPositions()` Returns an unpositioned `TermPositions` enumerator.
`TermEnum`	`terms()` Returns an enumeration of all the terms in the index.
`TermEnum`	`terms(Term term)` Returns an enumeration of all terms starting at a given term.

Methods inherited from class org.apache.lucene.index.IndexReader
`acquireWriteLock, close, commit, decRef, deleteDocument, deleteDocuments, directory, document, ensureOpen, flush, getCurrentVersion, getCurrentVersion, getCurrentVersion, getIndexCommit, getTermInfosIndexDivisor, incRef, indexExists, indexExists, indexExists, isLocked, isLocked, lastModified, lastModified, lastModified, listCommits, main, numDeletedDocs, open, open, open, open, open, open, open, open, open, setNorm, setNorm, setTermInfosIndexDivisor, termDocs, termPositions, undeleteAll, unlock`

Methods inherited from class org.apache.lucene.index.IndexReader

acquireWriteLock, close, commit, decRef, deleteDocument, deleteDocuments, directory, document, ensureOpen, flush, getCurrentVersion, getCurrentVersion, getCurrentVersion, getIndexCommit, getTermInfosIndexDivisor, incRef, indexExists, indexExists, indexExists, isLocked, isLocked, lastModified, lastModified, lastModified, listCommits, main, numDeletedDocs, open, open, open, open, open, open, open, open, open, setNorm, setNorm, setTermInfosIndexDivisor, termDocs, termPositions, undeleteAll, unlock

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

subReaders

protected IndexReader[] subReaders

Constructor Detail

MultiReader

public MultiReader(IndexReader[] subReaders)

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.

Parameters:: subReaders - set of (sub)readers
Throws:: java.io.IOException

MultiReader

public MultiReader(IndexReader[] subReaders,
                   boolean closeSubReaders)

Construct a MultiReader aggregating the named set of (sub)readers. Directory locking for delete, undeleteAll, and setNorm operations is left to the subreaders.

Parameters:: closeSubReaders - indicates whether the subreaders should be closed when this MultiReader is closed; subReaders - set of (sub)readers
Throws:: java.io.IOException

Method Detail

reopen

public IndexReader reopen()
                   throws CorruptIndexException,
                          java.io.IOException

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 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:: reopen in class IndexReader

Throws:: CorruptIndexException - if the index is corrupt; java.io.IOException - if there is a low-level IO error