org.eclipse.persistence.sdo.helper.delegates

Class SDOXMLHelperDelegator

java.lang.Object

org.eclipse.persistence.sdo.helper.delegates.AbstractHelperDelegator

org.eclipse.persistence.sdo.helper.delegates.SDOXMLHelperDelegator

All Implemented Interfaces:

SDOXMLHelper

public class SDOXMLHelperDelegator
extends AbstractHelperDelegator
implements SDOXMLHelper

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

Responsibilities:

• Finds the appropriate SDOXMLHelperDelegate for the classLoader/application name and delegates work to that
• Load methods create commonj.sdo.XMLDocument objects from XML (unmarshal)
• Save methods create XML from commonj.sdo.XMLDocument and commonj.sdo.DataObject objects (marshal)

Constructor Summary

Constructors

Constructor and Description
SDOXMLHelperDelegator()
SDOXMLHelperDelegator(HelperContext aContext)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDescriptors(java.util.List descriptors) INTERNAL:
XMLDocument	createDocument(DataObject dataObject, java.lang.String rootElementURI, java.lang.String rootElementName)
SDOClassLoader	getLoader() INTERNAL:
Project	getTopLinkProject() INTERNAL:
XMLContext	getXmlContext() INTERNAL:
org.eclipse.persistence.internal.oxm.XMLConversionManager	getXmlConversionManager() INTERNAL:
SDOXMLHelperDelegate	getXMLHelperDelegate()
XMLMarshaller	getXmlMarshaller() INTERNAL:
XMLUnmarshaller	getXmlUnmarshaller() INTERNAL:
void	initializeDescriptor(XMLDescriptor descriptor)
XMLDocument	load(org.xml.sax.InputSource inputSource, java.lang.String locationURI, java.lang.Object options) INTERNAL:
XMLDocument	load(java.io.InputStream inputStream)
XMLDocument	load(java.io.InputStream inputStream, java.lang.String locationURI, java.lang.Object options)
XMLDocument	load(java.io.Reader inputReader, java.lang.String locationURI, java.lang.Object options)
XMLDocument	load(javax.xml.transform.Source source, java.lang.String locationURI, java.lang.Object options)
XMLDocument	load(java.lang.String inputString)
void	reset() INTERNAL:
java.lang.String	save(DataObject dataObject, java.lang.String rootElementURI, java.lang.String rootElementName)
void	save(DataObject dataObject, java.lang.String rootElementURI, java.lang.String rootElementName, java.io.OutputStream outputStream)
void	save(XMLDocument xmlDocument, java.io.OutputStream outputStream, java.lang.Object options)
void	save(XMLDocument xmlDocument, javax.xml.transform.Result result, java.lang.Object options)
void	save(XMLDocument xmlDocument, java.io.Writer outputWriter, java.lang.Object options)
void	serialize(XMLDocument xmlDocument, java.io.OutputStream outputStream, java.lang.Object options)
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(Project toplinkProject) INTERNAL:
void	setXmlContext(XMLContext xmlContext) INTERNAL:
void	setXmlMarshaller(XMLMarshaller xmlMarshaller) INTERNAL:
void	setXmlUnmarshaller(XMLUnmarshaller xmlUnmarshaller) INTERNAL:

Methods inherited from class org.eclipse.persistence.sdo.helper.delegates.AbstractHelperDelegator

getHelperContext, setHelperContext

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.persistence.sdo.helper.SDOXMLHelper

getHelperContext, setHelperContext

Constructor Detail

SDOXMLHelperDelegator

public SDOXMLHelperDelegator()

SDOXMLHelperDelegator

public SDOXMLHelperDelegator(HelperContext aContext)

Method Detail

setTimeZone

public 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.

Specified by:

setTimeZone in interface SDOXMLHelper

setTimeZoneQualified

public 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.

Specified by:

setTimeZoneQualified in interface SDOXMLHelper

load

public XMLDocument load(java.lang.String inputString)

load

public XMLDocument load(java.io.InputStream inputStream)
                 throws java.io.IOException

Throws:

java.io.IOException

load

public XMLDocument load(java.io.InputStream inputStream,
               java.lang.String locationURI,
               java.lang.Object options)
                 throws java.io.IOException

Throws:

java.io.IOException

load

public XMLDocument load(org.xml.sax.InputSource inputSource,
               java.lang.String locationURI,
               java.lang.Object options)
                 throws java.io.IOException

Description copied from interface: SDOXMLHelper

INTERNAL:

Specified by:

load in interface SDOXMLHelper

Returns:

Throws:

java.io.IOException

load

