com.timeindexing.appl
Class SelectionWithHeaderStreamer

java.lang.Object
  extended by com.timeindexing.event.OutputEventGenerator
      extended by com.timeindexing.appl.OutputStreamer
          extended by com.timeindexing.appl.SelectionStreamer
              extended by com.timeindexing.appl.SelectionWithHeaderStreamer

public class SelectionWithHeaderStreamer
extends SelectionStreamer

A class to output a selction of the data toghether with a header.


Field Summary
 
Fields inherited from class com.timeindexing.appl.OutputStreamer
index, out, outputPlugin, outputProperties, writeCount
 
Fields inherited from class com.timeindexing.event.OutputEventGenerator
outputListenerList
 
Constructor Summary
SelectionWithHeaderStreamer(Index anIndex, java.io.OutputStream output)
          Construct an SelectionWithHeaderStreamer object given an index and an output stream.
 
Method Summary
 long doOutput(IndexProperties properties)
          Do some output, given some IndexProperties.
protected  long processHeader(Index index)
          Process the header and output it.
 
Methods inherited from class com.timeindexing.appl.OutputStreamer
fetchIndexItem, getOutputPlugin, processTimeIndex, setOutputPlugin
 
Methods inherited from class com.timeindexing.event.OutputEventGenerator
addOutputEventListener, fireOutputEvent, getOutputEventListeners, hasOutputEventListeners, removeOutputEventListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SelectionWithHeaderStreamer

public SelectionWithHeaderStreamer(Index anIndex,
                                   java.io.OutputStream output)
Construct an SelectionWithHeaderStreamer object given an index and an output stream.

Method Detail

doOutput

public long doOutput(IndexProperties properties)
              throws java.io.IOException,
                     TimeIndexException
Do some output, given some IndexProperties. The IndexProperties specify a selection to make. Only the selection is output.

Overrides:
doOutput in class SelectionStreamer
Throws:
java.io.IOException
TimeIndexException

processHeader

protected long processHeader(Index index)
                      throws java.io.IOException,
                             TimeIndexException
Process the header and output it.

Returns:
the no of bytes output
Throws:
java.io.IOException
TimeIndexException


Timeindexing 2008