org.eclipse.persistence.oxm.record
Class XMLRecord

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DOMRecord, MarshalRecord, UnmarshalRecord

public abstract class XMLRecord
extends org.eclipse.persistence.internal.sessions.AbstractRecord

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 java.util.Map

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

Field Summary

protected java.lang.Object	currentObject
protected XMLMarshaller	marshaller
static org.eclipse.persistence.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

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	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.
javax.xml.namespace.QName	getLeafElementType() INTERNAL:
abstract java.lang.String	getLocalName() PUBLIC: Get the local name of the context root element.
XMLMarshaller	getMarshaller() INTERNAL:
NamespaceResolver	getNamespaceResolver()
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	isXOPPackage()
java.lang.String	resolveNamespacePrefix(java.lang.String prefix)
void	setCurrentObject(java.lang.Object obj) INTERNAL:
void	setDocPresPolicy(DocumentPreservationPolicy policy)
void	setLeafElementType(javax.xml.namespace.QName 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.

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

add, clone, containsKey, containsKey, containsKey, containsValue, elements, entrySet, get, get, getField, getFields, getIndicatingNoEntry, getLookupField, getValues, getValues, getValues, hasNullValueInFields, isEmpty, keys, keySet, mergeFrom, put, 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

Field Detail

marshaller

protected XMLMarshaller marshaller

unmarshaller

protected XMLUnmarshaller unmarshaller

currentObject

protected java.lang.Object currentObject

session

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

NIL

public static final org.eclipse.persistence.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

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.

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)

getMarshaller

public XMLMarshaller getMarshaller()

INTERNAL:

setMarshaller

public void setMarshaller(XMLMarshaller marshaller)

INTERNAL:

getUnmarshaller

public XMLUnmarshaller getUnmarshaller()

INTERNAL:

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 javax.xml.namespace.QName getLeafElementType()

INTERNAL:

setLeafElementType

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

INTERNAL:

setNamespaceResolver

public void setNamespaceResolver(NamespaceResolver nr)

getNamespaceResolver

public NamespaceResolver getNamespaceResolver()

getSession

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

setSession

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

isXOPPackage

public boolean isXOPPackage()

setXOPPackage

public void setXOPPackage(boolean isXOPPackage)