Package com.ibm.di.parser

Class IdMLParser

java.lang.Object

com.ibm.di.parser.ParserImpl

com.ibm.di.parser.xml.XMLParser2

com.ibm.di.parser.IdMLParser

All Implemented Interfaces:

ParserInterface, VersionInfoInterface

public class IdMLParser
extends XMLParser2

The Parser used to parse IdML XML documents (or books). It is designed only for reading IdML files. For more information how they can be written, see OpenIdMLFC, CloseIdMLFC, RollingIdMLFC and IdMLConnector.

Since:

7.1

Field Summary

Fields inherited from class com.ibm.di.parser.xml.XMLParser2

attrsDeclaration, charEncoding, coalescing, currentEntryAsXML, currentEntryAsXMLString, DEFAULT_ENCODING, DUMMY_ROOT_NAME, entryTag, firstWriteStart, indentOutput, nsMap, nsTracker, skipXMLOnReading, skipXMLOnWriting, standaloneRoot, valueTag, wrapUnwrapEntry, xmlVersion, xPath, xPathStr, xsdPath

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

_debug, myConfiguration

Constructor Summary

Constructors

Constructor	Description
IdMLParser()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	closeParser()	This method closes the parser's streams
java.lang.String	getVersion()	Version information.
void	initInput()	Initializes the Input.
Entry	readEntry()	Reads the data from the IdML book and returns it, one artifact at a time (i.e.

Methods inherited from class com.ibm.di.parser.xml.XMLParser2

getCurrentEntryAsXMLStream, getCurrentEntryAsXMLString, getCurrentEntryPath, getLogger, getSchemaLocationFromXML, initOutput, initParser, querySchema, writeEntry

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

debug, debugMode, flush, getClassInstance, getContext, getDebug, getInputStream, getOutputStream, getParam, getParser, getReader, getWriter, isDeltaSupported, logmsg, registerScriptBeans, 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

Methods inherited from interface com.ibm.di.parser.ParserInterface

flush, getContext, getDebug, getParam, getParser, getReader, getWriter, isDeltaSupported, registerScriptBeans, setConfiguration, setContext, setDebug, setInputStream, setInputStream, setInputStream, setOutputStream, setOutputStream, setParam, setParser

Constructor Detail

IdMLParser

public IdMLParser()

Default constructor.

Method Detail

initInput

public void initInput()
               throws java.lang.Exception

Initializes the Input. Note: this parser relies on a Reader object to read the XML document.

Overrides:

initInput in class XMLParser2

Throws:

java.lang.Exception - - in case of a read error occurs.

See Also:

ParserImpl.setInputStream(java.io.Reader)

readEntry

public Entry readEntry()
                throws java.lang.Exception

Reads the data from the IdML book and returns it, one artifact at a time (i.e. CI or Relationship). Also, each returned entry contains the data of the MSS owning that artifact.

Specified by:

readEntry in interface ParserInterface

Overrides:

readEntry in class XMLParser2

Returns:

the Entry object containing the IdML elements.

Throws:

java.lang.Exception - if unable to parse an IdML file.

getVersion

public java.lang.String getVersion()

Version information.

Specified by:

getVersion in interface VersionInfoInterface

Overrides:

getVersion in class XMLParser2

Returns:

version information

closeParser

public void closeParser()
                 throws java.lang.Exception

This method closes the parser's streams

Specified by:

closeParser in interface ParserInterface

Overrides:

closeParser in class XMLParser2

Throws:

java.lang.Exception - in case an error occurs