Package org.eclipse.persistence.sdo.helper

Interface SDOXMLHelper

  • All Superinterfaces:
    commonj.sdo.helper.XMLHelper
    All Known Implementing Classes:
    JAXBXMLHelper, SDOXMLHelperDelegate, SDOXMLHelperDelegator
    public interface SDOXMLHelper
extends commonj.sdo.helper.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)

    • Field Summary

      • Fields inherited from interface commonj.sdo.helper.XMLHelper

        INSTANCE

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addDescriptors​(java.util.List descriptors)
      INTERNAL:
      commonj.sdo.helper.HelperContext getHelperContext()
      INTERNAL: Return the helperContext that this instance is associated with.
      SDOClassLoader getLoader()
      INTERNAL:
      org.eclipse.persistence.sessions.Project getTopLinkProject()
      INTERNAL:
      org.eclipse.persistence.oxm.XMLContext getXmlContext()
      INTERNAL:
      org.eclipse.persistence.internal.oxm.XMLConversionManager getXmlConversionManager()
      INTERNAL:
      org.eclipse.persistence.oxm.XMLMarshaller getXmlMarshaller()
      INTERNAL:
      org.eclipse.persistence.oxm.XMLUnmarshaller getXmlUnmarshaller()
      INTERNAL:
      void initializeDescriptor​(org.eclipse.persistence.oxm.XMLDescriptor descriptor)  
      commonj.sdo.helper.XMLDocument load​(org.xml.sax.InputSource inputSource, java.lang.String locationURI, java.lang.Object options)
      INTERNAL:
      void reset()
      INTERNAL:
      void serialize​(commonj.sdo.helper.XMLDocument xmlDocument, java.io.OutputStream outputStream, java.lang.Object options)  
      void setHelperContext​(commonj.sdo.helper.HelperContext helperContext)
      INTERNAL: Set the helperContext that this instance is associated with.
      void setLoader​(SDOClassLoader loader)
      INTERNAL:
      void setTimeZone​(java.util.TimeZone timeZone)
      The specified TimeZone will be used for all String to date object conversions.
      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.
      void setTopLinkProject​(org.eclipse.persistence.sessions.Project toplinkProject)
      INTERNAL:
      void setXmlContext​(org.eclipse.persistence.oxm.XMLContext xmlContext)
      INTERNAL:
      void setXmlMarshaller​(org.eclipse.persistence.oxm.XMLMarshaller xmlMarshaller)
      INTERNAL:
      void setXmlUnmarshaller​(org.eclipse.persistence.oxm.XMLUnmarshaller xmlUnmarshaller)
      INTERNAL:

      • Methods inherited from interface commonj.sdo.helper.XMLHelper

        createDocument, load, load, load, load, load, save, save, save, save, save

    • Method Detail

      • serialize

        void serialize​(commonj.sdo.helper.XMLDocument xmlDocument,
               java.io.OutputStream outputStream,
               java.lang.Object options)
        throws java.io.IOException
        Throws:
        java.io.IOException

      • setTimeZone

        void setTimeZone​(java.util.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

        commonj.sdo.helper.XMLDocument load​(org.xml.sax.InputSource inputSource,
                                    java.lang.String locationURI,
                                    java.lang.Object options)
                             throws java.io.IOException
        INTERNAL:
        Parameters:
        inputSource -
        locationURI -
        options -
        Returns:
        Throws:
        java.io.IOException

      • setLoader

        void setLoader​(SDOClassLoader loader)
        INTERNAL:
        Parameters:
        loader -

      • setXmlContext

        void setXmlContext​(org.eclipse.persistence.oxm.XMLContext xmlContext)
        INTERNAL:
        Parameters:
        xmlContext -

      • getXmlContext

        org.eclipse.persistence.oxm.XMLContext getXmlContext()
        INTERNAL:
        Returns:

      • addDescriptors

        void addDescriptors​(java.util.List descriptors)
        INTERNAL:
        Parameters:
        descriptors -

      • setTopLinkProject

        void setTopLinkProject​(org.eclipse.persistence.sessions.Project toplinkProject)
        INTERNAL:
        Parameters:
        toplinkProject -

      • getTopLinkProject

        org.eclipse.persistence.sessions.Project getTopLinkProject()
        INTERNAL:
        Returns:

      • setXmlMarshaller

        void setXmlMarshaller​(org.eclipse.persistence.oxm.XMLMarshaller xmlMarshaller)
        INTERNAL:
        Parameters:
        xmlMarshaller -

      • getXmlMarshaller

        org.eclipse.persistence.oxm.XMLMarshaller getXmlMarshaller()
        INTERNAL:
        Returns:

      • setXmlUnmarshaller

        void setXmlUnmarshaller​(org.eclipse.persistence.oxm.XMLUnmarshaller xmlUnmarshaller)
        INTERNAL:
        Parameters:
        xmlUnmarshaller -

      • getXmlUnmarshaller

        org.eclipse.persistence.oxm.XMLUnmarshaller getXmlUnmarshaller()
        INTERNAL:
        Returns:

      • getHelperContext

        commonj.sdo.helper.HelperContext getHelperContext()
        INTERNAL: Return the helperContext that this instance is associated with.
        Returns:

      • setHelperContext

        void setHelperContext​(commonj.sdo.helper.HelperContext helperContext)
        INTERNAL: Set the helperContext that this instance is associated with.
        Parameters:
        helperContext -

      • reset

        void reset()
        INTERNAL:

      • initializeDescriptor

        void initializeDescriptor​(org.eclipse.persistence.oxm.XMLDescriptor descriptor)

      • getXmlConversionManager

        org.eclipse.persistence.internal.oxm.XMLConversionManager getXmlConversionManager()
        INTERNAL: