XMLRecord (EclipseLink 2.6.3, "build v20160428-59c81c5" API Reference)

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, AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>, AbstractUnmarshalRecord<AbstractSession,DatabaseField,XMLUnmarshaller>, XMLRecord<AbstractSession>, Record

Direct Known Subclasses:

DOMRecord, UnmarshalRecord
```
public abstract class XMLRecord
extends AbstractRecord
implements AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>, AbstractUnmarshalRecord<AbstractSession,DatabaseField,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
  AbstractRecord.NoEntry
- Nested classes/interfaces inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord
  XMLRecord.Nil
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Field Summary

Fields
Modifier and Type Field and Description

static XMLRecord.Nil NIL
INTERNAL: Nil: This is used to indicate that this field represents xsi:nil="true"
- Fields inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord
  noEntry
- Fields inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord
  DEFAULT_ATTRIBUTE_GROUP

Fields
Modifier and Type	Field and Description
`static XMLRecord.Nil`	`NIL` INTERNAL: Nil: This is used to indicate that this field represents xsi:nil="true"

Constructor Summary

Constructors
Constructor and Description

XMLRecord()

Constructors
Constructor and Description
`XMLRecord()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<Namespace>`	`addExtraNamespacesToNamespaceResolver(Descriptor descriptor, CoreAbstractSession session, boolean allowOverride, boolean ignoreEqualResolvers)` INTERNAL
`boolean`	`addXsiTypeAndClassIndicatorIfRequired(Descriptor descriptor, Descriptor referenceDescriptor, Field xmlField, boolean isRootElement)` INTERNAL
`boolean`	`addXsiTypeAndClassIndicatorIfRequired(Descriptor descriptor, Descriptor referenceDescriptor, 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.
`java.lang.Object`	`get(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.
`ConversionManager`	`getConversionManager()` INTERNAL
`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.
`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:
`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<Namespace> extraNamespaces, 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 leafElementType)` INTERNAL:
`void`	`setLeafElementType(XPathQName leafElementType)` INTERNAL:
`void`	`setMarshaller(XMLMarshaller marshaller)` INTERNAL:
`void`	`setNamespaceResolver(NamespaceResolver nr)`
`void`	`setOwningObject(java.lang.Object owningObject)` INTERNAL:
`void`	`setSession(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(Descriptor descriptor, java.lang.String typeUri, java.lang.String typeLocal, java.lang.String typePrefix, boolean addToNamespaceResolver)` INTERNAL
`void`	`writeXsiTypeAttribute(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, getSopObject, getValues, getValues, getValues, hasNullValueInFields, hasSopObject, isEmpty, keys, keySet, mergeFrom, put, put, putAll, remove, remove, remove, replaceAt, replaceAt, setNullValueInFields, setSopObject, size, toString, values

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecord
put

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

- Field Detail
  - NIL
```
public static final 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 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 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 AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
    
    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
    
    Specified by:
    
    attribute in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
    
    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 AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
    
    Parameters:
    
    prefix -
    
    namespaceURI -
  - 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 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 AbstractRecord
  - getDOM
```
public abstract org.w3c.dom.Node getDOM()
```
    PUBLIC: Return the DOM.
    
    Specified by:
    
    getDOM in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
  - transformToXML
```
public abstract java.lang.String transformToXML()
```
    Return the XML string representation of the DOM.
  - get
```
public java.lang.Object get(DatabaseField key)
```
    INTERNAL: Retrieve the value for the field. If missing null is returned.
    
    Specified by:
    
    get in interface AbstractUnmarshalRecord<AbstractSession,DatabaseField,XMLUnmarshaller>
    
    Overrides:
    
    get in class AbstractRecord
  - getIndicatingNoEntry
```
public java.lang.Object getIndicatingNoEntry(java.lang.String fieldName)
```
    INTERNAL: Retrieve the value for the field name.
    
    Overrides:
    
    getIndicatingNoEntry in class AbstractRecord
  - resolveNamespacePrefix
```
public java.lang.String resolveNamespacePrefix(java.lang.String prefix)
```
    Specified by:
    
    resolveNamespacePrefix in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
    
    Specified by:
    
    resolveNamespacePrefix in interface AbstractUnmarshalRecord<AbstractSession,DatabaseField,XMLUnmarshaller>
  - getMarshaller
```
public XMLMarshaller getMarshaller()
```
    INTERNAL:
    
    Specified by:
    
    getMarshaller in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
  - setMarshaller
```
public void setMarshaller(XMLMarshaller marshaller)
```
    INTERNAL:
    
    Specified by:
    
    setMarshaller in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
  - getUnmarshaller
```
public XMLUnmarshaller getUnmarshaller()
```
    INTERNAL:
    
    Specified by:
    
    getUnmarshaller in interface AbstractUnmarshalRecord<AbstractSession,DatabaseField,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:
    
    Specified by:
    
    getOwningObject in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
  - setOwningObject
```
public void setOwningObject(java.lang.Object owningObject)
```
    INTERNAL:
    
    Specified by:
    
    setOwningObject in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
  - getCurrentObject
```
public java.lang.Object getCurrentObject()
```
    INTERNAL:
  - setCurrentObject
```
public void setCurrentObject(java.lang.Object obj)
```
    INTERNAL:
  - getLeafElementType
```
public XPathQName getLeafElementType()
```
    INTERNAL:
    
    Specified by:
    
    getLeafElementType in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
  - setLeafElementType
```
public void setLeafElementType(XPathQName leafElementType)
```
    INTERNAL:
    
    Specified by:
    
    setLeafElementType in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
  - setLeafElementType
```
public void setLeafElementType(javax.xml.namespace.QName leafElementType)
```
    INTERNAL:
    
    Specified by:
    
    setLeafElementType in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
  - setNamespaceResolver
```
public void setNamespaceResolver(NamespaceResolver nr)
```
    Specified by:
    
    setNamespaceResolver in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
  - getNamespaceResolver
```
public NamespaceResolver getNamespaceResolver()
```
    Specified by:
    
    getNamespaceResolver in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
  - getSession
```
public AbstractSession getSession()
```
    Specified by:
    
    getSession in interface XMLRecord<AbstractSession>
  - setSession
```
public void setSession(AbstractSession session)
```
    Specified by:
    
    setSession in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
  - setEqualNamespaceResolvers
```
public void setEqualNamespaceResolvers(boolean equalNRs)
```
    Specified by:
    
    setEqualNamespaceResolvers in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
  - hasEqualNamespaceResolvers
```
public boolean hasEqualNamespaceResolvers()
```
    Specified by:
    
    hasEqualNamespaceResolvers in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
  - isXOPPackage
```
public boolean isXOPPackage()
```
    Specified by:
    
    isXOPPackage in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
  - setXOPPackage
```
public void setXOPPackage(boolean isXOPPackage)
```
    Specified by:
    
    setXOPPackage in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
  - isNamespaceAware
```
public boolean isNamespaceAware()
```
    INTERNAL: Determine if namespaces will be considered during marshal/unmarshal operations.
    
    Specified by:
    
    isNamespaceAware in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
    
    Specified by:
    
    isNamespaceAware in interface XMLRecord<AbstractSession>
    
    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 XMLRecord<AbstractSession>
    
    Since:
    
    2.4
  - hasCustomNamespaceMapper
```
public boolean hasCustomNamespaceMapper()
```
    Specified by:
    
    hasCustomNamespaceMapper in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
  - setCustomNamespaceMapper
```
public void setCustomNamespaceMapper(boolean customNamespaceMapper)
```
    Specified by:
    
    setCustomNamespaceMapper in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
  - addExtraNamespacesToNamespaceResolver
```
public java.util.List<Namespace> addExtraNamespacesToNamespaceResolver(Descriptor descriptor,
                                                                       CoreAbstractSession session,
                                                                       boolean allowOverride,
                                                                       boolean ignoreEqualResolvers)
```
    INTERNAL
    
    Specified by:
    
    addExtraNamespacesToNamespaceResolver in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
    
    Since:
    
    EclipseLink 2.5.0
  - addXsiTypeAndClassIndicatorIfRequired
```
public boolean addXsiTypeAndClassIndicatorIfRequired(Descriptor descriptor,
                                                     Descriptor referenceDescriptor,
                                                     Field xmlField,
                                                     boolean isRootElement)
```
    INTERNAL
    
    Specified by:
    
    addXsiTypeAndClassIndicatorIfRequired in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
    
    Since:
    
    EclipseLink 2.5.0
  - addXsiTypeAndClassIndicatorIfRequired
```
public boolean addXsiTypeAndClassIndicatorIfRequired(Descriptor descriptor,
                                                     Descriptor referenceDescriptor,
                                                     Field xmlField,
                                                     java.lang.Object originalObject,
                                                     java.lang.Object obj,
                                                     boolean wasXMLRoot,
                                                     boolean isRootElement)
```
    INTERNAL
    
    Specified by:
    
    addXsiTypeAndClassIndicatorIfRequired in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
    
    Since:
    
    EclipseLink 2.5.0
  - removeExtraNamespacesFromNamespaceResolver
```
public void removeExtraNamespacesFromNamespaceResolver(java.util.List<Namespace> extraNamespaces,
                                                       CoreAbstractSession session)
```
    INTERNAL
    
    Specified by:
    
    removeExtraNamespacesFromNamespaceResolver in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
    
    Since:
    
    EclipseLink 2.5.0
  - writeXsiTypeAttribute
```
public void writeXsiTypeAttribute(Descriptor descriptor,
                                  java.lang.String typeUri,
                                  java.lang.String typeLocal,
                                  java.lang.String typePrefix,
                                  boolean addToNamespaceResolver)
```
    INTERNAL
    
    Specified by:
    
    writeXsiTypeAttribute in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
    
    Since:
    
    EclipseLink 2.5.0
  - writeXsiTypeAttribute
```
public void writeXsiTypeAttribute(Descriptor xmlDescriptor,
                                  XMLSchemaReference xmlRef,
                                  boolean addToNamespaceResolver)
```
    INTERNAL
    
    Specified by:
    
    writeXsiTypeAttribute in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
    
    Since:
    
    EclipseLink 2.5.0
  - getConversionManager
```
public ConversionManager getConversionManager()
```
    INTERNAL
    
    Specified by:
    
    getConversionManager in interface XMLRecord<AbstractSession>
    
    Since:
    
    EclipseLink 2.6.0

Class XMLRecord

Nested Class Summary

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

Nested classes/interfaces inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord

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

Field Summary

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

Fields inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecord

Methods inherited from interface java.util.Map

Field Detail

NIL

Constructor Detail

XMLRecord

Method Detail

get

put

attributeWithoutQName

attribute

namespaceDeclaration

getLocalName

getNamespaceURI

clear

getDocument

contains

getDOM

transformToXML

get

getIndicatingNoEntry

resolveNamespacePrefix

getMarshaller

setMarshaller

getUnmarshaller

setUnmarshaller

setDocPresPolicy

getDocPresPolicy

getOwningObject

setOwningObject

getCurrentObject

setCurrentObject

getLeafElementType

setLeafElementType

setLeafElementType

setNamespaceResolver

getNamespaceResolver

getSession

setSession

setEqualNamespaceResolvers

hasEqualNamespaceResolvers

isXOPPackage

setXOPPackage

isNamespaceAware

getNamespaceSeparator

hasCustomNamespaceMapper

setCustomNamespaceMapper

addExtraNamespacesToNamespaceResolver

addXsiTypeAndClassIndicatorIfRequired

addXsiTypeAndClassIndicatorIfRequired

removeExtraNamespacesFromNamespaceResolver

writeXsiTypeAttribute

writeXsiTypeAttribute

getConversionManager