Save This Page
Home » lucene-3.0.1-src » org.apache » lucene » index » [javadoc | source]
org.apache.lucene.index
public class: FilterIndexReader [javadoc | source]
java.lang.Object
   org.apache.lucene.index.IndexReader
      org.apache.lucene.index.FilterIndexReader

All Implemented Interfaces:
    Cloneable, Closeable

Direct Known Subclasses:
    FakeReader, FakeDeleteIndexReader, OneNormsReader, TestReader

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:
public static class  FilterIndexReader.FilterTermDocs  Base class for filtering {@link TermDocs} implementations. 
public static class  FilterIndexReader.FilterTermPositions  Base class for filtering {@link TermPositions} implementations. 
public static class  FilterIndexReader.FilterTermEnum  Base class for filtering {@link TermEnum} implementations. 
Field Summary
protected  IndexReader in     
Fields inherited from org.apache.lucene.index.IndexReader:
hasChanges,  DEFAULT_TERMS_INDEX_DIVISOR
Constructor:
 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 from org.apache.lucene.index.FilterIndexReader Summary:
directory,   doClose,   doCommit,   doDelete,   doSetNorm,   doUndeleteAll,   docFreq,   document,   getFieldNames,   getSequentialSubReaders,   getTermFreqVector,   getTermFreqVector,   getTermFreqVector,   getTermFreqVectors,   getVersion,   hasDeletions,   hasNorms,   isCurrent,   isDeleted,   isOptimized,   maxDoc,   norms,   norms,   numDocs,   termDocs,   termDocs,   termPositions,   terms,   terms
Methods from org.apache.lucene.index.IndexReader:
acquireWriteLock,   clone,   clone,   close,   commit,   commit,   decRef,   deleteDocument,   deleteDocuments,   directory,   doClose,   doCommit,   doDelete,   doSetNorm,   doUndeleteAll,   docFreq,   document,   document,   ensureOpen,   flush,   flush,   getCommitUserData,   getCommitUserData,   getCurrentVersion,   getFieldCacheKey,   getFieldNames,   getIndexCommit,   getRefCount,   getSequentialSubReaders,   getTermFreqVector,   getTermFreqVector,   getTermFreqVector,   getTermFreqVectors,   getTermInfosIndexDivisor,   getUniqueTermCount,   getVersion,   hasDeletions,   hasNorms,   incRef,   indexExists,   isCurrent,   isDeleted,   isOptimized,   lastModified,   listCommits,   main,   maxDoc,   norms,   norms,   numDeletedDocs,   numDocs,   open,   open,   open,   open,   open,   open,   open,   reopen,   reopen,   reopen,   setNorm,   setNorm,   termDocs,   termDocs,   termPositions,   termPositions,   terms,   terms,   undeleteAll
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.lucene.index.FilterIndexReader Detail:
 public Directory directory() 
 protected  void doClose() throws IOException 
 protected  void doCommit(Map<String, String> commitUserData) throws IOException 
 protected  void doDelete(int n) throws CorruptIndexException, IOException 
 protected  void doSetNorm(int d,
    String f,
    byte b) throws CorruptIndexException, IOException 
 protected  void doUndeleteAll() throws CorruptIndexException, IOException 
 public int docFreq(Term t) throws IOException 
 public Document document(int n,
    FieldSelector fieldSelector) throws CorruptIndexException, IOException 
 public Collection<String> getFieldNames(FieldOption fieldNames) 
 public IndexReader[] getSequentialSubReaders() 
 public TermFreqVector getTermFreqVector(int docNumber,
    String field) throws IOException 
 public  void getTermFreqVector(int docNumber,
    TermVectorMapper mapper) throws IOException 
 public  void getTermFreqVector(int docNumber,
    String field,
    TermVectorMapper mapper) throws IOException 
 public TermFreqVector[] getTermFreqVectors(int docNumber) throws IOException 
 public long getVersion() 
 public boolean hasDeletions() 
 public boolean hasNorms(String field) throws IOException 
 public boolean isCurrent() throws CorruptIndexException, IOException 
 public boolean isDeleted(int n) 
 public boolean isOptimized() 
 public int maxDoc() 
 public byte[] norms(String f) throws IOException 
 public  void norms(String f,
    byte[] bytes,
    int offset) throws IOException 
 public int numDocs() 
 public TermDocs termDocs() throws IOException 
 public TermDocs termDocs(Term term) throws IOException 
 public TermPositions termPositions() throws IOException 
 public TermEnum terms() throws IOException 
 public TermEnum terms(Term t) throws IOException