MultiReader (Lucene 1.5-rc1-dev API)

Overview

Package

Class

Use

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

An IndexReader which reads multiple indexes, appending their content.

Version:: $Id: MultiReader.java,v 1.7 2004/05/17 12:56:47 goller Exp $

Constructor Summary
`MultiReader(IndexReader[] subReaders)` 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)` Returns the stored fields of the `n`^th `Document` in this index.
`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()` Returns a list of all unique field names that exist in the index pointed to by this IndexReader.
`java.util.Collection`	`getFieldNames(boolean indexed)` Returns a list of all unique field names that exist in the index pointed to by this IndexReader.
`java.util.Collection`	`getIndexedFieldNames(boolean storedTermVector)`
`TermFreqVector`	`getTermFreqVector(int n, java.lang.String field)` Return a term frequency vector for the specified document and field.
`TermFreqVector[]`	`getTermFreqVectors(int n)` Return an array of term frequency vectors for the specified document.
`boolean`	`hasDeletions()` Returns true if any documents have been deleted
`boolean`	`isDeleted(int n)` Returns true if document n has been deleted
`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.
`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 after a given term.

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

close, commit, delete, delete, directory, finalize, getCurrentVersion, getCurrentVersion, getCurrentVersion, indexExists, indexExists, indexExists, isLocked, isLocked, lastModified, lastModified, lastModified, open, open, open, setNorm, setNorm, termDocs, termPositions, undeleteAll, unlock

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultiReader

public MultiReader(IndexReader[] subReaders)
            throws java.io.IOException

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

Method Detail

getTermFreqVectors

public TermFreqVector[] getTermFreqVectors(int n)
                                    throws java.io.IOException

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.

Specified by:: getTermFreqVectors in class IndexReader

Throws:: java.io.IOException
See Also:: Field.isTermVectorStored()