Module org.eclipse.persistence.sdo
Class SDOXMLHelperDelegator
java.lang.Object
org.eclipse.persistence.sdo.helper.delegates.AbstractHelperDelegator
org.eclipse.persistence.sdo.helper.delegates.SDOXMLHelperDelegator
- All Implemented Interfaces:
XMLHelper
,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)
-
Field Summary
Fields inherited from class org.eclipse.persistence.sdo.helper.delegates.AbstractHelperDelegator
aHelperContext
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addDescriptors
(List descriptors) INTERNAL:createDocument
(DataObject dataObject, String rootElementURI, String rootElementName) Creates an XMLDocument with the specified XML rootElement for the DataObject.INTERNAL:INTERNAL:INTERNAL:INTERNAL:INTERNAL:INTERNAL:void
initializeDescriptor
(XMLDescriptor descriptor) load
(InputStream inputStream) Creates and returns an XMLDocument from the inputStream.load
(InputStream inputStream, String locationURI, Object options) Creates and returns an XMLDocument from the inputStream.Creates and returns an XMLDocument from the inputReader.Creates and returns an XMLDocument from the input String.Creates and returns an XMLDocument from the inputSource.load
(InputSource inputSource, String locationURI, Object options) INTERNAL:void
reset()
INTERNAL:save
(DataObject dataObject, String rootElementURI, String rootElementName) Returns the DataObject saved as an XML document with the specified root element.void
save
(DataObject dataObject, String rootElementURI, String rootElementName, OutputStream outputStream) Saves the DataObject as an XML document with the specified root element.void
save
(XMLDocument xmlDocument, OutputStream outputStream, Object options) Serializes an XMLDocument as an XML document into the outputStream.void
save
(XMLDocument xmlDocument, Writer outputWriter, Object options) Serializes an XMLDocument as an XML document into the outputWriter.void
save
(XMLDocument xmlDocument, Result result, Object options) Serializes an XMLDocument as an XML document into the outputResult in a serialization technology independent format (as specified in javax.xml.transform).void
serialize
(XMLDocument xmlDocument, OutputStream outputStream, Object options) void
setLoader
(SDOClassLoader loader) INTERNAL:void
setTimeZone
(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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.eclipse.persistence.sdo.helper.SDOXMLHelper
getHelperContext, setHelperContext
-
Constructor Details
-
SDOXMLHelperDelegator
public SDOXMLHelperDelegator() -
SDOXMLHelperDelegator
-
-
Method Details
-
setTimeZone
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 interfaceSDOXMLHelper
-
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 interfaceSDOXMLHelper
-
load
Description copied from interface:XMLHelper
Creates and returns an XMLDocument from the input String. By default does not perform XSD validation. Same as load(new StringReader(inputString), null, null); -
load
Description copied from interface:XMLHelper
Creates and returns an XMLDocument from the inputStream. The InputStream will be closed after reading. By default does not perform XSD validation. Same as load(inputStream, null, null);- Specified by:
load
in interfaceXMLHelper
- Parameters:
inputStream
- specifies the InputStream to read from- Returns:
- the new XMLDocument loaded
- Throws:
IOException
- for stream exceptions.
-
load
public XMLDocument load(InputStream inputStream, String locationURI, Object options) throws IOException Description copied from interface:XMLHelper
Creates and returns an XMLDocument from the inputStream. The InputStream will be closed after reading. By default does not perform XSD validation.- Specified by:
load
in interfaceXMLHelper
- Parameters:
inputStream
- specifies the InputStream to read fromlocationURI
- specifies the URI of the document for relative schema locationsoptions
- implementation-specific options.- Returns:
- the new XMLDocument loaded
- Throws:
IOException
- for stream exceptions.
-
load
public XMLDocument load(InputSource inputSource, String locationURI, Object options) throws IOException Description copied from interface:SDOXMLHelper
INTERNAL:- Specified by:
load
in interfaceSDOXMLHelper
- Parameters:
inputSource
-locationURI
-options
-- Returns:
- Throws:
IOException
-
load
Description copied from interface:XMLHelper
Creates and returns an XMLDocument from the inputReader. The InputStream will be closed after reading. By default does not perform XSD validation.- Specified by:
load
in interfaceXMLHelper
- Parameters:
inputReader
- specifies the Reader to read fromlocationURI
- specifies the URI of the document for relative schema locationsoptions
- implementation-specific options.- Returns:
- the new XMLDocument loaded
- Throws:
IOException
- for stream exceptions.
-
load
Description copied from interface:XMLHelper
Creates and returns an XMLDocument from the inputSource. The InputSource will be closed after reading. By default does not perform XSD validation.- Specified by:
load
in interfaceXMLHelper
- Parameters:
source
- specifies the Source to read fromlocationURI
- specifies the URI of the document for relative schema locationsoptions
- implementation-specific options.- Returns:
- the new XMLDocument loaded
- Throws:
IOException
- for stream exceptions.
-
save
Description copied from interface:XMLHelper
Returns the DataObject saved as an XML document with the specified root element. Same as StringWriter stringWriter = new StringWriter(); save(createDocument(dataObject, rootElementURI, rootElementName), stringWriter, null); stringWriter.toString(); -
save
public void save(DataObject dataObject, String rootElementURI, String rootElementName, OutputStream outputStream) throws IOException Description copied from interface:XMLHelper
Saves the DataObject as an XML document with the specified root element. Same as save(createDocument(dataObject, rootElementURI, rootElementName), outputStream, null);- Specified by:
save
in interfaceXMLHelper
- Parameters:
dataObject
- specifies DataObject to be savedrootElementURI
- the Target Namespace URI of the root XML elementrootElementName
- the Name of the root XML elementoutputStream
- specifies the OutputStream to write to.- Throws:
IOException
- for stream exceptions.
-
save
public void save(XMLDocument xmlDocument, OutputStream outputStream, Object options) throws IOException Description copied from interface:XMLHelper
Serializes an XMLDocument as an XML document into the outputStream. If the DataObject's Type was defined by an XSD, the serialization will follow the XSD. Otherwise the serialization will follow the format as if an XSD were generated as defined by the SDO specification. The OutputStream will be flushed after writing. Does not perform validation to ensure compliance with an XSD.- Specified by:
save
in interfaceXMLHelper
- Parameters:
xmlDocument
- specifies XMLDocument to be savedoutputStream
- specifies the OutputStream to write to.options
- implementation-specific options.- Throws:
IOException
- for stream exceptions.
-
save
Description copied from interface:XMLHelper
Serializes an XMLDocument as an XML document into the outputWriter. If the DataObject's Type was defined by an XSD, the serialization will follow the XSD. Otherwise the serialization will follow the format as if an XSD were generated as defined by the SDO specification. The OutputStream will be flushed after writing. Does not perform validation to ensure compliance with an XSD.- Specified by:
save
in interfaceXMLHelper
- Parameters:
xmlDocument
- specifies XMLDocument to be savedoutputWriter
- specifies the Writer to write to.options
- implementation-specific options.- Throws:
IOException
- for stream exceptions.
-
save
Description copied from interface:XMLHelper
Serializes an XMLDocument as an XML document into the outputResult in a serialization technology independent format (as specified in javax.xml.transform). The OutputResult will be flushed after writing. Does not perform validation to ensure compliance with an XSD.- Specified by:
save
in interfaceXMLHelper
- Parameters:
xmlDocument
- specifies XMLDocument to be savedresult
- specifies Result to be savedoptions
- implementation-specific options.- Throws:
IOException
- for stream exceptions.
-
serialize
public void serialize(XMLDocument xmlDocument, OutputStream outputStream, Object options) throws IOException - Specified by:
serialize
in interfaceSDOXMLHelper
- Throws:
IOException
-
createDocument
public XMLDocument createDocument(DataObject dataObject, String rootElementURI, String rootElementName) Description copied from interface:XMLHelper
Creates an XMLDocument with the specified XML rootElement for the DataObject.- Specified by:
createDocument
in interfaceXMLHelper
- Parameters:
dataObject
- specifies DataObject to be savedrootElementURI
- the Target Namespace URI of the root XML elementrootElementName
- the Name of the root XML element- Returns:
- XMLDocument a new XMLDocument set with the specified parameters.
-
setLoader
Description copied from interface:SDOXMLHelper
INTERNAL:- Specified by:
setLoader
in interfaceSDOXMLHelper
- Parameters:
loader
-
-
getLoader
Description copied from interface:SDOXMLHelper
INTERNAL:- Specified by:
getLoader
in interfaceSDOXMLHelper
- Returns:
-
setXmlContext
Description copied from interface:SDOXMLHelper
INTERNAL:- Specified by:
setXmlContext
in interfaceSDOXMLHelper
- Parameters:
xmlContext
-
-
getXmlContext
Description copied from interface:SDOXMLHelper
INTERNAL:- Specified by:
getXmlContext
in interfaceSDOXMLHelper
- Returns:
-
addDescriptors
Description copied from interface:SDOXMLHelper
INTERNAL:- Specified by:
addDescriptors
in interfaceSDOXMLHelper
- Parameters:
descriptors
-
-
setTopLinkProject
Description copied from interface:SDOXMLHelper
INTERNAL:- Specified by:
setTopLinkProject
in interfaceSDOXMLHelper
- Parameters:
toplinkProject
-
-
initializeDescriptor
- Specified by:
initializeDescriptor
in interfaceSDOXMLHelper
-
getTopLinkProject
Description copied from interface:SDOXMLHelper
INTERNAL:- Specified by:
getTopLinkProject
in interfaceSDOXMLHelper
- Returns:
-
setXmlMarshaller
Description copied from interface:SDOXMLHelper
INTERNAL:- Specified by:
setXmlMarshaller
in interfaceSDOXMLHelper
- Parameters:
xmlMarshaller
-
-
getXmlMarshaller
Description copied from interface:SDOXMLHelper
INTERNAL:- Specified by:
getXmlMarshaller
in interfaceSDOXMLHelper
- Returns:
-
setXmlUnmarshaller
Description copied from interface:SDOXMLHelper
INTERNAL:- Specified by:
setXmlUnmarshaller
in interfaceSDOXMLHelper
- Parameters:
xmlUnmarshaller
-
-
getXmlUnmarshaller
Description copied from interface:SDOXMLHelper
INTERNAL:- Specified by:
getXmlUnmarshaller
in interfaceSDOXMLHelper
- Returns:
-
getXMLHelperDelegate
-
reset
public void reset()Description copied from interface:SDOXMLHelper
INTERNAL:- Specified by:
reset
in interfaceSDOXMLHelper
-
getXmlConversionManager
Description copied from interface:SDOXMLHelper
INTERNAL:- Specified by:
getXmlConversionManager
in interfaceSDOXMLHelper
-