org.eclipse.persistence.oxm.record
Class XMLRecord

java.lang.Object
  org.eclipse.persistence.internal.core.sessions.CoreAbstractRecord
      org.eclipse.persistence.internal.sessions.AbstractRecord
          org.eclipse.persistence.oxm.record.XMLRecord

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map, org.eclipse.persistence.internal.oxm.record.XMLRecord<org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,NamespaceResolver,XMLUnmarshaller>, Record

Direct Known Subclasses:

DOMRecord, MarshalRecord, UnmarshalRecord

public abstract class XMLRecord
extends org.eclipse.persistence.internal.sessions.AbstractRecord
implements org.eclipse.persistence.internal.oxm.record.XMLRecord<org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,NamespaceResolver,XMLUnmarshaller>

PUBLIC: Provides a Record/Map API on an XML DOM element.

See Also:

Serialized Form

Nested 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 org.eclipse.persistence.internal.oxm.record.XMLRecord

org.eclipse.persistence.internal.oxm.record.XMLRecord.Nil

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

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

Field Summary

protected java.lang.Object	currentObject
protected boolean	equalNamespaceResolvers
protected boolean	hasCustomNamespaceMapper
protected XMLMarshaller	marshaller
protected boolean	namespaceAware
protected NamespaceResolver	namespaceResolver
static org.eclipse.persistence.internal.oxm.record.XMLRecord.Nil	NIL INTERNAL: Nil: This is used to indicate that this field represents xsi:nil="true"
protected org.eclipse.persistence.internal.sessions.AbstractSession	session
protected XMLUnmarshaller	unmarshaller

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

fields, lookupField, noEntry, nullValueInFields, size, values

Constructor Summary

XMLRecord()

Method Summary

java.util.List<org.eclipse.persistence.internal.oxm.Namespace>	addExtraNamespacesToNamespaceResolver(org.eclipse.persistence.internal.oxm.mappings.Descriptor desc, org.eclipse.persistence.internal.core.sessions.CoreAbstractSession session, boolean allowOverride, boolean ignoreEqualResolvers) INTERNAL
boolean	addXsiTypeAndClassIndicatorIfRequired(org.eclipse.persistence.internal.oxm.mappings.Descriptor descriptor, org.eclipse.persistence.internal.oxm.mappings.Descriptor referenceDescriptor, org.eclipse.persistence.internal.oxm.mappings.Field xmlField, boolean isRootElement) INTERNAL
boolean	addXsiTypeAndClassIndicatorIfRequired(org.eclipse.persistence.internal.oxm.mappings.Descriptor descriptor, org.eclipse.persistence.internal.oxm.mappings.Descriptor referenceDescriptor, org.eclipse.persistence.internal.oxm.mappings.Field xmlField, java.lang.Object originalObject, java.lang.Object obj, boolean wasXMLRoot, boolean isRootElement) INTERNAL
void	attribute(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, java.lang.String value) Marshal an attribute for the give namespaceURI, localName, qualifiedName and value
void	attributeWithoutQName(java.lang.String namespaceURI, java.lang.String localName, java.lang.String prefix, java.lang.String value) Marshal an attribute for the give namespaceURI, localName, preifx and value
abstract void	clear() PUBLIC: Clear the sub-nodes of the DOM.
boolean	contains(java.lang.Object value) PUBLIC: Check if the value is contained in the row.
protected XMLField	convertToXMLField(org.eclipse.persistence.internal.helper.DatabaseField databaseField) INTERNAL: Convert a DatabaseField to an XMLField
protected java.util.List<XMLField>	convertToXMLField(java.util.List<org.eclipse.persistence.internal.helper.DatabaseField> databaseFields)
java.lang.Object	get(org.eclipse.persistence.internal.helper.DatabaseField key) INTERNAL: Retrieve the value for the field.
java.lang.Object	get(java.lang.String key) PUBLIC: Add the field-value pair to the row.
java.lang.Object	getCurrentObject() INTERNAL:
DocumentPreservationPolicy	getDocPresPolicy()
abstract org.w3c.dom.Document	getDocument() PUBLIC: Return the document.
abstract org.w3c.dom.Node	getDOM() PUBLIC: Return the DOM.
java.lang.Object	getIndicatingNoEntry(java.lang.String fieldName) INTERNAL: Retrieve the value for the field name.
org.eclipse.persistence.internal.oxm.XPathQName	getLeafElementType() INTERNAL:
abstract java.lang.String	getLocalName() PUBLIC: Get the local name of the context root element.
XMLMarshaller	getMarshaller() INTERNAL:
NamespaceResolver	getNamespaceResolver()
char	getNamespaceSeparator() INTERNAL: The character used to separate the prefix and uri portions when namespaces are present
abstract java.lang.String	getNamespaceURI() PUBLIC: Get the namespace URI for the context root element.
java.lang.Object	getOwningObject() INTERNAL:
org.eclipse.persistence.internal.sessions.AbstractSession	getSession()
XMLUnmarshaller	getUnmarshaller() INTERNAL:
boolean	hasCustomNamespaceMapper()
boolean	hasEqualNamespaceResolvers()
boolean	isNamespaceAware() INTERNAL: Determine if namespaces will be considered during marshal/unmarshal operations.
boolean	isXOPPackage()
void	namespaceDeclaration(java.lang.String prefix, java.lang.String namespaceURI) Marshal a namespace declaration for the given prefix and url
java.lang.Object	put(java.lang.String key, java.lang.Object value) PUBLIC: Add the field-value pair to the row.
void	removeExtraNamespacesFromNamespaceResolver(java.util.List<org.eclipse.persistence.internal.oxm.Namespace> extraNamespaces, org.eclipse.persistence.internal.core.sessions.CoreAbstractSession session) INTERNAL
java.lang.String	resolveNamespacePrefix(java.lang.String prefix)
void	setCurrentObject(java.lang.Object obj) INTERNAL:
void	setCustomNamespaceMapper(boolean customNamespaceMapper)
void	setDocPresPolicy(DocumentPreservationPolicy policy)
void	setEqualNamespaceResolvers(boolean equalNRs)
void	setLeafElementType(javax.xml.namespace.QName type) INTERNAL:
void	setLeafElementType(org.eclipse.persistence.internal.oxm.XPathQName type) INTERNAL:
void	setMarshaller(XMLMarshaller marshaller) INTERNAL:
void	setNamespaceResolver(NamespaceResolver nr)
void	setOwningObject(java.lang.Object obj) INTERNAL:
void	setSession(org.eclipse.persistence.internal.sessions.AbstractSession session)
void	setUnmarshaller(XMLUnmarshaller unmarshaller) INTERNAL:
void	setXOPPackage(boolean isXOPPackage)
abstract java.lang.String	transformToXML() Return the XML string representation of the DOM.
void	writeXsiTypeAttribute(org.eclipse.persistence.internal.oxm.mappings.Descriptor xmlDescriptor, java.lang.String typeUri, java.lang.String typeLocal, java.lang.String typePrefix, boolean addToNamespaceResolver) INTERNAL
protected void	writeXsiTypeAttribute(org.eclipse.persistence.internal.oxm.mappings.Descriptor xmlDescriptor, XMLSchemaReference xmlRef, boolean addToNamespaceResolver) INTERNAL

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

add, clone, containsKey, containsKey, containsKey, containsValue, elements, entrySet, 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 org.eclipse.persistence.internal.oxm.record.XMLRecord

put

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

marshaller

protected XMLMarshaller marshaller

unmarshaller

protected XMLUnmarshaller unmarshaller

currentObject

protected java.lang.Object currentObject

namespaceResolver

protected NamespaceResolver namespaceResolver

session

protected org.eclipse.persistence.internal.sessions.AbstractSession session

namespaceAware

protected boolean namespaceAware

hasCustomNamespaceMapper

protected boolean hasCustomNamespaceMapper

equalNamespaceResolvers

protected boolean equalNamespaceResolvers

NIL

public static final org.eclipse.persistence.internal.oxm.record.XMLRecord.Nil NIL

INTERNAL: Nil: This is used to indicate that this field represents xsi:nil="true"

Constructor Detail

XMLRecord

public XMLRecord()

Method Detail

get

public java.lang.Object get(java.lang.String key)

PUBLIC: Add the field-value pair to the row.

Overrides:

get in class org.eclipse.persistence.internal.sessions.AbstractRecord

put

public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)

PUBLIC: Add the field-value pair to the row.

Overrides:

put in class org.eclipse.persistence.internal.sessions.AbstractRecord

attributeWithoutQName

public void attributeWithoutQName(java.lang.String namespaceURI,
                                  java.lang.String localName,
                                  java.lang.String prefix,
                                  java.lang.String value)

Marshal an attribute for the give namespaceURI, localName, preifx and value

Specified by:

attributeWithoutQName in interface org.eclipse.persistence.internal.oxm.record.XMLRecord<org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,NamespaceResolver,XMLUnmarshaller>

Parameters:

namespaceURI -

localName -

prefix -

value -

attribute

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

Marshal an attribute for the give namespaceURI, localName, qualifiedName and value

Parameters:

namespaceURI -

localName -

qName -

