EclipseLink 2.2.0, build 'v20110202-r8913' API Reference

org.eclipse.persistence.eis
Class EISDOMRecord

java.lang.Object
  extended by org.eclipse.persistence.internal.sessions.AbstractRecord
      extended by org.eclipse.persistence.oxm.record.XMLRecord
          extended by org.eclipse.persistence.oxm.record.DOMRecord
              extended by org.eclipse.persistence.eis.EISDOMRecord
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.Map, javax.resource.cci.MappedRecord, DOMRecord, Record

public class EISDOMRecord
extends DOMRecord
implements DOMRecord, javax.resource.cci.MappedRecord

An EISDOMRecord is a wrapper for a DOM tree. It provides a Record/Map API on an XML DOM element. This can be used from the platform to wrap adapter XML/DOM records to be used with TopLink XML.

See Also:
Serialized Form
Author:
James
Since:
OracleAS TopLink 10g (10.0.3)

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 static java.lang.reflect.Method domMethod
          Used for introspected DOM records.
protected  javax.resource.cci.Record record
          The original adapter record.
protected  java.lang.String recordName
          The record name.
protected  java.lang.String recordShortDescription
          The record name.
 
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
EISDOMRecord()
          Default constructor.
EISDOMRecord(org.w3c.dom.Element dom)
          Create a TopLink record from a DOM tree.
EISDOMRecord(javax.resource.cci.Record record)
          Create a TopLink record from the JCA adapter record.
EISDOMRecord(javax.resource.cci.Record record, org.w3c.dom.Element dom)
          Create a TopLink record from the JCA adapter record and DOM tree.
 
Method Summary
 XMLRecord buildNestedRow(org.w3c.dom.Element element)
          INTERNAL: Build the nested record, this can be overwriten by subclasses to use their subclass instance.
 javax.resource.cci.Record getRecord()
          Return the JCA adapter record.
 java.lang.String getRecordName()
          Forward to the record.
 java.lang.String getRecordShortDescription()
          Forward to the record.
 void setRecord(javax.resource.cci.Record record)
          Set the JCA adapter record.
 void setRecordName(java.lang.String recordName)
          Forward to the record.
 void setRecordShortDescription(java.lang.String recordShortDescription)
          Forward to the record.
 
Methods inherited from class org.eclipse.persistence.oxm.record.DOMRecord
add, clear, clone, contains, containsKey, createNewDocument, createNewDocument, entrySet, get, getDocument, getDOM, getFields, getIndicatingNoEntry, getIndicatingNoEntry, getIndicatingNoEntry, getLocalName, getNamespaceURI, getValues, getValues, getValues, getValues, getValuesIndicatingNoEntry, getValuesIndicatingNoEntry, getValuesIndicatingNoEntry, getValuesIndicatingNoEntry, getValuesIndicatingNoEntry, getValuesIndicatingNoEntry, keySet, put, put, put, remove, replaceAt, resolveNamespacePrefix, setDOM, setDOM, setFields, setValues, size, toString, transformFromXML, transformFromXML, transformToWriter, transformToXML, values
 
Methods inherited from class org.eclipse.persistence.oxm.record.XMLRecord
convertToXMLField, convertToXMLField, getCurrentObject, getDocPresPolicy, getIndicatingNoEntry, getLeafElementType, getMarshaller, getNamespaceResolver, getOwningObject, getSession, getUnmarshaller, isXOPPackage, setCurrentObject, setDocPresPolicy, setLeafElementType, setMarshaller, setNamespaceResolver, setOwningObject, setSession, setUnmarshaller, setXOPPackage
 
Methods inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord
containsKey, containsKey, containsValue, elements, get, get, getField, getLookupField, hasNullValueInFields, isEmpty, keys, mergeFrom, put, putAll, remove, remove, resetSize, setNullValueInFields
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.persistence.eis.DOMRecord
getDOM, setDOM
 
Methods inherited from interface javax.resource.cci.Record
clone, equals, hashCode
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Field Detail

record

protected javax.resource.cci.Record record
The original adapter record.


recordName

protected java.lang.String recordName
The record name.


recordShortDescription

protected java.lang.String recordShortDescription
The record name.


domMethod

protected static java.lang.reflect.Method domMethod
Used for introspected DOM records.

Constructor Detail

EISDOMRecord

public EISDOMRecord()
Default constructor.


EISDOMRecord

public EISDOMRecord(javax.resource.cci.Record record,
                    org.w3c.dom.Element dom)
Create a TopLink record from the JCA adapter record and DOM tree.


EISDOMRecord

public EISDOMRecord(org.w3c.dom.Element dom)
Create a TopLink record from a DOM tree.


EISDOMRecord

public EISDOMRecord(javax.resource.cci.Record record)
Create a TopLink record from the JCA adapter record. This attempts to introspect the record to retrieve the DOM tree.

Method Detail

getRecord

public javax.resource.cci.Record getRecord()
Return the JCA adapter record.


setRecord

public void setRecord(javax.resource.cci.Record record)
Set the JCA adapter record.


getRecordShortDescription

public java.lang.String getRecordShortDescription()
Forward to the record.


setRecordShortDescription

public void setRecordShortDescription(java.lang.String recordShortDescription)
Forward to the record.


getRecordName

public java.lang.String getRecordName()
Forward to the record.


setRecordName

public void setRecordName(java.lang.String recordName)
Forward to the record.


buildNestedRow

public XMLRecord buildNestedRow(org.w3c.dom.Element element)
INTERNAL: Build the nested record, this can be overwriten by subclasses to use their subclass instance.

Overrides:
buildNestedRow in class DOMRecord

EclipseLink 2.2.0, build 'v20110202-r8913' API Reference