AbstractXmlHandler

java.lang.Object
- org.xml.sax.helpers.DefaultHandler
- - com.ibm.commerce.foundation.dataload.xmlhandler.AbstractXmlHandler

All Implemented Interfaces:

XmlHandler, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

Direct Known Subclasses:

NVPXmlHandler
```
public abstract class AbstractXmlHandler
extends org.xml.sax.helpers.DefaultHandler
implements XmlHandler
```
This is an abstract implementation of the XmlHandler interface. All other XmlHandler implementation should extend this class. The subclass should implement the startElement() and endElement() methods. The subclass should call processDataObject() for each data object it handles.

Constructor Summary

Constructors
Constructor and Description

AbstractXmlHandler()

Constructors
Constructor and Description
`AbstractXmlHandler()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected java.lang.Object`	`buildBusinessObject(java.lang.String businessObjectXmlString)` Build business object based on an XML string which represented a business object.
`void`	`characters(char[] chars, int start, int length)` Handle the characters event in the xml.
`void`	`endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)` Handle the end element event in the xml.
`void`	`error(org.xml.sax.SAXParseException exception)` Report error using FINE trace level.
`void`	`fatalError(org.xml.sax.SAXParseException exception)` Report fatal error
`protected java.lang.String`	`getBusinessObjectXmlString()` Returns the business object XML string
`ConfigProperties`	`getConfigProperties()` Get the instance of the configuration for this XML handler.
`com.ibm.commerce.foundation.dataload.DataLoader`	`getDataLoader()` Gets the data loader object.
`protected java.lang.String`	`getLocation()` get the current element location in the xml.
`protected java.lang.String`	`getRecordXpath()` Gets the record xpath which can be defined in the property.
`protected java.lang.String`	`getXmlFooterString()` Returns the XML footer which contains the ending of the root element.
`protected java.lang.String`	`getXmlHeaderString()` Returns the XML header line and also includes the beginning of the root element with the namespace setting if any
`protected void`	`handleException(DataLoadException ex)` Handles the exception.
`void`	`init()` Does some initialization.
`protected boolean`	`insideRecordElement()` Returns the value of insideRecordElement.
`protected void`	`processDataObject(java.lang.Object dataObject)` Process the data object.
`protected void`	`setBuildXmlString(boolean buildXmlString)` Sets the flag to indicate if it needs to build XML string for the business object.
`void`	`setConfigProperties(ConfigProperties aConfigProperties)` Sets the ConfigProperties to the XML handler.
`void`	`setDataLoader(com.ibm.commerce.foundation.dataload.DataLoader dataLoader)` Sets the data loader object
`void`	`setDocumentLocator(org.xml.sax.Locator locator)` Set the document locator.
`protected void`	`setIncludeXmlHeaderInBusinessObjectXml(boolean includeXmlHeaderInBusinessObjectXml)` Sets the flag to indicate whether to include the XML header in the business object XML string.
`protected void`	`setTrimWhitespace(boolean trimWhitespace)` Sets the flag to indicate whether to trim the white space when building the XML string.
`void`	`startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attributes)` Handle the start element event in the xml.

Methods inherited from class org.xml.sax.helpers.DefaultHandler
endDocument, endPrefixMapping, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xml.sax.ContentHandler
endDocument, endPrefixMapping, ignorableWhitespace, processingInstruction, skippedEntity, startDocument, startPrefixMapping

Methods inherited from interface org.xml.sax.DTDHandler
notationDecl, unparsedEntityDecl

Methods inherited from interface org.xml.sax.EntityResolver
resolveEntity

Methods inherited from interface org.xml.sax.ErrorHandler
warning

- Constructor Detail
  - AbstractXmlHandler
```
public AbstractXmlHandler()
```
- Method Detail
  - setDocumentLocator
```
public void setDocumentLocator(org.xml.sax.Locator locator)
```
    Set the document locator.
    
    Specified by:
    
    setDocumentLocator in interface org.xml.sax.ContentHandler
    
    Overrides:
    
    setDocumentLocator in class org.xml.sax.helpers.DefaultHandler
    
    Parameters:
    
    locator - the locator
  - getLocation
```
protected java.lang.String getLocation()
```
    get the current element location in the xml.
    
    Returns:
    
    the location of the element in the xml.
  - error
```
public void error(org.xml.sax.SAXParseException exception)
           throws org.xml.sax.SAXException
```
    Report error using FINE trace level.
    
    Specified by:
    
    error in interface org.xml.sax.ErrorHandler
    
    Overrides:
    
    error in class org.xml.sax.helpers.DefaultHandler
    
    Parameters:
    
    exception - a SAXParseException
    
    Throws:
    
    org.xml.sax.SAXException - if super.error() throws the exception.
  - fatalError
```
public void fatalError(org.xml.sax.SAXParseException exception)
                throws org.xml.sax.SAXException
```
    Report fatal error
    
    Specified by:
    
    fatalError in interface org.xml.sax.ErrorHandler
    
    Overrides:
    
    fatalError in class org.xml.sax.helpers.DefaultHandler
    
    Parameters:
    
    exception - a SAXParseException
    
    Throws:
    
    org.xml.sax.SAXException
  - setDataLoader
```
public void setDataLoader(com.ibm.commerce.foundation.dataload.DataLoader dataLoader)
```
    Sets the data loader object
    
    Specified by:
    
    setDataLoader in interface XmlHandler
    
    Parameters:
    
    dataLoader - a data loader object
  - getDataLoader
```
public com.ibm.commerce.foundation.dataload.DataLoader getDataLoader()
```
    Gets the data loader object.
    
    Specified by:
    
    getDataLoader in interface XmlHandler
    
    Returns:
    
    the data load object.
  - processDataObject
```
protected void processDataObject(java.lang.Object dataObject)
                          throws DataLoadException
```
    Process the data object. It will call the data loader's processDataObject(). This method will be called by the subclass to process the data object.
    
    Parameters:
    
    dataObject - the business object.
    
    Throws:
    
    DataLoadException - this exception is thrown if calling the data loader processDataObject() throws the exception.
  - buildBusinessObject
```
protected java.lang.Object buildBusinessObject(java.lang.String businessObjectXmlString)
                                        throws DataLoadException
```
    Build business object based on an XML string which represented a business object.
    
    Parameters:
    
    businessObjectXmlString - an XML string which represented a business object.
    
    Returns:
    
    an instance of business object
    
    Throws:
    
    DataLoadException - if there are some errors to convert the XML string to a business object.
  - characters
```
public void characters(char[] chars,
              int start,
              int length)
                throws org.xml.sax.SAXException
```
    Handle the characters event in the xml.
    
    Specified by:
    
    characters in interface org.xml.sax.ContentHandler
    
    Overrides:
    
    characters in class org.xml.sax.helpers.DefaultHandler
    
    Parameters:
    
    chars - the char array
    
    start - the start index position in the char array
    
    length - the length
    
    Throws:
    
    org.xml.sax.SAXException - if there are some errors to handle it.
  - startElement
```
public void startElement(java.lang.String uri,
                java.lang.String localName,
                java.lang.String qName,
                org.xml.sax.Attributes attributes)
                  throws org.xml.sax.SAXException
```
    Handle the start element event in the xml.
    
    Specified by:
    
    startElement in interface org.xml.sax.ContentHandler
    
    Overrides:
    
    startElement in class org.xml.sax.helpers.DefaultHandler
    
    Parameters:
    
    uri - the uri of the element
    
    localName - the location name of the element
    
    qName - the qualified name of the element
    
    attributes - the attributes in the element.
    
    Throws:
    
    org.xml.sax.SAXException - if there are some errors to handle it.
  - insideRecordElement
```
protected boolean insideRecordElement()
```
    Returns the value of insideRecordElement.
    
    Returns:
    
    true if it is inside of the record element.
  - endElement
```
public void endElement(java.lang.String uri,
              java.lang.String localName,
              java.lang.String qName)
                throws org.xml.sax.SAXException
```
    Handle the end element event in the xml.
    
    Specified by:
    
    endElement in interface org.xml.sax.ContentHandler
    
    Overrides:
    
    endElement in class org.xml.sax.helpers.DefaultHandler
    
    Parameters:
    
    uri - the uri of the element
    
    localName - the location name of the element
    
    qName - the qualified name of the element
    
    Throws:
    
    org.xml.sax.SAXException - if there are some errors to handle it.
  - getXmlHeaderString
