|
EclipseLink 1.1.0_ 1.1.0.r3634 API Reference | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.persistence.sdo.helper.delegates.SDOXMLHelperDelegate
public class SDOXMLHelperDelegate
Purpose: Helper to XML documents into DataObects and DataObjects into XML documents.
Responsibilities:
| Field Summary |
|---|
| Fields inherited from interface commonj.sdo.helper.XMLHelper |
|---|
INSTANCE |
| Constructor Summary | |
|---|---|
SDOXMLHelperDelegate(HelperContext aContext)
|
|
SDOXMLHelperDelegate(HelperContext aContext,
java.lang.ClassLoader aClassLoader)
|
|
| Method Summary | |
|---|---|
void |
addDescriptors(java.util.List types)
INTERNAL: |
XMLDocument |
createDocument(DataObject dataObject,
java.lang.String rootElementURI,
java.lang.String rootElementName)
Creates an XMLDocument with the specified XML rootElement for the DataObject. |
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)
Creates and returns an XMLDocument from the inputSource. |
XMLDocument |
load(java.io.InputStream inputStream)
Creates and returns an XMLDocument from the inputStream. |
XMLDocument |
load(java.io.InputStream inputStream,
java.lang.String locationURI,
java.lang.Object options)
Creates and returns an XMLDocument from the inputStream. |
XMLDocument |
load(java.io.Reader inputReader,
java.lang.String locationURI,
java.lang.Object options)
Creates and returns an XMLDocument from the inputReader. |
XMLDocument |
load(javax.xml.transform.Source source,
java.lang.String locationURI,
java.lang.Object options)
Creates and returns an XMLDocument from the inputSource. |
XMLDocument |
load(java.lang.String inputString)
Creates and returns an XMLDocument from the input String. |
void |
reset()
INTERNAL: |
java.lang.String |
save(DataObject dataObject,
java.lang.String rootElementURI,
java.lang.String rootElementName)
Returns the DataObject saved as an XML document with the specified root element. |
void |
save(DataObject dataObject,
java.lang.String rootElementURI,
java.lang.String rootElementName,
java.io.OutputStream outputStream)
Saves the DataObject as an XML document with the specified root element. |
void |
save(XMLDocument xmlDocument,
java.io.OutputStream outputStream,
java.lang.Object options)
Serializes an XMLDocument as an XML document into the outputStream. |
void |
save(XMLDocument xmlDocument,
javax.xml.transform.Result result,
java.lang.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 |
save(XMLDocument xmlDocument,
java.io.Writer outputWriter,
java.lang.Object options)
Serializes an XMLDocument as an XML document into the outputWriter. |
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 class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public SDOXMLHelperDelegate(HelperContext aContext)
public SDOXMLHelperDelegate(HelperContext aContext,
java.lang.ClassLoader aClassLoader)
| Method Detail |
|---|
public void setTimeZone(java.util.TimeZone timeZone)
setTimeZone in interface SDOXMLHelperpublic void setTimeZoneQualified(boolean timeZoneQualified)
setTimeZoneQualified in interface SDOXMLHelperpublic XMLDocument load(java.lang.String inputString)
load in interface XMLHelperinputString - specifies the String to read from
java.lang.RuntimeException - for errors in XML parsing or
implementation-specific validation.
public XMLDocument load(java.io.InputStream inputStream)
throws java.io.IOException
load in interface XMLHelperinputStream - specifies the InputStream to read from
java.io.IOException - for stream exceptions.
java.lang.RuntimeException - for errors in XML parsing or
implementation-specific validation.
public XMLDocument load(java.io.InputStream inputStream,
java.lang.String locationURI,
java.lang.Object options)
throws java.io.IOException
load in interface XMLHelperinputStream - specifies the InputStream to read fromlocationURI - specifies the URI of the document for relative schema locationsoptions - implementation-specific options.
java.io.IOException - for stream exceptions.
java.lang.RuntimeException - for errors in XML parsing or
implementation-specific validation.
public XMLDocument load(org.xml.sax.InputSource inputSource,
java.lang.String locationURI,
java.lang.Object options)
throws java.io.IOException
load in interface SDOXMLHelperinputSource - specifies the InputSource to read fromlocationURI - specifies the URI of the document for relative schema locationsoptions - implementation-specific options.
java.io.IOException - for stream exceptions.
java.lang.RuntimeException - for errors in XML parsing or
implementation-specific validation.
public XMLDocument load(java.io.Reader inputReader,
java.lang.String locationURI,
java.lang.Object options)
throws java.io.IOException
load in interface XMLHelperinputReader - specifies the Reader to read fromlocationURI - specifies the URI of the document for relative schema locationsoptions - implementation-specific options.
java.io.IOException - for stream exceptions.
java.lang.RuntimeException - for errors in XML parsing or
implementation-specific validation.
public XMLDocument load(javax.xml.transform.Source source,
java.lang.String locationURI,
java.lang.Object options)
throws java.io.IOException
XMLHelper
load in interface XMLHelpersource - specifies the Source to read fromlocationURI - specifies the URI of the document for relative schema locationsoptions - implementation-specific options.
java.io.IOException - for stream exceptions.
public java.lang.String save(DataObject dataObject,
java.lang.String rootElementURI,
java.lang.String rootElementName)
save in interface XMLHelperdataObject - specifies DataObject to be savedrootElementURI - the Target Namespace URI of the root XML elementrootElementName - the Name of the root XML element
java.lang.IllegalArgumentException - if the dataObject tree
is not closed or has no container.
public void save(DataObject dataObject,
java.lang.String rootElementURI,
java.lang.String rootElementName,
java.io.OutputStream outputStream)
throws XMLMarshalException,
java.io.IOException
save in interface XMLHelperdataObject - 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.
java.io.IOException - for stream exceptions.
java.lang.IllegalArgumentException - if the dataObject tree
is not closed or has no container.
XMLMarshalException
public void save(XMLDocument xmlDocument,
java.io.OutputStream outputStream,
java.lang.Object options)
throws java.io.IOException
save in interface XMLHelperxmlDocument - specifies XMLDocument to be savedoutputStream - specifies the OutputStream to write to.options - implementation-specific options.
java.io.IOException - for stream exceptions.
java.lang.IllegalArgumentException - if the dataObject tree
is not closed or has no container.
public void save(XMLDocument xmlDocument,
java.io.Writer outputWriter,
java.lang.Object options)
throws java.io.IOException
save in interface XMLHelperxmlDocument - specifies XMLDocument to be savedoutputWriter - specifies the Writer to write to.options - implementation-specific options.
java.io.IOException - for stream exceptions.
java.lang.IllegalArgumentException - if the dataObject tree
is not closed or has no container.
public void save(XMLDocument xmlDocument,
javax.xml.transform.Result result,
java.lang.Object options)
throws java.io.IOException
XMLHelper
save in interface XMLHelperxmlDocument - specifies XMLDocument to be savedresult - specifies Result to be savedoptions - implementation-specific options.
java.io.IOException - for stream exceptions.
public XMLDocument createDocument(DataObject dataObject,
java.lang.String rootElementURI,
java.lang.String rootElementName)
createDocument in interface XMLHelperdataObject - specifies DataObject to be savedrootElementURI - the Target Namespace URI of the root XML elementrootElementName - the Name of the root XML element
public void setLoader(SDOClassLoader loader)
SDOXMLHelper
setLoader in interface SDOXMLHelperpublic SDOClassLoader getLoader()
SDOXMLHelper
getLoader in interface SDOXMLHelperpublic void setXmlContext(XMLContext xmlContext)
SDOXMLHelper
setXmlContext in interface SDOXMLHelperpublic XMLContext getXmlContext()
SDOXMLHelper
getXmlContext in interface SDOXMLHelperpublic void initializeDescriptor(XMLDescriptor descriptor)
initializeDescriptor in interface SDOXMLHelperpublic void addDescriptors(java.util.List types)
SDOXMLHelper
addDescriptors in interface SDOXMLHelperpublic void setTopLinkProject(Project toplinkProject)
SDOXMLHelper
setTopLinkProject in interface SDOXMLHelperpublic Project getTopLinkProject()
SDOXMLHelper
getTopLinkProject in interface SDOXMLHelperpublic void setXmlMarshaller(XMLMarshaller xmlMarshaller)
SDOXMLHelper
setXmlMarshaller in interface SDOXMLHelperpublic XMLMarshaller getXmlMarshaller()
SDOXMLHelper
getXmlMarshaller in interface SDOXMLHelperpublic void setXmlUnmarshaller(XMLUnmarshaller xmlUnmarshaller)
SDOXMLHelper
setXmlUnmarshaller in interface SDOXMLHelperpublic XMLUnmarshaller getXmlUnmarshaller()
SDOXMLHelper
getXmlUnmarshaller in interface SDOXMLHelperpublic void reset()
SDOXMLHelper
reset in interface SDOXMLHelperpublic HelperContext getHelperContext()
SDOXMLHelper
getHelperContext in interface SDOXMLHelperpublic void setHelperContext(HelperContext helperContext)
SDOXMLHelper
setHelperContext in interface SDOXMLHelperpublic org.eclipse.persistence.internal.oxm.XMLConversionManager getXmlConversionManager()
SDOXMLHelper
getXmlConversionManager in interface SDOXMLHelper
|
EclipseLink 1.1.0_ 1.1.0.r3634 API Reference | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||