|
EclipseLink 1.1.0_ 1.1.0.r3634 API Reference | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.persistence.internal.sessions.AbstractRecord
org.eclipse.persistence.oxm.record.XMLRecord
org.eclipse.persistence.oxm.record.DOMRecord
public class DOMRecord
PUBLIC: Provides a Record/Map API on an XML DOM element.
| 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 |
|---|
| Fields inherited from class org.eclipse.persistence.oxm.record.XMLRecord |
|---|
session |
| Fields inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord |
|---|
fields, lookupField, noEntry, size, values |
| Constructor Summary | |
|---|---|
DOMRecord()
INTERNAL: Default constructor. |
|
DOMRecord(org.w3c.dom.Document document)
INTERNAL: Create a record with the element. |
|
DOMRecord(org.w3c.dom.Element element)
INTERNAL: Create a record with the element. |
|
DOMRecord(org.w3c.dom.Node node)
|
|
DOMRecord(java.lang.String rootElementName)
INTERNAL: Create a record with the root element name. |
|
DOMRecord(java.lang.String rootElementName,
NamespaceResolver namespaceResolver)
INTERNAL: Create a record with the root element name get the namespace URI from the namespaceResolver. |
|
DOMRecord(java.lang.String localRootElementName,
NamespaceResolver namespaceResolver,
org.w3c.dom.Node parent)
INTERNAL: Create a record with the local root element name, that is a child of the parent. |
|
DOMRecord(java.lang.String localRootElementName,
org.w3c.dom.Node parent)
INTERNAL: Create a record with the local root element name, that is a child of the parent. |
|
DOMRecord(java.lang.String rootElementName,
java.lang.String rootElementNamespaceURI)
INTERNAL: Create a record with the root element name get the namespace URI from the namespaceResolver. |
|
| Method Summary | |
|---|---|
void |
add(org.eclipse.persistence.internal.helper.DatabaseField key,
java.lang.Object value)
INTERNAL: Add the field-value pair to the document. |
XMLRecord |
buildNestedRow(org.w3c.dom.Element element)
INTERNAL: Build the nested record, this can be overwriten by subclasses to use their subclass instance. |
void |
clear()
PUBLIC: Clear the sub-nodes of the DOM. |
java.lang.Object |
clone()
INTERNAL: Clone the row and its values. |
boolean |
contains(java.lang.Object value)
PUBLIC: Check if the value is contained in the row. |
boolean |
containsKey(org.eclipse.persistence.internal.helper.DatabaseField key)
INTERNAL: Check if the field is contained in the row. |
org.w3c.dom.Node |
createNewDocument(java.lang.String defaultRootElementName)
INTERNAL: Creates a new Document and returns the root element of that document |
org.w3c.dom.Node |
createNewDocument(java.lang.String defaultRootElementName,
java.lang.String namespaceURI)
INTERNAL: Creates a new Document and returns the root element of that document |
java.util.Set |
entrySet()
PUBLIC: |
java.lang.Object |
get(org.eclipse.persistence.internal.helper.DatabaseField key)
INTERNAL: Retrieve the value for the field. |
org.w3c.dom.Document |
getDocument()
PUBLIC: Return the document. |
org.w3c.dom.Node |
getDOM()
PUBLIC: Return the DOM. |
java.util.Vector |
getFields()
INTERNAL: This should not be used, but added some support for it as is called from some places such as sdk call used in the descriptor to define operation not supported, may also be called from toplin in some places. |
java.lang.Object |
getIndicatingNoEntry(org.eclipse.persistence.internal.helper.DatabaseField key)
INTERNAL: Given a DatabaseField return the corresponding value from the document |
java.lang.Object |
getIndicatingNoEntry(org.eclipse.persistence.internal.helper.DatabaseField key,
boolean shouldReturnNode)
|
java.lang.String |
getLocalName()
PUBLIC: Get the local name of the context root element. |
java.lang.String |
getNamespaceURI()
PUBLIC: Get the namespace URI for the context root element. |
java.util.Vector |
getValues()
INTERNAL: This should not be used, but added some support for it as is called from some places such as sdk call used in the descriptor to define operation not supported, may also be called from TopLink in some places. |
java.lang.Object |
getValues(org.eclipse.persistence.internal.helper.DatabaseField key)
INTERNAL: Given a DatabaseField, return the corresponding values from the document |
java.lang.Object |
getValues(java.lang.String key)
INTERNAL: Retrieve the value for the field name. |
java.lang.Object |
getValuesIndicatingNoEntry(org.eclipse.persistence.internal.helper.DatabaseField key)
|
java.lang.Object |
getValuesIndicatingNoEntry(org.eclipse.persistence.internal.helper.DatabaseField key,
boolean shouldReturnNodes)
INTERNAL: Given a DatabaseField, return the corresponding values from the document |
java.util.Set |
keySet()
PUBLIC: Return the set of element names from the DOM. |
java.lang.Object |
put(org.eclipse.persistence.internal.helper.DatabaseField key,
java.lang.Object value)
INTERNAL: Set the field value into the DOM. |
java.lang.Object |
remove(org.eclipse.persistence.internal.helper.DatabaseField key)
INTERNAL: Remove the field key from the row. |
void |
replaceAt(java.lang.Object value,
int index)
INTERNAL: replaces the value at index with value |
java.lang.String |
resolveNamespacePrefix(java.lang.String prefix)
|
void |
setDOM(org.w3c.dom.Element element)
|
void |
setDOM(org.w3c.dom.Node element)
INTERNAL: Sets the dom and updated document to be the owner document of the given element |
protected void |
setFields(java.util.Vector fields)
INTERNAL: Setting fields vector will not update the document so this is not supported |
protected void |
setValues(java.util.Vector values)
INTERNAL: Setting values vector will not update the document so this is not supported |
int |
size()
Return the number of elements in the DOM. |
java.lang.String |
toString()
INTERNAL: Print the dom XML string. |
void |
transformFromXML(java.io.Reader reader)
Set the XML from an XML reader. |
void |
transformFromXML(java.lang.String xml)
Set the XML from an XML string. |
void |
transformToWriter(java.io.Writer writer)
Write the XML string representation of the DOM. |
java.lang.String |
transformToXML()
Return the XML string representation of the DOM. |
java.util.Collection |
values()
PUBLIC: Return the collection of element values from the DOM. |
| Methods inherited from class org.eclipse.persistence.oxm.record.XMLRecord |
|---|
convertToXMLField, getCurrentObject, getDocPresPolicy, getIndicatingNoEntry, getLeafElementType, getMarshaller, getNamespaceResolver, getOwningObject, getSession, getUnmarshaller, setCurrentObject, setDocPresPolicy, setLeafElementType, setMarshaller, setNamespaceResolver, setOwningObject, setSession, setUnmarshaller |
| Methods inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord |
|---|
containsKey, containsKey, containsValue, elements, get, get, getField, isEmpty, keys, mergeFrom, put, put, putAll, remove, remove, resetSize |
| 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 |
| Constructor Detail |
|---|
public DOMRecord()
public DOMRecord(java.lang.String rootElementName)
public DOMRecord(java.lang.String rootElementName,
NamespaceResolver namespaceResolver)
public DOMRecord(java.lang.String rootElementName,
java.lang.String rootElementNamespaceURI)
public DOMRecord(java.lang.String localRootElementName,
org.w3c.dom.Node parent)
public DOMRecord(java.lang.String localRootElementName,
NamespaceResolver namespaceResolver,
org.w3c.dom.Node parent)
public DOMRecord(org.w3c.dom.Element element)
public DOMRecord(org.w3c.dom.Node node)
public DOMRecord(org.w3c.dom.Document document)
| Method Detail |
|---|
public java.lang.String getLocalName()
getLocalName in class XMLRecordpublic java.lang.String getNamespaceURI()
getNamespaceURI in class XMLRecord
public void add(org.eclipse.persistence.internal.helper.DatabaseField key,
java.lang.Object value)
add in class org.eclipse.persistence.internal.sessions.AbstractRecordpublic void clear()
clear in interface java.util.Mapclear in class XMLRecordpublic java.lang.Object clone()
clone in class org.eclipse.persistence.internal.sessions.AbstractRecordpublic org.w3c.dom.Node createNewDocument(java.lang.String defaultRootElementName)
public org.w3c.dom.Node createNewDocument(java.lang.String defaultRootElementName,
java.lang.String namespaceURI)
public org.w3c.dom.Document getDocument()
getDocument in class XMLRecordpublic boolean containsKey(org.eclipse.persistence.internal.helper.DatabaseField key)
containsKey in class org.eclipse.persistence.internal.sessions.AbstractRecordpublic boolean contains(java.lang.Object value)
contains in class XMLRecordpublic java.lang.Object get(org.eclipse.persistence.internal.helper.DatabaseField key)
XMLRecord
get in class XMLRecordpublic java.lang.Object getIndicatingNoEntry(org.eclipse.persistence.internal.helper.DatabaseField key)
getIndicatingNoEntry in class org.eclipse.persistence.internal.sessions.AbstractRecord
public java.lang.Object getIndicatingNoEntry(org.eclipse.persistence.internal.helper.DatabaseField key,
boolean shouldReturnNode)
public java.lang.Object getValues(java.lang.String key)
getValues in class org.eclipse.persistence.internal.sessions.AbstractRecordpublic java.lang.Object getValues(org.eclipse.persistence.internal.helper.DatabaseField key)
getValues in class org.eclipse.persistence.internal.sessions.AbstractRecordpublic java.lang.Object getValuesIndicatingNoEntry(org.eclipse.persistence.internal.helper.DatabaseField key)
public java.lang.Object getValuesIndicatingNoEntry(org.eclipse.persistence.internal.helper.DatabaseField key,
boolean shouldReturnNodes)
public XMLRecord buildNestedRow(org.w3c.dom.Element element)
public org.w3c.dom.Node getDOM()
getDOM in class XMLRecord
public java.lang.Object put(org.eclipse.persistence.internal.helper.DatabaseField key,
java.lang.Object value)
put in class org.eclipse.persistence.internal.sessions.AbstractRecordpublic java.lang.Object remove(org.eclipse.persistence.internal.helper.DatabaseField key)
remove in class org.eclipse.persistence.internal.sessions.AbstractRecord
public void replaceAt(java.lang.Object value,
int index)
replaceAt in class org.eclipse.persistence.internal.sessions.AbstractRecordpublic java.util.Set entrySet()
entrySet in interface java.util.MapentrySet in class org.eclipse.persistence.internal.sessions.AbstractRecord
protected void setFields(java.util.Vector fields)
throws XMLMarshalException
setFields in class org.eclipse.persistence.internal.sessions.AbstractRecordXMLMarshalExceptionpublic java.util.Vector getFields()
getFields in class org.eclipse.persistence.internal.sessions.AbstractRecordpublic java.util.Vector getValues()
getValues in class org.eclipse.persistence.internal.sessions.AbstractRecord
protected void setValues(java.util.Vector values)
throws XMLMarshalException
setValues in class org.eclipse.persistence.internal.sessions.AbstractRecordXMLMarshalExceptionpublic void setDOM(org.w3c.dom.Node element)
public void setDOM(org.w3c.dom.Element element)
public java.lang.String toString()
toString in class org.eclipse.persistence.internal.sessions.AbstractRecordpublic java.util.Set keySet()
keySet in interface java.util.MapkeySet in class org.eclipse.persistence.internal.sessions.AbstractRecordpublic java.util.Collection values()
values in interface java.util.Mapvalues in class org.eclipse.persistence.internal.sessions.AbstractRecordpublic int size()
size in interface java.util.Mapsize in class org.eclipse.persistence.internal.sessions.AbstractRecordpublic void transformFromXML(java.lang.String xml)
public void transformFromXML(java.io.Reader reader)
public java.lang.String transformToXML()
transformToXML in class XMLRecordpublic void transformToWriter(java.io.Writer writer)
public java.lang.String resolveNamespacePrefix(java.lang.String prefix)
resolveNamespacePrefix in class XMLRecord
|
EclipseLink 1.1.0_ 1.1.0.r3634 API Reference | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||