value -

namespaceDeclaration

public void namespaceDeclaration(java.lang.String prefix,
                                 java.lang.String namespaceURI)

Marshal a namespace declaration for the given prefix and url

Specified by:

namespaceDeclaration in interface org.eclipse.persistence.internal.oxm.record.XMLRecord<org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,NamespaceResolver,XMLUnmarshaller>

Parameters:

prefix -

url -

getLocalName

public abstract java.lang.String getLocalName()

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

getNamespaceURI

public abstract java.lang.String getNamespaceURI()

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

clear

public abstract void clear()

PUBLIC: Clear the sub-nodes of the DOM.

Specified by:

clear in interface java.util.Map

Overrides:

clear in class org.eclipse.persistence.internal.sessions.AbstractRecord

getDocument

public abstract org.w3c.dom.Document getDocument()

PUBLIC: Return the document.

contains

public boolean contains(java.lang.Object value)

PUBLIC: Check if the value is contained in the row.

Overrides:

contains in class org.eclipse.persistence.internal.sessions.AbstractRecord

getDOM

public abstract org.w3c.dom.Node getDOM()

PUBLIC: Return the DOM.

Specified by:

getDOM in interface org.eclipse.persistence.internal.oxm.record.XMLRecord<org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,NamespaceResolver,XMLUnmarshaller>

transformToXML

public abstract java.lang.String transformToXML()

Return the XML string representation of the DOM.

convertToXMLField

protected XMLField convertToXMLField(org.eclipse.persistence.internal.helper.DatabaseField databaseField)

INTERNAL: Convert a DatabaseField to an XMLField

convertToXMLField

protected java.util.List<XMLField> convertToXMLField(java.util.List<org.eclipse.persistence.internal.helper.DatabaseField> databaseFields)

get

public java.lang.Object get(org.eclipse.persistence.internal.helper.DatabaseField key)

INTERNAL: Retrieve the value for the field. If missing null is returned.

Overrides:

get in class org.eclipse.persistence.internal.sessions.AbstractRecord

getIndicatingNoEntry

public java.lang.Object getIndicatingNoEntry(java.lang.String fieldName)

INTERNAL: Retrieve the value for the field name.

Overrides:

getIndicatingNoEntry in class org.eclipse.persistence.internal.sessions.AbstractRecord

resolveNamespacePrefix

public java.lang.String resolveNamespacePrefix(java.lang.String prefix)

Specified by:

resolveNamespacePrefix in interface org.eclipse.persistence.internal.oxm.record.XMLRecord<org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,NamespaceResolver,XMLUnmarshaller>

getMarshaller

public XMLMarshaller getMarshaller()

INTERNAL:

Specified by:

getMarshaller in interface org.eclipse.persistence.internal.oxm.record.XMLRecord<org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,NamespaceResolver,XMLUnmarshaller>

setMarshaller

public void setMarshaller(XMLMarshaller marshaller)

INTERNAL:

getUnmarshaller

public XMLUnmarshaller getUnmarshaller()

INTERNAL:

Specified by:

getUnmarshaller in interface org.eclipse.persistence.internal.oxm.record.XMLRecord<org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,NamespaceResolver,XMLUnmarshaller>

setUnmarshaller

public void setUnmarshaller(XMLUnmarshaller unmarshaller)

INTERNAL:

setDocPresPolicy

public void setDocPresPolicy(DocumentPreservationPolicy policy)

getDocPresPolicy

public DocumentPreservationPolicy getDocPresPolicy()

getOwningObject

public java.lang.Object getOwningObject()

INTERNAL:

setOwningObject

public void setOwningObject(java.lang.Object obj)

INTERNAL:

getCurrentObject

public java.lang.Object getCurrentObject()

INTERNAL:

setCurrentObject

public void setCurrentObject(java.lang.Object obj)

INTERNAL:

getLeafElementType

public org.eclipse.persistence.internal.oxm.XPathQName getLeafElementType()

INTERNAL:

setLeafElementType

public void setLeafElementType(org.eclipse.persistence.internal.oxm.XPathQName type)

INTERNAL:

setLeafElementType

public void setLeafElementType(javax.xml.namespace.QName type)

INTERNAL:

setNamespaceResolver

public void setNamespaceResolver(NamespaceResolver nr)

getNamespaceResolver

public NamespaceResolver getNamespaceResolver()

Specified by:

getNamespaceResolver in interface org.eclipse.persistence.internal.oxm.record.XMLRecord<org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,NamespaceResolver,XMLUnmarshaller>

getSession

public org.eclipse.persistence.internal.sessions.AbstractSession getSession()

Specified by:

getSession in interface org.eclipse.persistence.internal.oxm.record.XMLRecord<org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,NamespaceResolver,XMLUnmarshaller>

setSession

public void setSession(org.eclipse.persistence.internal.sessions.AbstractSession session)

setEqualNamespaceResolvers

public void setEqualNamespaceResolvers(boolean equalNRs)

hasEqualNamespaceResolvers

public boolean hasEqualNamespaceResolvers()

Specified by:

hasEqualNamespaceResolvers in interface org.eclipse.persistence.internal.oxm.record.XMLRecord<org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,NamespaceResolver,XMLUnmarshaller>

isXOPPackage

public boolean isXOPPackage()

setXOPPackage

public void setXOPPackage(boolean isXOPPackage)

isNamespaceAware

public boolean isNamespaceAware()

INTERNAL: Determine if namespaces will be considered during marshal/unmarshal operations.

Specified by:

isNamespaceAware in interface org.eclipse.persistence.internal.oxm.record.XMLRecord<org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,NamespaceResolver,XMLUnmarshaller>

Since:

2.4

getNamespaceSeparator

public char getNamespaceSeparator()

INTERNAL: The character used to separate the prefix and uri portions when namespaces are present

Specified by:

getNamespaceSeparator in interface org.eclipse.persistence.internal.oxm.record.XMLRecord<org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,NamespaceResolver,XMLUnmarshaller>

Since:

2.4

hasCustomNamespaceMapper

public boolean hasCustomNamespaceMapper()

Specified by:

hasCustomNamespaceMapper in interface org.eclipse.persistence.internal.oxm.record.XMLRecord<org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,NamespaceResolver,XMLUnmarshaller>

setCustomNamespaceMapper

public void setCustomNamespaceMapper(boolean customNamespaceMapper)

addExtraNamespacesToNamespaceResolver

public java.util.List<org.eclipse.persistence.internal.oxm.Namespace> addExtraNamespacesToNamespaceResolver(org.eclipse.persistence.internal.oxm.mappings.Descriptor desc,
                                                                                                            org.eclipse.persistence.internal.core.sessions.CoreAbstractSession session,
                                                                                                            boolean allowOverride,
                                                                                                            boolean ignoreEqualResolvers)

INTERNAL

Specified by:

addExtraNamespacesToNamespaceResolver in interface org.eclipse.persistence.internal.oxm.record.XMLRecord<org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,NamespaceResolver,XMLUnmarshaller>

Since:

EclipseLink 2.5.0

addXsiTypeAndClassIndicatorIfRequired

public boolean addXsiTypeAndClassIndicatorIfRequired(org.eclipse.persistence.internal.oxm.mappings.Descriptor descriptor,
                                                     org.eclipse.persistence.internal.oxm.mappings.Descriptor referenceDescriptor,
                                                     org.eclipse.persistence.internal.oxm.mappings.Field xmlField,
                                                     boolean isRootElement)

INTERNAL

Since:

EclipseLink 2.5.0

addXsiTypeAndClassIndicatorIfRequired

public boolean addXsiTypeAndClassIndicatorIfRequired(org.eclipse.persistence.internal.oxm.mappings.Descriptor descriptor,
                                                     org.eclipse.persistence.internal.oxm.mappings.Descriptor referenceDescriptor,
                                                     org.eclipse.persistence.internal.oxm.mappings.Field xmlField,
                                                     java.lang.Object originalObject,
                                                     java.lang.Object obj,
                                                     boolean wasXMLRoot,
                                                     boolean isRootElement)

INTERNAL

Since:

EclipseLink 2.5.0

removeExtraNamespacesFromNamespaceResolver

public void removeExtraNamespacesFromNamespaceResolver(java.util.List<org.eclipse.persistence.internal.oxm.Namespace> extraNamespaces,
                                                       org.eclipse.persistence.internal.core.sessions.CoreAbstractSession session)

INTERNAL

Since:

EclipseLink 2.5.0

writeXsiTypeAttribute

public void writeXsiTypeAttribute(org.eclipse.persistence.internal.oxm.mappings.Descriptor xmlDescriptor,
                                  java.lang.String typeUri,
                                  java.lang.String typeLocal,
                                  java.lang.String typePrefix,
                                  boolean addToNamespaceResolver)

INTERNAL

Since:

EclipseLink 2.5.0

writeXsiTypeAttribute

protected void writeXsiTypeAttribute(org.eclipse.persistence.internal.oxm.mappings.Descriptor xmlDescriptor,
                                     XMLSchemaReference xmlRef,
                                     boolean addToNamespaceResolver)

INTERNAL

Since:

EclipseLink 2.5.0