com.timeindexing.plugin
Interface InputPlugin

All Known Implementing Classes:

DefaultInputPlugin, FileInputPlugin

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

Index getIndex()

Get the index we are doing input for.

getInputStream

java.io.InputStream getInputStream()

Get the InputStream for the InputPlugin.

read

ReaderResult read()
                  throws java.io.IOException

Do some input.

Throws:

java.io.IOException

isEOF

boolean isEOF()

Determine if the reader has hit EOF.

begin

java.lang.Object begin()

Called as the first thing of doInput(). Useful for doing any processing before input starts.

end

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

InputPlugin setReaderPlugin(ReaderPlugin reader)

Set a reader plugin, to read input from the InputStream.

getReaderPlugin

ReaderPlugin getReaderPlugin()

Get the reader plugin.