public XMLDocument load(java.io.Reader inputReader,
               java.lang.String locationURI,
               java.lang.Object options)
                 throws java.io.IOException

Throws:

java.io.IOException

load

public XMLDocument load(javax.xml.transform.Source source,
               java.lang.String locationURI,
               java.lang.Object options)
                 throws java.io.IOException

Throws:

java.io.IOException

save

public java.lang.String save(DataObject dataObject,
                    java.lang.String rootElementURI,
                    java.lang.String rootElementName)

save

public void save(DataObject dataObject,
        java.lang.String rootElementURI,
        java.lang.String rootElementName,
        java.io.OutputStream outputStream)
          throws java.io.IOException

Throws:

java.io.IOException

save

public void save(XMLDocument xmlDocument,
        java.io.OutputStream outputStream,
        java.lang.Object options)
          throws java.io.IOException

Throws:

java.io.IOException

save

public void save(XMLDocument xmlDocument,
        java.io.Writer outputWriter,
        java.lang.Object options)
          throws java.io.IOException

Throws:

java.io.IOException

save

public void save(XMLDocument xmlDocument,
        javax.xml.transform.Result result,
        java.lang.Object options)
          throws java.io.IOException

Throws:

java.io.IOException

serialize

public void serialize(XMLDocument xmlDocument,
             java.io.OutputStream outputStream,
             java.lang.Object options)
               throws java.io.IOException

Specified by:

serialize in interface SDOXMLHelper

Throws:

java.io.IOException

createDocument

public XMLDocument createDocument(DataObject dataObject,
                         java.lang.String rootElementURI,
                         java.lang.String rootElementName)

setLoader

public void setLoader(SDOClassLoader loader)

Description copied from interface: SDOXMLHelper

INTERNAL:

Specified by:

setLoader in interface SDOXMLHelper

getLoader

public SDOClassLoader getLoader()

Description copied from interface: SDOXMLHelper

INTERNAL:

Specified by:

getLoader in interface SDOXMLHelper

Returns:

setXmlContext

public void setXmlContext(XMLContext xmlContext)

Description copied from interface: SDOXMLHelper

INTERNAL:

Specified by:

setXmlContext in interface SDOXMLHelper

getXmlContext

public XMLContext getXmlContext()

Description copied from interface: SDOXMLHelper

INTERNAL:

Specified by:

getXmlContext in interface SDOXMLHelper

Returns:

addDescriptors

public void addDescriptors(java.util.List descriptors)

Description copied from interface: SDOXMLHelper

INTERNAL:

Specified by:

addDescriptors in interface SDOXMLHelper

setTopLinkProject

public void setTopLinkProject(Project toplinkProject)

Description copied from interface: SDOXMLHelper

INTERNAL:

Specified by:

setTopLinkProject in interface SDOXMLHelper

initializeDescriptor

public void initializeDescriptor(XMLDescriptor descriptor)

Specified by:

initializeDescriptor in interface SDOXMLHelper

getTopLinkProject

public Project getTopLinkProject()

Description copied from interface: SDOXMLHelper

INTERNAL:

Specified by:

getTopLinkProject in interface SDOXMLHelper

Returns:

setXmlMarshaller

public void setXmlMarshaller(XMLMarshaller xmlMarshaller)

Description copied from interface: SDOXMLHelper

INTERNAL:

Specified by:

setXmlMarshaller in interface SDOXMLHelper

getXmlMarshaller

public XMLMarshaller getXmlMarshaller()

Description copied from interface: SDOXMLHelper

INTERNAL:

Specified by:

getXmlMarshaller in interface SDOXMLHelper

Returns:

setXmlUnmarshaller

public void setXmlUnmarshaller(XMLUnmarshaller xmlUnmarshaller)

Description copied from interface: SDOXMLHelper

INTERNAL:

Specified by:

setXmlUnmarshaller in interface SDOXMLHelper

getXmlUnmarshaller

public XMLUnmarshaller getXmlUnmarshaller()

Description copied from interface: SDOXMLHelper

INTERNAL:

Specified by:

getXmlUnmarshaller in interface SDOXMLHelper

Returns:

getXMLHelperDelegate

public SDOXMLHelperDelegate getXMLHelperDelegate()

reset

public void reset()

Description copied from interface: SDOXMLHelper

INTERNAL:

Specified by:

reset in interface SDOXMLHelper

getXmlConversionManager

public org.eclipse.persistence.internal.oxm.XMLConversionManager getXmlConversionManager()

Description copied from interface: SDOXMLHelper

INTERNAL:

Specified by:

getXmlConversionManager in interface SDOXMLHelper