com.ibm.commerce.foundation.dataload.xmlhandler

Interface XmlHandler

  • All Superinterfaces:
    org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler
    All Known Implementing Classes:
    AbstractXmlHandler, NVPXmlHandler


    public interface XmlHandler
    extends org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler
    This interface defines an XML handler to be used by the XmlReader.
    See Also:
    XmlReader
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM Copyright notice field.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      ConfigProperties getConfigProperties()
      Get the instance of the configuration for this XML handler.
      com.ibm.commerce.foundation.dataload.DataLoader getDataLoader()
      Gets the data loader object.
      void init()
      Does some initialization such as processing the properties passed in from the configuration file.
      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
      • Methods inherited from interface org.xml.sax.ContentHandler

        characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, 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

        error, fatalError, warning
    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        IBM Copyright notice field.
        See Also:
        Constant Field Values
    • Method Detail

      • setDataLoader

        void setDataLoader(com.ibm.commerce.foundation.dataload.DataLoader dataLoader)
        Sets the data loader object
        Parameters:
        dataLoader - a data loader object
      • getDataLoader

        com.ibm.commerce.foundation.dataload.DataLoader getDataLoader()
        Gets the data loader object.
        Returns:
        the data load object.
      • getConfigProperties

        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.

        Returns:
        ConfigProperties The instance of the configuration for this XML handler.
      • setConfigProperties

        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.
        Parameters:
        aConfigProperties - a ConfigProperties
      • init

        void init()
           throws DataLoadException
        Does some initialization such as processing the properties passed in from the configuration file.
        Throws:
        DataLoadException - if there are some problems to do the initialization.