org.eclipse.persistence.oxm.record
Class NodeRecord

java.lang.Object
  org.eclipse.persistence.internal.sessions.AbstractRecord
      org.eclipse.persistence.oxm.record.XMLRecord
          org.eclipse.persistence.oxm.record.MarshalRecord
              org.eclipse.persistence.oxm.record.NodeRecord

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map, Record

public class NodeRecord
extends MarshalRecord

Use this type of MarshalRecord when the marshal target is a Node.

XMLContext xmlContext = new XMLContext("session-name");
XMLMarshaller xmlMarshaller = xmlContext.createMarshaller();
NodeRecord nodeRecord = new NodeRecord();
nodeRecord.setDOM(myNode);
xmlMarshaller.marshal(myObject, nodeRecord);


If the marshal(Node) method is called on XMLMarshaller, then the Writer is automatically wrapped in a NodeRecord.

XMLContext xmlContext = new XMLContext("session-name");
XMLMarshaller xmlMarshaller = xmlContext.createMarshaller();
xmlMarshaller.marshal(myObject, myNode);


See Also:

XMLMarshaller, Serialized Form

Nested Class Summary

protected class

NodeRecord.NodeRecordContentHandler This class will typically be used in conjunction with an XMLFragmentReader.

Nested classes/interfaces inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord

org.eclipse.persistence.internal.sessions.AbstractRecord.EntrySet, org.eclipse.persistence.internal.sessions.AbstractRecord.KeySet, org.eclipse.persistence.internal.sessions.AbstractRecord.NoEntry, org.eclipse.persistence.internal.sessions.AbstractRecord.RecordEntry, org.eclipse.persistence.internal.sessions.AbstractRecord.RecordEntryIterator, org.eclipse.persistence.internal.sessions.AbstractRecord.RecordKeyIterator, org.eclipse.persistence.internal.sessions.AbstractRecord.RecordValuesIterator, org.eclipse.persistence.internal.sessions.AbstractRecord.ValuesSet

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields inherited from class org.eclipse.persistence.oxm.record.XMLRecord

currentObject, marshaller, NIL, session, unmarshaller

Fields inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord

fields, lookupField, noEntry, nullValueInFields, size, values

Constructor Summary

NodeRecord()
INTERNAL: Default constructor.

NodeRecord(org.w3c.dom.Node node)
INTERNAL: Create a record with the element.

NodeRecord(java.lang.String rootElementName)
INTERNAL: Create a record with the root element name.

NodeRecord(java.lang.String rootElementName, NamespaceResolver namespaceResolver)
INTERNAL: Create a record with the root element name get the namespace URI from the namespaceResolver.

NodeRecord(java.lang.String localRootElementName, NamespaceResolver namespaceResolver, org.w3c.dom.Node parent)
INTERNAL: Create a record with the local root element name, that is a child of the parent.

NodeRecord(java.lang.String localRootElementName, org.w3c.dom.Node parent)
INTERNAL: Create a record with the local root element name, that is a child of the parent.

Method Summary

void	attribute(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, java.lang.String value) INTERNAL:
void	attribute(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment, NamespaceResolver namespaceResolver, java.lang.String value) INTERNAL:
void	cdata(java.lang.String value) Receive notification of character data to be wrapped in a CDATA node.
void	characters(java.lang.String value) INTERNAL:
void	clear() PUBLIC: Clear the sub-nodes of the DOM.
void	closeStartElement() INTERNAL:
void	element(org.eclipse.persistence.internal.oxm.XPathFragment frag) INTERNAL:
void	endDocument() INTERNAL:
void	endElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment, NamespaceResolver namespaceResolver) INTERNAL:
void	endPrefixMappings(NamespaceResolver namespaceResolver) INTERNAL: override so we don't iterate over namespaces when endPrefixMapping doesn't do anything
org.w3c.dom.Document	getDocument() PUBLIC: Return the document.
org.w3c.dom.Element	getDOM() Return the Node that the object will be marshalled to.
java.lang.String	getLocalName() PUBLIC: Get the local name of the context root element.
java.lang.String	getNamespaceURI() PUBLIC: Get the namespace URI for the context root element.
void	node(org.w3c.dom.Node node, NamespaceResolver namespaceResolver) Receive notification of a node.
void	openStartElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment, NamespaceResolver namespaceResolver) INTERNAL:
void	setDOM(org.w3c.dom.Node dom) Set the Node that the object will be marshalled to.
void	startDocument(java.lang.String encoding, java.lang.String version) INTERNAL:
void	startPrefixMappings(NamespaceResolver namespaceResolver) INTERNAL: override so we don't iterate over namespaces when startPrefixMapping doesn't do anything
java.lang.String	transformToXML() Return the XML string representation of the DOM.

