|
Oracle TopLink Java API Reference 10g Release 3 (10.1.3.1) B28219-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.toplink.ox.XMLMarshaller
Class used to marshal object to XML.
Create an XMLMarshaller from an XMLContext.
Code Sample
XMLContext context = new XMLContext("mySessionName");
XMLMarshaller marshaller = context.createMarshaller();
Objects can be marshalled to the following outputs:
Objects that can be marshalled are those which are mapped in the TopLink project associated with the XMLContext, and which are mapped to an XMLDescriptor that has a default root element specified.
XMLContext
Constructor Summary | |
XMLMarshaller(XMLContext xmlContext) Create a new XMLMarshaller based on the specified session |
Method Summary | |
void |
addSchemaLocations(org.w3c.dom.Document document) |
java.lang.String |
getEncoding() Get the encoding set on this XMLMarshaller If the encoding has not been set the default UTF-8 will be used |
java.lang.String |
getNoNamespaceSchemaLocation() Get the no namespace schema location set on this XMLMarshaller |
java.lang.String |
getSchemaLocation() Get the schema location set on this XMLMarshaller |
XMLContext |
getXMLContext() Return the instance of XMLContext that was used to create this instance of XMLMarshaller. |
boolean |
isFormattedOutput() Returns if this XMLMarshaller should format the XML By default this is set to true and the XML marshalled will be formatted. |
boolean |
isFragment() PUBLIC: Returns if this should marshal to a fragment. |
void |
marshal(java.lang.Object object, org.xml.sax.ContentHandler contentHandler) PUBLIC: Convert the given object to XML and update the given contentHandler with that XML Document |
void |
marshal(java.lang.Object object, MarshalRecord marshalRecord) Convert the given object to XML and update the given marshal record with that XML Document. |
void |
marshal(java.lang.Object object, org.w3c.dom.Node node) PUBLIC: Convert the given object to XML and update the given node with that XML Document |
void |
marshal(java.lang.Object object, java.io.OutputStream outputStream) PUBLIC: Convert the given object to XML and update the given outputStream with that XML Document |
void |
marshal(java.lang.Object object, javax.xml.transform.Result result) PUBLIC: Convert the given object to XML and update the given result with that XML Document |
void |
marshal(java.lang.Object object, java.io.Writer writer) PUBLIC: Convert the given object to XML and update the given writer with that XML Document |
org.w3c.dom.Document |
objectToXML(java.lang.Object object) PUBLIC: Convert the given object to an XML Document |
org.w3c.dom.Document |
objectToXML(java.lang.Object object, org.w3c.dom.Node parent) PUBLIC: Convert the given object to descendants of the parent element |
void |
setEncoding(java.lang.String newEncoding) Set the encoding on this XMLMarshaller If the encoding is not set the default UTF-8 will be used |
void |
setFormattedOutput(boolean shouldFormat) Set if this XMLMarshaller should format the XML By default this is set to true and the XML marshalled will be formatted. |
void |
setFragment(boolean fragment) PUBLIC: Set if this should marshal to a fragment. |
void |
setNoNamespaceSchemaLocation(java.lang.String newNoNamespaceSchemaLocation) Set the no namespace schema location on this XMLMarshaller |
void |
setSchemaLocation(java.lang.String newSchemaLocation) Set the schema location on this XMLMarshaller |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public XMLMarshaller(XMLContext xmlContext)
Method Detail |
public XMLContext getXMLContext()
public boolean isFormattedOutput()
public void setFormattedOutput(boolean shouldFormat)
shouldFormat
- if this XMLMarshaller should format the XMLpublic java.lang.String getEncoding()
public void setEncoding(java.lang.String newEncoding)
newEncoding
- the encoding to set on this XMLMarshallerpublic java.lang.String getSchemaLocation()
public void setSchemaLocation(java.lang.String newSchemaLocation)
newSchemaLocation
- the schema location to be seton this XMLMarshallerpublic java.lang.String getNoNamespaceSchemaLocation()
public void setNoNamespaceSchemaLocation(java.lang.String newNoNamespaceSchemaLocation)
newNoNamespaceSchemaLocation
- no namespace schema location to be seton this XMLMarshallerpublic void marshal(java.lang.Object object, javax.xml.transform.Result result) throws XMLMarshalException
object
- the object to marshalresult
- the result to marshal the object toXMLMarshalException
- if an error occurred during marshallingpublic void marshal(java.lang.Object object, java.io.OutputStream outputStream) throws XMLMarshalException
object
- the object to marshaloutputStream
- the outputStream to marshal the object toXMLMarshalException
- if an error occurred during marshallingpublic void marshal(java.lang.Object object, java.io.Writer writer) throws XMLMarshalException
object
- the object to marshalwriter
- the writer to marshal the object toXMLMarshalException
- if an error occurred during marshallingpublic void marshal(java.lang.Object object, org.xml.sax.ContentHandler contentHandler) throws XMLMarshalException
object
- the object to marshalcontentHandler
- the contentHandler which the specified object should be marshalled toXMLMarshalException
- if an error occurred during marshallingpublic void marshal(java.lang.Object object, org.w3c.dom.Node node) throws XMLMarshalException
object
- the object to marshalnode
- the node which the specified object should be marshalled toXMLMarshalException
- if an error occurred during marshallingpublic void marshal(java.lang.Object object, MarshalRecord marshalRecord)
object
- the object to marshalmarshalRecord
- the marshalRecord to marshal the object topublic org.w3c.dom.Document objectToXML(java.lang.Object object) throws XMLMarshalException
object
- the object to marshalXMLMarshalException
- if an error occurred during marshallingpublic org.w3c.dom.Document objectToXML(java.lang.Object object, org.w3c.dom.Node parent) throws XMLMarshalException
object
- the object to marshalparent
- the node to marshal the object toXMLMarshalException
- if an error occurred during marshallingpublic void addSchemaLocations(org.w3c.dom.Document document)
public void setFragment(boolean fragment)
fragment
- if this should marshal to a fragment or notpublic boolean isFragment()
|
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |