prajna.structure.stream

Class SaxRecordStream

java.lang.Object

prajna.structure.stream.DataRecordStream

prajna.structure.stream.SaxRecordStream

public class SaxRecordStream
extends DataRecordStream

Implementation of a DataRecordStream which parses XML into a series of DataRecord objects. This class is designed to parse data into a specified data template, which would be provided in a configuration file. Otherwise, it attempts to guess the structure of the XML data and parse it into records.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
SaxRecordStream() Create a SaxRecordStream.
SaxRecordStream(java.lang.String filePath) Create a SaxRecordStream to parse the given file or directory;

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getUnknownFields() Get the set of tags which this stream did not parse.
void	setInitParameters(java.util.Map<java.lang.String,java.lang.String> parameters) Set any initialization parameters required by this stream reader.
void	setTemplate(DataTemplate dataTemplate) Set the data template for this DataRecordStream.
void	startParse() Start parting the file or directory.
void	startParse(java.io.InputStream in) Start parsing the input stream.

Methods inherited from class prajna.structure.stream.DataRecordStream

addListener, applyReasoner, fireRecordReceived, getReasoner, getTemplate, removeListener, setConfig, setReasoner

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SaxRecordStream

public SaxRecordStream()

Create a SaxRecordStream.

SaxRecordStream

public SaxRecordStream(java.lang.String filePath)

Create a SaxRecordStream to parse the given file or directory;

Parameters:

filePath - path to a file or directory

Method Detail

getUnknownFields

public java.util.Set<java.lang.String> getUnknownFields()

Get the set of tags which this stream did not parse. This method may be used to identify parts of the stream transformation which are not translated properly

Specified by:

getUnknownFields in class DataRecordStream

Returns:

the unknown tags

setInitParameters

public void setInitParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

Set any initialization parameters required by this stream reader.

Specified by:

setInitParameters in class DataRecordStream

Parameters:

parameters - a map of initialization parameters

setTemplate

public void setTemplate(DataTemplate dataTemplate)

Set the data template for this DataRecordStream. The template is used to determine how the DataRecord should be configured and generated from the underlying data source. If the template is not set, the DataRecordStream should still generate DataRecord objects.

Overrides:

setTemplate in class DataRecordStream

Parameters:

dataTemplate - the template to set

startParse

public void startParse()
                throws java.io.IOException,
                       org.xml.sax.SAXException

Start parting the file or directory.

Throws:

java.io.IOException - if there is a problem accessing the data

org.xml.sax.SAXException - if the file(s) contain invalid XML

startParse

public void startParse(java.io.InputStream in)
                throws org.xml.sax.SAXException,
                       java.io.IOException

Start parsing the input stream. This method ignores any path defined, and parses the content of the input stream into DataRecord objects.

Parameters:

in - the input stream

Throws:

java.io.IOException - if there is a problem accessing the data

org.xml.sax.SAXException - if the stream contains invalid XML