FilterIndexReader (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 FilterIndexReader

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

public class FilterIndexReader
extends IndexReader

A FilterIndexReader contains another IndexReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality. The class FilterIndexReader itself simply implements all abstract methods of IndexReader with versions that pass all requests to the contained index reader. Subclasses of FilterIndexReader may further override some of these methods and may also provide additional methods and fields.

Nested Class Summary
`static class`	`FilterIndexReader.FilterTermDocs` Base class for filtering `TermDocs` implementations.
`static class`	`FilterIndexReader.FilterTermEnum` Base class for filtering `TermEnum` implementations.
`static class`	`FilterIndexReader.FilterTermPositions` Base class for filtering `TermPositions` implementations.

Field Summary
`protected IndexReader`	`in`

Constructor Summary
`FilterIndexReader(IndexReader in)` Construct a FilterIndexReader based on the specified base reader.

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 d, java.lang.String f, byte b)` 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 docNumber, java.lang.String field)` Return a term frequency vector for the specified document and field.
`TermFreqVector[]`	`getTermFreqVectors(int docNumber)` 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 f)` Returns the byte-encoded normalization factor for the named field of every document.
`void`	`norms(java.lang.String f, byte[] bytes, 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 `FilterIndexReader.FilterTermDocs` enumerator.
`TermPositions`	`termPositions()` Returns an unpositioned `TermPositions` enumerator.
`TermEnum`	`terms()` Returns an enumeration of all the terms in the index.
`TermEnum`	`terms(Term t)` 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

Field Detail

in

protected IndexReader in

Constructor Detail

FilterIndexReader

public FilterIndexReader(IndexReader in)

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.

Parameters:

in - specified base reader.

Method Detail