com.timeindexing.plugin
Class FileInputPlugin

java.lang.Object
  com.timeindexing.plugin.DefaultInputPlugin
      com.timeindexing.plugin.FileInputPlugin

All Implemented Interfaces:

InputPlugin

public class FileInputPlugin
extends DefaultInputPlugin

A class to input a whole file.

Constructor Summary

FileInputPlugin(Index anIndex, java.io.File file)
Construct an FileInputPlugin object given an index and a File object.

FileInputPlugin(Index anIndex, java.io.FileInputStream inStream)
Construct a FileInputPlugin object given an index and an InputStream.

FileInputPlugin(Index anIndex, java.lang.String fileName)
Construct an FileInputPlugin object given an index and a file name.

Method Summary

java.lang.Object	begin() Begin for this class locks the file.
java.lang.Object	end() End for this class releases the lock.

Methods inherited from class com.timeindexing.plugin.DefaultInputPlugin

getIndex, getInputStream, getReaderPlugin, isEOF, read, setReaderPlugin

Methods inherited from class java.lang.Object

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

Constructor Detail

FileInputPlugin

public FileInputPlugin(Index anIndex,
                       java.lang.String fileName)
                throws java.io.FileNotFoundException

Construct an FileInputPlugin object given an index and a file name.

Throws:

java.io.FileNotFoundException

FileInputPlugin

public FileInputPlugin(Index anIndex,
                       java.io.File file)
                throws java.io.FileNotFoundException

Construct an FileInputPlugin object given an index and a File object.

Throws:

java.io.FileNotFoundException

FileInputPlugin

public FileInputPlugin(Index anIndex,
                       java.io.FileInputStream inStream)

Construct a FileInputPlugin object given an index and an InputStream.

Method Detail

begin

public java.lang.Object begin()

Begin for this class locks the file.

Specified by:

begin in interface InputPlugin

Overrides:

begin in class DefaultInputPlugin

end

public java.lang.Object end()

End for this class releases the lock.

Specified by:

end in interface InputPlugin

Overrides:

end in class DefaultInputPlugin