Interface SDOXMLHelper

All Superinterfaces:
XMLHelper
All Known Implementing Classes:
JAXBXMLHelper, SDOXMLHelperDelegate, SDOXMLHelperDelegator

public interface SDOXMLHelper extends XMLHelper

Purpose: Helper to transform XML documents into DataObects and DataObjects into XML documents.

Responsibilities:

  • Load methods create commonj.sdo.XMLDocument objects from XML (unmarshal)
  • Save methods create XML from commonj.sdo.XMLDocument and commonj.sdo.DataObject objects (marshal)
  • Method Details

    • serialize

      void serialize(XMLDocument xmlDocument, OutputStream outputStream, Object options) throws IOException
      Throws:
      IOException
    • setTimeZone

      void setTimeZone(TimeZone timeZone)
      The specified TimeZone will be used for all String to date object conversions. By default the TimeZone from the JVM is used.
    • setTimeZoneQualified

      void setTimeZoneQualified(boolean timeZoneQualified)
      By setting this flag to true the marshalled date objects marshalled to the XML schema types time and dateTime will be qualified by a time zone. By default time information is not time zone qualified.
    • load

      XMLDocument load(InputSource inputSource, String locationURI, Object options) throws IOException
      INTERNAL:
      Parameters:
      inputSource -
      locationURI -
      options -
      Returns:
      Throws:
      IOException
    • setLoader

      void setLoader(SDOClassLoader loader)
      INTERNAL:
      Parameters:
      loader -
    • getLoader

      SDOClassLoader getLoader()
      INTERNAL:
      Returns:
    • setXmlContext

      void setXmlContext(XMLContext xmlContext)
      INTERNAL:
      Parameters:
      xmlContext -
    • getXmlContext

      XMLContext getXmlContext()
      INTERNAL:
      Returns:
    • addDescriptors

      void addDescriptors(List descriptors)
      INTERNAL:
      Parameters:
      descriptors -
    • setTopLinkProject

      void setTopLinkProject(Project toplinkProject)
      INTERNAL:
      Parameters:
      toplinkProject -
    • getTopLinkProject

      Project getTopLinkProject()
      INTERNAL:
      Returns:
    • setXmlMarshaller

      void setXmlMarshaller(XMLMarshaller xmlMarshaller)
      INTERNAL:
      Parameters:
      xmlMarshaller -
    • getXmlMarshaller

      XMLMarshaller getXmlMarshaller()
      INTERNAL:
      Returns:
    • setXmlUnmarshaller

      void setXmlUnmarshaller(XMLUnmarshaller xmlUnmarshaller)
      INTERNAL:
      Parameters:
      xmlUnmarshaller -
    • getXmlUnmarshaller

      XMLUnmarshaller getXmlUnmarshaller()
      INTERNAL:
      Returns:
    • getHelperContext

      HelperContext getHelperContext()
      INTERNAL: Return the helperContext that this instance is associated with.
      Returns:
    • setHelperContext

      void setHelperContext(HelperContext helperContext)
      INTERNAL: Set the helperContext that this instance is associated with.
      Parameters:
      helperContext -
    • reset

      void reset()
      INTERNAL:
    • initializeDescriptor

      void initializeDescriptor(XMLDescriptor descriptor)
    • getXmlConversionManager

      XMLConversionManager getXmlConversionManager()
      INTERNAL: