Save This Page
Home » lucene-2.3.2-src » org.apache » lucene » index » [javadoc | source]
org.apache.lucene.index
class: CompoundFileReader [javadoc | source]
java.lang.Object
   org.apache.lucene.store.Directory
      org.apache.lucene.index.CompoundFileReader
Class for accessing a compound stream. This class implements a directory, but is limited to only read operations. Directory methods that would normally modify data throw an exception.
Nested Class Summary:
static final class  CompoundFileReader.CSIndexInput  Implementation of an IndexInput that reads from a portion of the compound file. The visibility is left as "package" *only* because this helps with testing since JUnit test cases in a different class can then access package fields of this class. 
Fields inherited from org.apache.lucene.store.Directory:
lockFactory
Constructor:
 public CompoundFileReader(Directory dir,
    String name) throws IOException 
 public CompoundFileReader(Directory dir,
    String name,
    int readBufferSize) throws IOException 
Method from org.apache.lucene.index.CompoundFileReader Summary:
close,   createOutput,   deleteFile,   fileExists,   fileLength,   fileModified,   getDirectory,   getName,   list,   makeLock,   openInput,   openInput,   renameFile,   touchFile
Methods from org.apache.lucene.store.Directory:
clearLock,   close,   copy,   createOutput,   deleteFile,   fileExists,   fileLength,   fileModified,   getLockFactory,   getLockID,   list,   makeLock,   openInput,   openInput,   renameFile,   setLockFactory,   touchFile
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.lucene.index.CompoundFileReader Detail:
 public synchronized  void close() throws IOException 
 public IndexOutput createOutput(String name) 
    Not implemented
 public  void deleteFile(String name) 
    Not implemented
 public boolean fileExists(String name) 
    Returns true iff a file with the given name exists.
 public long fileLength(String name) throws IOException 
    Returns the length of a file in the directory.
 public long fileModified(String name) throws IOException 
    Returns the time the compound file was last modified.
 public Directory getDirectory() 
 public String getName() 
 public String[] list() 
    Returns an array of strings, one for each file in the directory.
 public Lock makeLock(String name) 
    Not implemented
 public synchronized IndexInput openInput(String id) throws IOException 
 public synchronized IndexInput openInput(String id,
    int readBufferSize) throws IOException 
 public  void renameFile(String from,
    String to) 
    Not implemented
 public  void touchFile(String name) throws IOException 
    Set the modified time of the compound file to now.