Module org.eclipse.persistence.sdo
Interface SDOXMLHelper
- All Superinterfaces:
XMLHelper
- All Known Implementing Classes:
JAXBXMLHelper,SDOXMLHelperDelegate,SDOXMLHelperDelegator
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
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddDescriptors(List descriptors) INTERNAL:INTERNAL: Return the helperContext that this instance is associated with.INTERNAL:org.eclipse.persistence.sessions.ProjectINTERNAL:org.eclipse.persistence.oxm.XMLContextINTERNAL:org.eclipse.persistence.internal.oxm.XMLConversionManagerINTERNAL:org.eclipse.persistence.oxm.XMLMarshallerINTERNAL:org.eclipse.persistence.oxm.XMLUnmarshallerINTERNAL:voidinitializeDescriptor(org.eclipse.persistence.oxm.XMLDescriptor descriptor) load(InputSource inputSource, String locationURI, Object options) INTERNAL:voidreset()INTERNAL:voidserialize(XMLDocument xmlDocument, OutputStream outputStream, Object options) voidsetHelperContext(HelperContext helperContext) INTERNAL: Set the helperContext that this instance is associated with.voidsetLoader(SDOClassLoader loader) INTERNAL:voidsetTimeZone(TimeZone timeZone) The specified TimeZone will be used for all String to date object conversions.voidsetTimeZoneQualified(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.voidsetTopLinkProject(org.eclipse.persistence.sessions.Project toplinkProject) INTERNAL:voidsetXmlContext(org.eclipse.persistence.oxm.XMLContext xmlContext) INTERNAL:voidsetXmlMarshaller(org.eclipse.persistence.oxm.XMLMarshaller xmlMarshaller) INTERNAL:voidsetXmlUnmarshaller(org.eclipse.persistence.oxm.XMLUnmarshaller xmlUnmarshaller) INTERNAL:
-
Method Details
-
serialize
void serialize(XMLDocument xmlDocument, OutputStream outputStream, Object options) throws IOException - Throws:
IOException
-
setTimeZone
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
INTERNAL:- Parameters:
inputSource-locationURI-options-- Returns:
- Throws:
IOException
-
setLoader
INTERNAL:- Parameters:
loader-
-
getLoader
SDOClassLoader getLoader()INTERNAL:- Returns:
-
setXmlContext
void setXmlContext(org.eclipse.persistence.oxm.XMLContext xmlContext) INTERNAL:- Parameters:
xmlContext-
-
getXmlContext
org.eclipse.persistence.oxm.XMLContext getXmlContext()INTERNAL:- Returns:
-
addDescriptors
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
HelperContext getHelperContext()INTERNAL: Return the helperContext that this instance is associated with.- Returns:
-
setHelperContext
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:
-