|
EclipseLink 2.2.0, build 'v20110202-r8913' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.eclipse.persistence.internal.sessions.AbstractRecord org.eclipse.persistence.oxm.record.XMLRecord org.eclipse.persistence.oxm.record.MarshalRecord
public abstract class MarshalRecord
A MarshalRecord encapsulates the marshal target.
MarshalRecords are stateful and state changes are triggered by different event notifications, therefore this class is not thread safe.
XML document creation will differ depending on the subclass of MarshalRecord used. For example when NodeRecord is used a child element is created on the openStartElement event, and when the ContentHandlerRecord is used a child element is not created until the closeStartMethod event.
XMLMarshaller
,
Serialized FormNested Class Summary |
---|
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 | |
---|---|
MarshalRecord()
|
Method Summary | |
---|---|
void |
add(org.eclipse.persistence.internal.helper.DatabaseField key,
java.lang.Object value)
INTERNAL: Add the field-value pair to the document. |
void |
addGroupingElement(org.eclipse.persistence.internal.oxm.XPathNode xPathNode)
INTERNAL: If an XPathNode does not have an associated NodeValue then add it to the MarshalRecord as a grouping element. |
protected void |
addPositionalNodes(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
NamespaceResolver namespaceResolver)
|
void |
afterContainmentMarshal(java.lang.Object parent,
java.lang.Object child)
|
abstract void |
attribute(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qName,
java.lang.String value)
Receive notification of an attribute. |
abstract void |
attribute(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
NamespaceResolver namespaceResolver,
java.lang.String value)
Receive notification of an attribute. |
void |
beforeContainmentMarshal(java.lang.Object child)
|
abstract void |
cdata(java.lang.String value)
Receive notification of character data to be wrapped in a CDATA node. |
abstract void |
characters(java.lang.String value)
Receive notification of character data. |
void |
clear()
PUBLIC: Clear the sub-nodes of the DOM. |
abstract void |
closeStartElement()
Receive notification that all of the attribute events have occurred for the most recent element that has been started. |
void |
closeStartGroupingElements(org.eclipse.persistence.internal.oxm.XPathFragment groupingFragment)
|
abstract void |
element(org.eclipse.persistence.internal.oxm.XPathFragment frag)
Receive notification of an element. |
abstract void |
endDocument()
Recieve notification that a document is being ended. |
abstract void |
endElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
NamespaceResolver namespaceResolver)
Receive notification that an element is being ended. |
void |
endPrefixMapping(java.lang.String prefix)
Receive notification that the scope of this namespace declaration has ended. |
void |
endPrefixMappings(NamespaceResolver namespaceResolver)
|
org.w3c.dom.Document |
getDocument()
PUBLIC: Return the document. |
org.w3c.dom.Element |
getDOM()
PUBLIC: Return the DOM. |
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. |
java.util.HashMap |
getPositionalNodes()
|
void |
namespaceDeclarations(NamespaceResolver namespaceResolver)
INTERNAL: Add the namespace declarations to the XML document. |
abstract void |
node(org.w3c.dom.Node node,
NamespaceResolver resolver)
Receive notification of a node. |
void |
openStartElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
NamespaceResolver namespaceResolver)
Receive notification that an element is being started. |
org.eclipse.persistence.internal.oxm.XPathFragment |
openStartGroupingElements(NamespaceResolver namespaceResolver)
INTERNAL: Trigger that the grouping elements should be written. |
java.lang.Object |
put(org.eclipse.persistence.internal.helper.DatabaseField key,
java.lang.Object value)
INTERNAL: Add the field-value pair to the document. |
void |
removeGroupingElement(org.eclipse.persistence.internal.oxm.XPathNode xPathNode)
INTERNAL: |
abstract void |
startDocument(java.lang.String encoding,
java.lang.String version)
Receive notification that a document is being started. |
void |
startPrefixMapping(java.lang.String prefix,
java.lang.String namespaceURI)
Receive notification that a namespace has been declared. |
void |
startPrefixMappings(NamespaceResolver namespaceResolver)
|
java.lang.String |
transformToXML()
Return the XML string representation of the DOM. |
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 |
---|
public MarshalRecord()
Method Detail |
---|
public java.util.HashMap getPositionalNodes()
public java.lang.String getLocalName()
XMLRecord
getLocalName
in class XMLRecord
public java.lang.String getNamespaceURI()
XMLRecord
getNamespaceURI
in class XMLRecord
public void clear()
XMLRecord
clear
in interface java.util.Map
clear
in class XMLRecord
public org.w3c.dom.Document getDocument()
XMLRecord
getDocument
in class XMLRecord
public org.w3c.dom.Element getDOM()
XMLRecord
getDOM
in class XMLRecord
public void addGroupingElement(org.eclipse.persistence.internal.oxm.XPathNode xPathNode)
xPathNode
- public void removeGroupingElement(org.eclipse.persistence.internal.oxm.XPathNode xPathNode)
xPathNode
- public java.lang.String transformToXML()
XMLRecord
transformToXML
in class XMLRecord
public void add(org.eclipse.persistence.internal.helper.DatabaseField key, java.lang.Object value)
add
in class org.eclipse.persistence.internal.sessions.AbstractRecord
public java.lang.Object put(org.eclipse.persistence.internal.helper.DatabaseField key, java.lang.Object value)
put
in class org.eclipse.persistence.internal.sessions.AbstractRecord
public void namespaceDeclarations(NamespaceResolver namespaceResolver)
namespaceResolver
- The NamespaceResolver contains the namespace
prefix and URI pairings that need to be declared.public abstract void startDocument(java.lang.String encoding, java.lang.String version)
encoding
- The XML document will be encoded using this encoding.version
- This specifies the version of XML.public abstract void endDocument()
public void startPrefixMapping(java.lang.String prefix, java.lang.String namespaceURI)
prefix
- The namespace prefix.namespaceURI
- The namespace URI.public void startPrefixMappings(NamespaceResolver namespaceResolver)
public void endPrefixMapping(java.lang.String prefix)
prefix
- The namespace prefix.public void endPrefixMappings(NamespaceResolver namespaceResolver)
public void openStartElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment, NamespaceResolver namespaceResolver)
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).public abstract void element(org.eclipse.persistence.internal.oxm.XPathFragment frag)
frag
- The XPathFragment of the elementpublic abstract void attribute(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment, NamespaceResolver namespaceResolver, java.lang.String value)
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.public abstract void attribute(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, java.lang.String value)
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.public abstract void closeStartElement()
public abstract void endElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment, NamespaceResolver namespaceResolver)
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).public abstract void characters(java.lang.String value)
value
- This is the entire value of the text node.public abstract void cdata(java.lang.String value)
value
- This is the value of the text to be wrappedpublic abstract void node(org.w3c.dom.Node node, NamespaceResolver resolver)
node
- The Node to be added to the documentnamespaceResolver
- The NamespaceResolver can be used to resolve the
namespace URI/prefix of the nodepublic org.eclipse.persistence.internal.oxm.XPathFragment openStartGroupingElements(NamespaceResolver namespaceResolver)
namespaceResolver
- The NamespaceResolver can be used to resolve the
namespace URI for the namespace prefix held by the XPathFragment (if
required).public void closeStartGroupingElements(org.eclipse.persistence.internal.oxm.XPathFragment groupingFragment)
protected void addPositionalNodes(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment, NamespaceResolver namespaceResolver)
public void beforeContainmentMarshal(java.lang.Object child)
public void afterContainmentMarshal(java.lang.Object parent, java.lang.Object child)
|
EclipseLink 2.2.0, build 'v20110202-r8913' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |