com.timeindexing.plugin
Interface InputPlugin

All Known Implementing Classes:
DefaultInputPlugin

public interface InputPlugin

An interface for input plugins.


Method Summary
 java.lang.Object begin()
          Called as the first thing of doInput().
 java.lang.Object end()
          Called as the last thing of doInput(), just before it returns.
 Index getIndex()
          Get the index we are doing input for.
 java.io.InputStream getInputStream()
          Get the InputStream for the InputPlugin.
 ReaderPlugin getReaderPlugin()
          Get the reader plugin.
 boolean isEOF()
          Determine if the reader has hit EOF.
 ReaderResult read()
          Do some input.
 InputPlugin setReaderPlugin(ReaderPlugin reader)
          Set a reader plugin, to read input from the InputStream.
 

Method Detail

getIndex

public Index getIndex()
Get the index we are doing input for.


getInputStream

public java.io.InputStream getInputStream()
Get the InputStream for the InputPlugin.


read

public ReaderResult read()
                  throws java.io.IOException
Do some input.

Throws:
java.io.IOException

isEOF

public boolean isEOF()
Determine if the reader has hit EOF.


begin

public java.lang.Object begin()
Called as the first thing of doInput(). Useful for doing any processing before input starts.


end

public java.lang.Object end()
Called as the last thing of doInput(), just before it returns. Useful for doing any processing after input has finished.


setReaderPlugin

public InputPlugin setReaderPlugin(ReaderPlugin reader)
Set a reader plugin, to read input from the InputStream.


getReaderPlugin

public ReaderPlugin getReaderPlugin()
Get the reader plugin.