com.ibm.di.parser
Class XSLbasedXMLParser

java.lang.Object
  com.ibm.di.parser.ParserImpl
      com.ibm.di.parser.XSLbasedXMLParser

All Implemented Interfaces:

ParserInterface, VersionInfoInterface, org.xml.sax.ErrorHandler

public class XSLbasedXMLParser
extends ParserImpl
implements org.xml.sax.ErrorHandler

A class reading and writing Entries in XML format.

Field Summary

org.w3c.dom.NodeList	children The children of the document element of the input Document
int	curindex Variable containing the current index
javax.xml.parsers.DocumentBuilder	db The document builder used to build the document
java.lang.String	entrytag Entry tag
org.w3c.dom.Document	inputDoc The input Document
org.w3c.dom.Document	outputDoc The output Document
org.w3c.dom.Element	toplevelInput The document element of the input Document
boolean	useCData Whether using CDATASection or TextNode.
java.lang.String	valuetag Value tag

Fields inherited from class com.ibm.di.parser.ParserImpl

_debug, myConfiguration

Constructor Summary

XSLbasedXMLParser()
Constructor

Method Summary

void	closeParser() Closes the parser
void	error(org.xml.sax.SAXParseException exception) Rethrows the given exception
void	fatalError(org.xml.sax.SAXParseException exception) Ignore this since an error is called immediately afterwards
void	flush() This function is called when the parser is closing to serialize the in memory DOM tree, for a connector in add/update mode
boolean	getOmitXMLDeclaration() Returns whether we omit XML declaration or not.
java.lang.String	getVersion() Version information.
void	initInput() This function is called as a part of parser initialization, when the connector having this parser is in Iterator mode
void	initOutput() This function is called as a part of parser initialization, when the connector having this parser is in Add mode
void	initParser() This function is called by the connector containing this parser
Entry	readEntry() Constructs the next entry from the data structure read in initially.
void	registerScriptBeans(ScriptEngine se) Registers "static" script variables for input or output Document in the given ScriptEngine with the name "xmldom"
void	setOmitXMLDeclaration(boolean omit) Sets whether to omit XML declaration or not.
void	warning(org.xml.sax.SAXParseException err) Logs the given warning
void	writeEntry(Entry entry) Constructs the data structure from the next entry read in initially.

Methods inherited from class com.ibm.di.parser.ParserImpl

debug, debugMode, getClassInstance, getContext, getDebug, getInputStream, getOutputStream, getParam, getParser, getReader, getWriter, isDeltaSupported, logmsg, querySchema, setConfiguration, setContext, setDebug, setInputStream, setInputStream, setInputStream, setOutputStream, setOutputStream, setParam, setParser

Methods inherited from class java.lang.Object

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

Field Detail

inputDoc

public org.w3c.dom.Document inputDoc

The input Document

outputDoc

public org.w3c.dom.Document outputDoc

The output Document

toplevelInput

public org.w3c.dom.Element toplevelInput

The document element of the input Document

children

public org.w3c.dom.NodeList children

The children of the document element of the input Document

curindex

public int curindex

Variable containing the current index

useCData

public boolean useCData

Whether using CDATASection or TextNode. Default is CDATASection

entrytag

public java.lang.String entrytag

Entry tag

valuetag

public java.lang.String valuetag

Value tag

db

public javax.xml.parsers.DocumentBuilder db

The document builder used to build the document

Constructor Detail

XSLbasedXMLParser

public XSLbasedXMLParser()

Constructor

Method Detail

registerScriptBeans

public void registerScriptBeans(ScriptEngine se)
                         throws java.lang.Exception

Registers "static" script variables for input or output Document in the given ScriptEngine with the name "xmldom"

Specified by:

registerScriptBeans in interface ParserInterface

Overrides:

registerScriptBeans in class ParserImpl

Parameters:

se - ScriptEngine

Throws:

java.lang.Exception - if an error occurs.

initParser

public void initParser()
                throws java.lang.Exception

This function is called by the connector containing this parser

Specified by:

initParser in interface ParserInterface

Overrides:

initParser in class ParserImpl

Throws:

java.lang.Exception - if an error occurs.

closeParser

public void closeParser()
                 throws java.lang.Exception

Closes the parser

Specified by:

closeParser in interface ParserInterface

Overrides:

closeParser in class ParserImpl

Throws:

java.lang.Exception - if an error occurs.

flush

public void flush()
           throws java.lang.Exception

This function is called when the parser is closing to serialize the in memory DOM tree, for a connector in add/update mode

Specified by:

flush in interface ParserInterface

Overrides:

flush in class ParserImpl

Throws:

java.lang.Exception - if an error occurs

initOutput

public void initOutput()
                throws java.lang.Exception

This function is called as a part of parser initialization, when the connector having this parser is in Add mode

Throws:

java.lang.Exception - if an error occurs.

initInput

public void initInput()
               throws java.lang.Exception

This function is called as a part of parser initialization, when the connector having this parser is in Iterator mode

Throws:

java.lang.Exception - if an error occurs.

readEntry

public Entry readEntry()
                throws java.lang.Exception

Constructs the next entry from the data structure read in initially. If end of data encountered a null value is returned.

Specified by:

readEntry in interface ParserInterface

Returns:

the next Entry

Throws:

java.lang.Exception - if an error occurs.

writeEntry

public void writeEntry(Entry entry)
                throws java.lang.Exception

Constructs the data structure from the next entry read in initially.

Specified by:

writeEntry in interface ParserInterface

Parameters:

entry - the next Entry

Throws:

java.lang.Exception - if an error occurs.

setOmitXMLDeclaration

public void setOmitXMLDeclaration(boolean omit)

Sets whether to omit XML declaration or not.

Parameters:

omit - if true omits XML declaration header in output stream; otherwise does not omit XML declaration;

getOmitXMLDeclaration

public boolean getOmitXMLDeclaration()

Returns whether we omit XML declaration or not.

Returns:

true if omits XML declaration header in output stream; false otherwise.

fatalError

public void fatalError(org.xml.sax.SAXParseException exception)

Ignore this since an error is called immediately afterwards

Specified by:

fatalError in interface org.xml.sax.ErrorHandler

Parameters:

exception - SAXParseException

error

public void error(org.xml.sax.SAXParseException exception)
           throws org.xml.sax.SAXException

Rethrows the given exception

Specified by:

error in interface org.xml.sax.ErrorHandler

Parameters:

exception - SAXParseException

Throws:

org.xml.sax.SAXException

warning

public void warning(org.xml.sax.SAXParseException err)
             throws org.xml.sax.SAXException

Logs the given warning

Specified by:

warning in interface org.xml.sax.ErrorHandler

Parameters:

err - SAXParseException

Throws:

org.xml.sax.SAXException

getVersion

public java.lang.String getVersion()

Version information.

Specified by:

getVersion in interface VersionInfoInterface

Returns:

version information