org.eclipse.persistence.oxm
Class XMLMarshaller

java.lang.Object
  org.eclipse.persistence.oxm.XMLMarshaller

All Implemented Interfaces:

java.lang.Cloneable

public class XMLMarshaller
extends java.lang.Object
implements java.lang.Cloneable

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:

• java.io.OutputStream
• java.io.Writer
• javax.xml.transform.Result
• org.w3c.dom.Node
• org.xml.sax.ContentHandler

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.

See Also:

XMLContext

Constructor Summary

XMLMarshaller(XMLContext xmlContext)
Create a new XMLMarshaller based on the specified session

Method Summary

XMLMarshaller	clone()
XMLAttachmentMarshaller	getAttachmentMarshaller()
protected XMLDescriptor	getDescriptor(java.lang.Object object) INTERNAL: Return the descriptor for the root object.
protected XMLDescriptor	getDescriptor(java.lang.Object object, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Return the descriptor for the root object.
protected XMLDescriptor	getDescriptor(java.lang.Object object, org.eclipse.persistence.internal.sessions.AbstractSession session, boolean isXMLRoot)
protected XMLDescriptor	getDescriptor(java.lang.Object object, boolean isXMLRoot)
protected XMLDescriptor	getDescriptor(XMLRoot object)
protected XMLDescriptor	getDescriptor(XMLRoot object, org.eclipse.persistence.internal.sessions.AbstractSession session)
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
XMLMarshalListener	getMarshalListener()
java.lang.String	getNoNamespaceSchemaLocation() Get the no namespace schema location set on this XMLMarshaller
java.util.Properties	getProperties() Return a properties object for a given instance of the XMLMarshaller.
java.lang.Object	getProperty(java.lang.Object key) Return the property for a given key, if one exists.
javax.xml.validation.Schema	getSchema()
java.lang.String	getSchemaLocation() Get the schema location set on this XMLMarshaller
XMLTransformer	getTransformer() INTERNAL
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.
protected void	marshal(java.lang.Object object, org.eclipse.persistence.internal.sessions.AbstractSession session, 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.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, org.xml.sax.ContentHandler contentHandler, org.xml.sax.ext.LexicalHandler lexicalHandler) 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) Deprecated.
org.w3c.dom.Document	objectToXML(java.lang.Object object, org.w3c.dom.Node parent, DocumentPreservationPolicy docPresPolicy)
org.w3c.dom.Document	objectToXML(java.lang.Object object, org.w3c.dom.Node rootNode, XMLDescriptor descriptor, XMLRecord xmlRow, boolean isXMLRoot, DocumentPreservationPolicy docPresPolicy)
protected org.w3c.dom.Document	objectToXML(java.lang.Object object, XMLDescriptor descriptor, boolean isXMLRoot) INTERNAL: Convert the given object to an XML Document
org.w3c.dom.Document	objectToXML(java.lang.Object object, XMLDescriptor descriptor, XMLRecord xmlRow, boolean isXMLRoot, DocumentPreservationPolicy docPresPolicy) INTERNAL: Convert the given object to an XML Document
protected org.w3c.dom.Node	objectToXMLNode(java.lang.Object object, org.eclipse.persistence.internal.sessions.AbstractSession session, XMLDescriptor descriptor, boolean isXMLRoot) INTERNAL: Like ObjectToXML but is may also return a document fragment instead of a document in the case of a non-root object.
protected org.w3c.dom.Node	objectToXMLNode(java.lang.Object object, org.w3c.dom.Node rootNode, org.eclipse.persistence.internal.sessions.AbstractSession session, XMLDescriptor descriptor, boolean isXMLRoot)
void	setAttachmentMarshaller(XMLAttachmentMarshaller atm)
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	setMarshalListener(XMLMarshalListener listener)
void	setNoNamespaceSchemaLocation(java.lang.String newNoNamespaceSchemaLocation) Set the no namespace schema location on this XMLMarshaller
void	setSchema(javax.xml.validation.Schema schema)
void	setSchemaLocation(java.lang.String newSchemaLocation) Set the schema location on this XMLMarshaller
void	setXMLContext(XMLContext value) Set the XMLContext used by this instance of XMLMarshaller.
void	setXMLMarshalHandler(XMLMarshalListener marshalListener)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLMarshaller

public XMLMarshaller(XMLContext xmlContext)

Create a new XMLMarshaller based on the specified session

Parameters:

session - A single session

Method Detail

getXMLContext

public XMLContext getXMLContext()

Return the instance of XMLContext that was used to create this instance of XMLMarshaller.

setXMLContext

public void setXMLContext(XMLContext value)

Set the XMLContext used by this instance of XMLMarshaller.

isFormattedOutput

public boolean isFormattedOutput()