Methods inherited from class org.eclipse.persistence.oxm.record.MarshalRecord

add, addGroupingElement, addPositionalNodes, afterContainmentMarshal, beforeContainmentMarshal, closeStartGroupingElements, endPrefixMapping, getPositionalNodes, namespaceDeclarations, openStartGroupingElements, put, removeGroupingElement, startPrefixMapping

Methods inherited from class org.eclipse.persistence.oxm.record.XMLRecord

contains, convertToXMLField, convertToXMLField, get, getCurrentObject, getDocPresPolicy, getIndicatingNoEntry, getLeafElementType, getMarshaller, getNamespaceResolver, getOwningObject, getSession, getUnmarshaller, isXOPPackage, resolveNamespacePrefix, setCurrentObject, setDocPresPolicy, setLeafElementType, setMarshaller, setNamespaceResolver, setOwningObject, setSession, setUnmarshaller, setXOPPackage

Methods inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord

clone, containsKey, containsKey, containsKey, containsValue, elements, entrySet, get, get, getField, getFields, getIndicatingNoEntry, getLookupField, getValues, getValues, getValues, hasNullValueInFields, isEmpty, keys, keySet, mergeFrom, put, put, putAll, remove, remove, remove, replaceAt, resetSize, setFields, setNullValueInFields, setValues, size, toString, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

NodeRecord

public NodeRecord()

INTERNAL: Default constructor.

NodeRecord

public NodeRecord(java.lang.String rootElementName)

INTERNAL: Create a record with the root element name.

NodeRecord

public NodeRecord(java.lang.String rootElementName,
                  NamespaceResolver namespaceResolver)

INTERNAL: Create a record with the root element name get the namespace URI from the namespaceResolver.

NodeRecord

public NodeRecord(java.lang.String localRootElementName,
                  org.w3c.dom.Node parent)

INTERNAL: Create a record with the local root element name, that is a child of the parent.

NodeRecord

public NodeRecord(java.lang.String localRootElementName,
                  NamespaceResolver namespaceResolver,
                  org.w3c.dom.Node parent)

INTERNAL: Create a record with the local root element name, that is a child of the parent. Lookup the namespace URI from the namespaceResolver.

NodeRecord

public NodeRecord(org.w3c.dom.Node node)

INTERNAL: Create a record with the element.

Method Detail

getLocalName

public java.lang.String getLocalName()

Description copied from class: XMLRecord

PUBLIC: Get the local name of the context root element.

Overrides:

getLocalName in class MarshalRecord

getNamespaceURI

public java.lang.String getNamespaceURI()

Description copied from class: XMLRecord

PUBLIC: Get the namespace URI for the context root element.

Overrides:

getNamespaceURI in class MarshalRecord

clear

public void clear()

Description copied from class: XMLRecord

PUBLIC: Clear the sub-nodes of the DOM.

Specified by:

clear in interface java.util.Map

Overrides:

clear in class MarshalRecord

getDocument

public org.w3c.dom.Document getDocument()

Description copied from class: XMLRecord

PUBLIC: Return the document.

Overrides:

getDocument in class MarshalRecord

getDOM

