com.ibm.di.parser
Class IdMLParser

java.lang.Object
  extended by com.ibm.di.parser.ParserImpl
      extended by com.ibm.di.parser.xml.XMLParser2
          extended by com.ibm.di.parser.IdMLParser
All Implemented Interfaces:
ParserInterface, VersionInfoInterface

public class IdMLParser
extends XMLParser2

A class that reads an IdML XML and populates the Entry Object.


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
IdMLParser()
          Default constructor.
 
Method Summary
 void closeParser()
          This method closes the parser's streams
 String getVersion()
          Version information.
 void initInput()
          Initializes the Input.
 Entry readEntry()
          Reads the inputStream and fills the Entry Object that it returns
 
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 Exception
Initializes the Input. Note: this parser relies on a Reader object to read the XML document.

Overrides:
initInput in class XMLParser2
Throws:
Exception - - in case of a read error occurs.
See Also:
ParserImpl.setInputStream(java.io.Reader)

readEntry

public Entry readEntry()
                throws Exception
Reads the inputStream and fills the Entry Object that it returns

Specified by:
readEntry in interface ParserInterface
Overrides:
readEntry in class XMLParser2
Returns:
Entry - the Entry object containing the IdML elements.
Throws:
Exception -
  • Exception - If unable to parse an IdML file.

  • getVersion

    public String getVersion()
    Version information.

    Specified by:
    getVersion in interface VersionInfoInterface
    Overrides:
    getVersion in class XMLParser2
    Returns:
    version information

    closeParser

    public void closeParser()
                     throws Exception
    This method closes the parser's streams

    Specified by:
    closeParser in interface ParserInterface
    Overrides:
    closeParser in class XMLParser2
    Throws:
    Exception - in case an error occurs