```
protected java.lang.String getXmlHeaderString()
```
    Returns the XML header line and also includes the beginning of the root element with the namespace setting if any
    
    Returns:
    
    the XML header line and also includes the beginning of the root element with the namespace setting if any
  - getXmlFooterString
```
protected java.lang.String getXmlFooterString()
```
    Returns the XML footer which contains the ending of the root element.
    
    Returns:
    
    the XML footer which contains the ending of the root element.
  - getBusinessObjectXmlString
```
protected java.lang.String getBusinessObjectXmlString()
```
    Returns the business object XML string
    
    Returns:
    
    the business object XML string
  - setIncludeXmlHeaderInBusinessObjectXml
```
protected void setIncludeXmlHeaderInBusinessObjectXml(boolean includeXmlHeaderInBusinessObjectXml)
```
    Sets the flag to indicate whether to include the XML header in the business object XML string. Default is false if the flag is not set.
    
    Parameters:
    
    includeXmlHeaderInBusinessObjectXml - a flag to indicate whether to include the XML header in the business object XML string
  - setTrimWhitespace
```
protected void setTrimWhitespace(boolean trimWhitespace)
```
    Sets the flag to indicate whether to trim the white space when building the XML string. The default is true.
    
    Parameters:
    
    trimWhitespace - a flag to indicate whether to trim the white space when building the XML string.
  - setBuildXmlString
```
protected void setBuildXmlString(boolean buildXmlString)
```
    Sets the flag to indicate if it needs to build XML string for the business object. The default is false.
    
    Parameters:
    
    buildXmlString - a flag to indicate if it needs to build XML string for the business object.
  - init
```
public void init()
          throws DataLoadException
```
    Does some initialization. The subclass can overwrite this method to provide additional
    
    Specified by:
    
    init in interface XmlHandler
    
    Throws:
    
    DataLoadException - if there are some errors in the initialization.
  - getRecordXpath
```
protected java.lang.String getRecordXpath()
```
    Gets the record xpath which can be defined in the property. If it is not defined, it returns null. If the record xpath starts with slash /, it is the absolute xpath. Otherwise, it is a relative xpath or it is just the name of an element which represent a record. The xpath will not use the qualified name. It only use the local name.
    
    Returns:
    
    the record xpath.
  - getConfigProperties
```
public ConfigProperties getConfigProperties()
```
    Get the instance of the configuration for this XML handler.
    
    Call this method when you need to get more specific properties from the ConfigProperties.
    
    Specified by:
    
    getConfigProperties in interface XmlHandler
    
    Returns:
    
    ConfigProperties The instance of the configuration for this XML handler.
  - setConfigProperties
```
public void setConfigProperties(ConfigProperties aConfigProperties)
```
    Sets the ConfigProperties to the XML handler. You normally don't need to call this method unless you want to override the ConfigProperties which is initialized from a business object configuration file.
    
    Specified by:
    
    setConfigProperties in interface XmlHandler
    
    Parameters:
    
    aConfigProperties - a ConfigProperties
  - handleException
```
protected void handleException(DataLoadException ex)
                        throws DataLoadException
```
    Handles the exception. If the maxError is not reached, the exception will not be thrown.
    
    Parameters:
    
    ex - a data load exception.
    
    Throws:
    
    DataLoadException - throw ex, if the max error is reached or it is not an DataLoadApplicationException.

Class AbstractXmlHandler

Constructor Summary

Method Summary

Methods inherited from class org.xml.sax.helpers.DefaultHandler

Methods inherited from class java.lang.Object

Methods inherited from interface org.xml.sax.ContentHandler

Methods inherited from interface org.xml.sax.DTDHandler

Methods inherited from interface org.xml.sax.EntityResolver

Methods inherited from interface org.xml.sax.ErrorHandler

Constructor Detail

AbstractXmlHandler

Method Detail

setDocumentLocator

getLocation

error

fatalError

setDataLoader

getDataLoader

processDataObject

buildBusinessObject

characters

startElement

insideRecordElement

endElement

getXmlHeaderString

getXmlFooterString

getBusinessObjectXmlString

setIncludeXmlHeaderInBusinessObjectXml

setTrimWhitespace

setBuildXmlString

init

getRecordXpath

getConfigProperties

setConfigProperties

handleException