com.ibm.commerce.foundation.dataload.datareader

Class AbstractXmlReader

java.lang.Object

com.ibm.commerce.foundation.dataload.datareader.AbstractDataReader

com.ibm.commerce.foundation.dataload.datareader.AbstractXmlReader

All Implemented Interfaces:

DataReader, javax.xml.transform.ErrorListener

Direct Known Subclasses:

XmlReader

public abstract class AbstractXmlReader
extends AbstractDataReader
implements javax.xml.transform.ErrorListener

This is an abstract the XML Reader class. The other data load XML reader classes should extend this class.

Constructor Summary

Constructors

Constructor and Description
AbstractXmlReader()

Method Summary

Modifier and Type	Method and Description
void	error(javax.xml.transform.TransformerException ex) Throws an error message
void	fatalError(javax.xml.transform.TransformerException ex) Throws a fatal error message
java.lang.Integer	getSourcePosition() It returns the source position of the data object returned by the next() method you called last time.
void	init() Does some initialization.
ConfigProperties	initConfig(org.w3c.dom.Node dataReaderNode, ConfigProperties parentConfigProperties) Do initialization for the configuration.
void	warning(javax.xml.transform.TransformerException ex) Prints a warning message

Methods inherited from class com.ibm.commerce.foundation.dataload.datareader.AbstractDataReader

close, getConfigProperties, next, setConfigProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractXmlReader

public AbstractXmlReader()

Method Detail

initConfig

public ConfigProperties initConfig(org.w3c.dom.Node dataReaderNode,
                                   ConfigProperties parentConfigProperties)
                            throws DataLoadException

Do initialization for the configuration.

Specified by:

initConfig in interface DataReader

Overrides:

initConfig in class AbstractDataReader

Parameters:

dataReaderNode - the xml handler node

parentConfigProperties - the parent config properties

Returns:

the config properties.

Throws:

DataLoadException - this excpetion is thrown if there are some errors during the initialization of the configuration.

getSourcePosition

public java.lang.Integer getSourcePosition()

It returns the source position of the data object returned by the next() method you called last time. The subclass should call sourcePositionIncrement() method to increment the source position. Otherwise it will always return 0.

Specified by:

getSourcePosition in interface DataReader

Overrides:

getSourcePosition in class AbstractDataReader

Returns:

the source position of the data object.

init

public void init()
          throws DataLoadException

Does some initialization.

Specified by:

init in interface DataReader

Overrides:

init in class AbstractDataReader

Throws:

DataLoadException - if there are some errors in the initialization.

error

public void error(javax.xml.transform.TransformerException ex)
           throws javax.xml.transform.TransformerException

Throws an error message

Specified by:

error in interface javax.xml.transform.ErrorListener

Parameters:

ex - a transformer exception

Throws:

javax.xml.transform.TransformerException - if there are errors.

fatalError

public void fatalError(javax.xml.transform.TransformerException ex)
                throws javax.xml.transform.TransformerException

Throws a fatal error message

Specified by:

fatalError in interface javax.xml.transform.ErrorListener

Parameters:

ex - a transformer exception

Throws:

javax.xml.transform.TransformerException - if there are errors.

warning

public void warning(javax.xml.transform.TransformerException ex)
             throws javax.xml.transform.TransformerException

Prints a warning message

Specified by:

warning in interface javax.xml.transform.ErrorListener

Parameters:

ex - a transformer exception

Throws:

javax.xml.transform.TransformerException - if there are errors.