File Doc Category Size Date Package
FilterIndexReader.java API Doc Apache Lucene 2.2.0 6665 Sat Jun 16 22:20:36 BST 2007 org.apache.lucene.index

FilterIndexReader

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

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.

Fields Summary
protected IndexReader
in
Constructors Summary
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.
param
in specified base reader.
super(in.directory()); this.in = in;
Methods Summary
protected void doClose()
in.close();
protected void doCommit()
in.commit();
protected void doDelete(int n)
in.deleteDocument(n);
protected void doSetNorm(int d, java.lang.String f, byte b)
in.setNorm(d, f, b);
protected void doUndeleteAll()
in.undeleteAll();
public int docFreq(org.apache.lucene.index.Term t)
ensureOpen(); return in.docFreq(t);
public org.apache.lucene.document.Document document(int n, org.apache.lucene.document.FieldSelector fieldSelector)
ensureOpen(); return in.document(n, fieldSelector);
public java.util.Collection getFieldNames(org.apache.lucene.index.IndexReader$FieldOption fieldNames)
ensureOpen(); return in.getFieldNames(fieldNames);
public org.apache.lucene.index.TermFreqVector getTermFreqVector(int docNumber, java.lang.String field)
ensureOpen(); return in.getTermFreqVector(docNumber, field);
public org.apache.lucene.index.TermFreqVector[] getTermFreqVectors(int docNumber)
ensureOpen(); return in.getTermFreqVectors(docNumber);
public long getVersion()
ensureOpen(); return in.getVersion();
public boolean hasDeletions()
// Don't call ensureOpen() here (it could affect performance) return in.hasDeletions();
public boolean hasNorms(java.lang.String field)
ensureOpen(); return in.hasNorms(field);
public boolean isCurrent()
ensureOpen(); return in.isCurrent();
public boolean isDeleted(int n)
// Don't call ensureOpen() here (it could affect performance) return in.isDeleted(n);
public int maxDoc()
// Don't call ensureOpen() here (it could affect performance) return in.maxDoc();
public byte[] norms(java.lang.String f)
ensureOpen(); return in.norms(f);
public void norms(java.lang.String f, byte[] bytes, int offset)
ensureOpen(); in.norms(f, bytes, offset);
public int numDocs()
// Don't call ensureOpen() here (it could affect performance) return in.numDocs();
public org.apache.lucene.index.TermDocs termDocs()
ensureOpen(); return in.termDocs();
public org.apache.lucene.index.TermPositions termPositions()
ensureOpen(); return in.termPositions();
public org.apache.lucene.index.TermEnum terms()
ensureOpen(); return in.terms();
public org.apache.lucene.index.TermEnum terms(org.apache.lucene.index.Term t)
ensureOpen(); return in.terms(t);