EclipseLink 2.2.0, build 'v20110202-r8913' API Reference

org.eclipse.persistence.sdo.helper
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:


Field Summary
 
Fields inherited from interface commonj.sdo.helper.XMLHelper
INSTANCE
 
Method Summary
 void addDescriptors(java.util.List descriptors)
          INTERNAL:
 HelperContext getHelperContext()
          INTERNAL: Return the helperContext that this instance is associated with.
 SDOClassLoader getLoader()
          INTERNAL:
 Project getTopLinkProject()
          INTERNAL:
 XMLContext getXmlContext()
          INTERNAL:
 org.eclipse.persistence.internal.oxm.XMLConversionManager getXmlConversionManager()
          INTERNAL:
 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:
 void reset()
          INTERNAL:
 void serialize(XMLDocument xmlDocument, java.io.OutputStream outputStream, java.lang.Object options)
           
 void setHelperContext(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(Project toplinkProject)
          INTERNAL:
 void setXmlContext(XMLContext xmlContext)
          INTERNAL:
 void setXmlMarshaller(XMLMarshaller xmlMarshaller)
          INTERNAL:
 void setXmlUnmarshaller(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(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

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 -

getLoader

SDOClassLoader getLoader()
INTERNAL:

Returns:

setXmlContext

void setXmlContext(XMLContext xmlContext)
INTERNAL:

Parameters:
xmlContext -

getXmlContext

XMLContext getXmlContext()
INTERNAL:

Returns:

addDescriptors

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

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


EclipseLink 2.2.0, build 'v20110202-r8913' API Reference