net.sf.xtvdclient.xtvd.parser
Interface Parser

All Known Implementing Classes:
AbstractParser, RDBMSParser, WriterParser, XtvdParser

public interface Parser

The public interface for all XTVD parsers. All parsers are implemented using a factory design pattern and are based upon Streaming API for XML (StAX).

See Also:
AbstractParser, ParserFactory

Field Summary
static java.lang.String END_OF_LINE
          The system specific end of line character.
 
Method Summary
 java.io.Writer getLog()
          Returns the log writer that is currently in use.
 void parseXTVD()
          Parse the XTVD document and extract the information from the top-level elements.
 void setLog(java.io.Writer log)
          Set the log writer to use for writing information/messages to.
 

Field Detail

END_OF_LINE

static final java.lang.String END_OF_LINE
The system specific end of line character.

Method Detail

parseXTVD

void parseXTVD()
               throws DataDirectException
Parse the XTVD document and extract the information from the top-level elements. Concrete implementations of this class must be properly initialised with the appropriate means for saving the data extracted by this method.

Throws:
net.sf.xtvdclient.gui.DataDirectException - - If errors are encountered while parsing the XML data stream or while saving the parsed contents.
DataDirectException

getLog

java.io.Writer getLog()
Returns the log writer that is currently in use. If not set, it will default to System.err.

Returns:
Writer - The value/reference of/to log.

setLog

void setLog(java.io.Writer log)
Set the log writer to use for writing information/messages to.

Parameters:
Writer - log - The value to set.