org.eclipse.persistence.oxm.record
Class XMLRecord

java.lang.Object
  extended by org.eclipse.persistence.internal.sessions.AbstractRecord
      extended by org.eclipse.persistence.oxm.record.XMLRecord
All Implemented Interfaces:
Serializable, Cloneable, 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.NoEntry
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Field Summary
static org.eclipse.persistence.oxm.record.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
 
Constructor Summary
XMLRecord()
           
 
Method Summary
abstract  void clear()
          PUBLIC: Clear the sub-nodes of the DOM.
 boolean contains(Object value)
          PUBLIC: Check if the value is contained in the row.
 Object get(org.eclipse.persistence.internal.helper.DatabaseField key)
          INTERNAL: Retrieve the value for the field.
 Object getCurrentObject()
          INTERNAL:
 DocumentPreservationPolicy getDocPresPolicy()
           
abstract  Document getDocument()
          PUBLIC: Return the document.
abstract  Node getDOM()
          PUBLIC: Return the DOM.
 Object getIndicatingNoEntry(String fieldName)
          INTERNAL: Retrieve the value for the field name.
 QName getLeafElementType()
          INTERNAL:
abstract  String getLocalName()
          PUBLIC: Get the local name of the context root element.
 XMLMarshaller getMarshaller()
          INTERNAL:
 NamespaceResolver getNamespaceResolver()
           
abstract  String getNamespaceURI()
          PUBLIC: Get the namespace URI for the context root element.
 Object getOwningObject()
          INTERNAL:
 org.eclipse.persistence.internal.sessions.AbstractSession getSession()
           
 XMLUnmarshaller getUnmarshaller()
          INTERNAL:
 boolean isXOPPackage()
           
 String resolveNamespacePrefix(String prefix)
           
 void setCurrentObject(Object obj)
          INTERNAL:
 void setDocPresPolicy(DocumentPreservationPolicy policy)
           
 void setLeafElementType(QName type)
          INTERNAL:
 void setMarshaller(XMLMarshaller marshaller)
          INTERNAL:
 void setNamespaceResolver(NamespaceResolver nr)
           
 void setOwningObject(Object obj)
          INTERNAL:
 void setSession(org.eclipse.persistence.internal.sessions.AbstractSession session)
           
 void setUnmarshaller(XMLUnmarshaller unmarshaller)
          INTERNAL:
 void setXOPPackage(boolean isXOPPackage)
           
abstract  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, getValues, getValues, getValues, isEmpty, keys, keySet, mergeFrom, put, put, put, putAll, remove, remove, remove, replaceAt, size, toString, values
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Field Detail

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 String getLocalName()
PUBLIC: Get the local name of the context root element.


getNamespaceURI

public abstract 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 Map
Overrides:
clear in class org.eclipse.persistence.internal.sessions.AbstractRecord

getDocument

public abstract Document getDocument()
PUBLIC: Return the document.


contains

public boolean contains(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 Node getDOM()
PUBLIC: Return the DOM.


transformToXML

public abstract String transformToXML()
Return the XML string representation of the DOM.


get

public 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 Object getIndicatingNoEntry(String fieldName)
INTERNAL: Retrieve the value for the field name.

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

resolveNamespacePrefix

public String resolveNamespacePrefix(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 Object getOwningObject()
INTERNAL:


setOwningObject

public void setOwningObject(Object obj)
INTERNAL:


getCurrentObject

public Object getCurrentObject()
INTERNAL:


setCurrentObject

public void setCurrentObject(Object obj)
INTERNAL:


getLeafElementType

public QName getLeafElementType()
INTERNAL:


setLeafElementType

public void setLeafElementType(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)