public org.w3c.dom.Element getDOM()

Return the Node that the object will be marshalled to.

Overrides:

getDOM in class MarshalRecord

Returns:

The marshal target.

setDOM

public void setDOM(org.w3c.dom.Node dom)

Set the Node that the object will be marshalled to.

Parameters:

writer - The marshal target.

transformToXML

public java.lang.String transformToXML()

Description copied from class: XMLRecord

Return the XML string representation of the DOM.

Overrides:

transformToXML in class MarshalRecord

startDocument

public void startDocument(java.lang.String encoding,
                          java.lang.String version)

INTERNAL:

Specified by:

startDocument in class MarshalRecord

Parameters:

encoding - The XML document will be encoded using this encoding.

version - This specifies the version of XML.

endDocument

public void endDocument()

INTERNAL:

Specified by:

endDocument in class MarshalRecord

node

public void node(org.w3c.dom.Node node,
                 NamespaceResolver namespaceResolver)

Description copied from class: MarshalRecord

Receive notification of a node.

Specified by:

node in class MarshalRecord

Parameters:

node - The Node to be added to the document

openStartElement

public void openStartElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
                             NamespaceResolver namespaceResolver)

INTERNAL:

Overrides:

openStartElement in class MarshalRecord

Parameters:

xPathFragment - The XPathFragment contains the name and prefix information about the XML element being ended.

namespaceResolver - The NamespaceResolver can be used to resolve the namespace URI for the namespace prefix held by the XPathFragment (if required).

element

public void element(org.eclipse.persistence.internal.oxm.XPathFragment frag)

INTERNAL:

Specified by:

element in class MarshalRecord

Parameters:

frag - The XPathFragment of the element

attribute

public void attribute(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
                      NamespaceResolver namespaceResolver,
                      java.lang.String value)

INTERNAL:

Specified by:

attribute in class MarshalRecord

Parameters:

xPathFragment - The XPathFragment contains the name and prefix information about the XML element being ended.

namespaceResolver - The NamespaceResolver can be used to resolve the namespace URI for the namespace prefix held by the XPathFragment (if required).

value - This is the complete value for the attribute.

attribute

public void attribute(java.lang.String namespaceURI,
                      java.lang.String localName,
                      java.lang.String qName,
                      java.lang.String value)

INTERNAL:

Specified by:

attribute in class MarshalRecord

Parameters:

namespaceURI - The namespace URI, if the attribute is not namespace qualified the value of this parameter wil be null.

localName - The local name of the attribute.

qName - The qualified name of the attribute.

value - This is the complete value for the attribute.

closeStartElement

public void closeStartElement()

INTERNAL:

Specified by:

closeStartElement in class MarshalRecord

endElement

public void endElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
                       NamespaceResolver namespaceResolver)

INTERNAL:

Specified by:

endElement in class MarshalRecord

Parameters:

xPathFragment - The XPathFragment contains the name and prefix information about the XML element being ended.

namespaceResolver - The NamespaceResolver can be used to resolve the namespace URI for the namespace prefix held by the XPathFragment (if required).

characters

public void characters(java.lang.String value)

INTERNAL:

Specified by:

characters in class MarshalRecord

Parameters:

value - This is the entire value of the text node.

cdata

public void cdata(java.lang.String value)

Description copied from class: MarshalRecord

Receive notification of character data to be wrapped in a CDATA node.

Specified by:

cdata in class MarshalRecord

Parameters:

value - This is the value of the text to be wrapped

startPrefixMappings

public void startPrefixMappings(NamespaceResolver namespaceResolver)

INTERNAL: override so we don't iterate over namespaces when startPrefixMapping doesn't do anything

Overrides:

startPrefixMappings in class MarshalRecord

endPrefixMappings

public void endPrefixMappings(NamespaceResolver namespaceResolver)

INTERNAL: override so we don't iterate over namespaces when endPrefixMapping doesn't do anything

Overrides:

endPrefixMappings in class MarshalRecord