Returns if this XMLMarshaller should format the XML By default this is set to true and the XML marshalled will be formatted.

Returns:

if this XMLMarshaller should format the XML

setFormattedOutput

public 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.

Parameters:

shouldFormat - if this XMLMarshaller should format the XML

getEncoding

public 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

Returns:

the encoding set on this XMLMarshaller

setEncoding

public 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

Parameters:

newEncoding - the encoding to set on this XMLMarshaller

getSchemaLocation

public java.lang.String getSchemaLocation()

Get the schema location set on this XMLMarshaller

Returns:

the schema location specified on this XMLMarshaller

setSchemaLocation

public void setSchemaLocation(java.lang.String newSchemaLocation)

Set the schema location on this XMLMarshaller

Parameters:

newSchemaLocation - the schema location to be seton this XMLMarshaller

getNoNamespaceSchemaLocation

public java.lang.String getNoNamespaceSchemaLocation()

Get the no namespace schema location set on this XMLMarshaller

Returns:

the no namespace schema location specified on this XMLMarshaller

getProperties

public java.util.Properties getProperties()

Return a properties object for a given instance of the XMLMarshaller.

Returns:

getProperty

public java.lang.Object getProperty(java.lang.Object key)

Return the property for a given key, if one exists.

Returns:

setNoNamespaceSchemaLocation

public void setNoNamespaceSchemaLocation(java.lang.String newNoNamespaceSchemaLocation)

Set the no namespace schema location on this XMLMarshaller

Parameters:

newNoNamespaceSchemaLocation - no namespace schema location to be seton this XMLMarshaller

setXMLMarshalHandler

public void setXMLMarshalHandler(XMLMarshalListener marshalListener)

getMarshalListener

public XMLMarshalListener getMarshalListener()

setMarshalListener

public void setMarshalListener(XMLMarshalListener listener)

marshal

public void marshal(java.lang.Object object,
                    javax.xml.transform.Result result)
             throws XMLMarshalException

PUBLIC: Convert the given object to XML and update the given result with that XML Document

Parameters:

object - the object to marshal

result - the result to marshal the object to

Throws:

XMLMarshalException - if an error occurred during marshalling

marshal

public void marshal(java.lang.Object object,
                    java.io.OutputStream outputStream)
             throws XMLMarshalException

PUBLIC: Convert the given object to XML and update the given outputStream with that XML Document

Parameters:

object - the object to marshal

outputStream - the outputStream to marshal the object to

Throws:

XMLMarshalException - if an error occurred during marshalling

marshal

public void marshal(java.lang.Object object,
                    java.io.Writer writer)
             throws XMLMarshalException

PUBLIC: Convert the given object to XML and update the given writer with that XML Document

Parameters:

object - the object to marshal

writer - the writer to marshal the object to

Throws:

XMLMarshalException - if an error occurred during marshalling

marshal

public void marshal(java.lang.Object object,
                    org.xml.sax.ContentHandler contentHandler)
             throws XMLMarshalException

PUBLIC: Convert the given object to XML and update the given contentHandler with that XML Document

Parameters:

object - the object to marshal

contentHandler - the contentHandler which the specified object should be marshalled to

Throws:

XMLMarshalException - if an error occurred during marshalling

marshal

public void marshal(java.lang.Object object,
                    org.xml.sax.ContentHandler contentHandler,
                    org.xml.sax.ext.LexicalHandler lexicalHandler)
             throws XMLMarshalException

PUBLIC: Convert the given object to XML and update the given contentHandler with that XML Document

Parameters:

object - the object to marshal

contentHandler - the contentHandler which the specified object should be marshalled to

Throws:

XMLMarshalException - if an error occurred during marshalling

marshal

public void marshal(java.lang.Object object,
                    org.w3c.dom.Node node)
             throws XMLMarshalException

PUBLIC: Convert the given object to XML and update the given node with that XML Document

Parameters:

object - the object to marshal

node - the node which the specified object should be marshalled to

Throws:

XMLMarshalException - if an error occurred during marshalling

marshal

public void marshal(java.lang.Object object,
                    MarshalRecord marshalRecord)

Convert the given object to XML and update the given marshal record with that XML Document.

Parameters:

object - the object to marshal

marshalRecord - the marshalRecord to marshal the object to

marshal

protected void marshal(java.lang.Object object,
                       org.eclipse.persistence.internal.sessions.AbstractSession session,
                       MarshalRecord marshalRecord)

Convert the given object to XML and update the given marshal record with that XML Document.

Parameters:

object - the object to marshal

marshalRecord - the marshalRecord to marshal the object to

objectToXML

public org.w3c.dom.Document objectToXML(java.lang.Object object)
                                 throws XMLMarshalException

PUBLIC: Convert the given object to an XML Document

Parameters:

object - the object to marshal

Returns:

the document which the specified object has been marshalled to

Throws:

XMLMarshalException - if an error occurred during marshalling

objectToXML

protected org.w3c.dom.Document objectToXML(java.lang.Object object,
                                           XMLDescriptor descriptor,
                                           boolean isXMLRoot)
                                    throws XMLMarshalException

INTERNAL: Convert the given object to an XML Document

Parameters:

object - the object to marshal

descriptor - the XMLDescriptor for the object being marshalled

Returns:

the document which the specified object has been marshalled to

Throws:

XMLMarshalException - if an error occurred during marshalling

objectToXMLNode

protected org.w3c.dom.Node objectToXMLNode(java.lang.Object object,
                                           org.eclipse.persistence.internal.sessions.AbstractSession session,
                                           XMLDescriptor descriptor,
                                           boolean isXMLRoot)
                                    throws XMLMarshalException

INTERNAL: Like ObjectToXML but is may also return a document fragment instead of a document in the case of a non-root object.

Throws:

XMLMarshalException

objectToXMLNode

protected org.w3c.dom.Node objectToXMLNode(java.lang.Object object,
                                           org.w3c.dom.Node rootNode,
                                           org.eclipse.persistence.internal.sessions.AbstractSession session,
                                           XMLDescriptor descriptor,
                                           boolean isXMLRoot)
                                    throws XMLMarshalException

Throws:

XMLMarshalException

objectToXML

public org.w3c.dom.Document objectToXML(java.lang.Object object,
                                        org.w3c.dom.Node parent)
                                 throws XMLMarshalException

Deprecated.

PUBLIC: Convert the given object to descendants of the parent element

Parameters:

object - the object to marshal

parent - the node to marshal the object to

Returns:

the document which the specified object has been marshalled to

Throws:

XMLMarshalException - if an error occurred during marshalling

objectToXML

public org.w3c.dom.Document objectToXML(java.lang.Object object,
                                        org.w3c.dom.Node parent,
                                        DocumentPreservationPolicy docPresPolicy)

objectToXML

public org.w3c.dom.Document objectToXML(java.lang.Object object,
                                        XMLDescriptor descriptor,
                                        XMLRecord xmlRow,
                                        boolean isXMLRoot,
                                        DocumentPreservationPolicy docPresPolicy)

INTERNAL: Convert the given object to an XML Document

objectToXML

public org.w3c.dom.Document objectToXML(java.lang.Object object,
                                        org.w3c.dom.Node rootNode,
                                        XMLDescriptor descriptor,
                                        XMLRecord xmlRow,
                                        boolean isXMLRoot,
                                        DocumentPreservationPolicy docPresPolicy)

getDescriptor

protected XMLDescriptor getDescriptor(java.lang.Object object)
                               throws XMLMarshalException

INTERNAL: Return the descriptor for the root object.

Throws:

XMLMarshalException

getDescriptor

protected XMLDescriptor getDescriptor(java.lang.Object object,
                                      org.eclipse.persistence.internal.sessions.AbstractSession session)
                               throws XMLMarshalException

INTERNAL: Return the descriptor for the root object.

Throws:

XMLMarshalException

getDescriptor

protected XMLDescriptor getDescriptor(java.lang.Object object,
                                      boolean isXMLRoot)

getDescriptor

protected XMLDescriptor getDescriptor(java.lang.Object object,
                                      org.eclipse.persistence.internal.sessions.AbstractSession session,
                                      boolean isXMLRoot)

getDescriptor

protected XMLDescriptor getDescriptor(XMLRoot object)
                               throws XMLMarshalException

Throws:

XMLMarshalException

getDescriptor

protected XMLDescriptor getDescriptor(XMLRoot object,
                                      org.eclipse.persistence.internal.sessions.AbstractSession session)
                               throws XMLMarshalException

Throws:

XMLMarshalException

setFragment

public void setFragment(boolean fragment)

PUBLIC: Set if this should marshal to a fragment. If true an XML header string is not written out.

Parameters:

fragment - if this should marshal to a fragment or not

isFragment

public boolean isFragment()

PUBLIC: Returns if this should marshal to a fragment. If true an XML header string is not written out.

Returns:

if this should marshal to a fragment or not

setAttachmentMarshaller

public void setAttachmentMarshaller(XMLAttachmentMarshaller atm)

getAttachmentMarshaller

public XMLAttachmentMarshaller getAttachmentMarshaller()

getTransformer

public XMLTransformer getTransformer()

INTERNAL

Returns:

the transformer instance for this marshaller

getSchema

public javax.xml.validation.Schema getSchema()

setSchema

public void setSchema(javax.xml.validation.Schema schema)

clone

public XMLMarshaller clone()

Overrides:

clone in class java.lang.Object