com.timeindexing.plugin
Interface WriterPlugin

All Known Implementing Classes:

BufferedWriter, DefaultWriter

public interface WriterPlugin

An interface for writer plugins.

Method Summary

java.lang.Object	begin() Called as the first thing.
java.lang.Object	end() Called as the last thing.
long	flush() Flush out any remainig data.
java.io.OutputStream	getOutputStream() Get the OutputStream for the OutputPlugin.
WriterPlugin	setOutputStream(java.io.OutputStream out) Set the OutputStream for the OutputPlugin.
long	write(IndexItem item, IndexProperties properties)

Method Detail

getOutputStream

java.io.OutputStream getOutputStream()

Get the OutputStream for the OutputPlugin.

setOutputStream

WriterPlugin setOutputStream(java.io.OutputStream out)

Set the OutputStream for the OutputPlugin.

write

long write(IndexItem item,
           IndexProperties properties)
           throws java.io.IOException

Throws:

java.io.IOException

flush

long flush()
           throws java.io.IOException

Flush out any remainig data.

Throws:

java.io.IOException

begin

java.lang.Object begin()
                       throws java.io.IOException

Called as the first thing. Useful for doing any processing before output starts.

Throws:

java.io.IOException

end

java.lang.Object end()
                     throws java.io.IOException

Called as the last thing. Useful for doing any processing after output has finished.

Throws:

java.io.IOException