Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1.4.0)

E10653-05

oracle.jbo.mom.xml
Interface DefElement

All Superinterfaces:
DefNode
All Known Implementing Classes:
DefElementImpl, ElementDefElement, WrapperDefElement

public interface DefElement
extends DefNode

This interface represents an element in a read-only representation (e.g. DOM or MDS MElement) of the XML for a document.


Field Summary
static short[] NODETYPES_TEXT_CDATA
           
 
Fields inherited from interface oracle.jbo.mom.xml.DefNode
ATTRIBUTE_NODE, CDATA_SECTION_NODE, ELEMENT_NODE, TEXT_NODE
 
Method Summary
 DefElement findChildElement(java.lang.String childName)
          Finds the first child element of the given node name
 java.lang.String getAttribute(java.lang.String param1)
           
 NamedNodeMap getAttributes()
           
 java.util.ArrayList getAttrsList()
          Gets all the attributes of the element, in no particular order.
 NodeList getChildNodes()
           
 java.util.Vector getChildren(java.lang.String childName)
          Gets the child elements of the given node name.
 NodeList getChildrenByTagName(java.lang.String param1)
           
 NodeList getChildrenByTagName(java.lang.String param1, java.lang.String param2)
           
 java.util.ArrayList getChildrenList()
          Gets all the child elements.
 java.util.ArrayList getChildrenList(short[] nodeTypes)
          Gets all the child nodes of the given types.
 java.util.ArrayList getChildrenList(short[] nodeTypes, java.lang.String childName)
          Gets the child nodes of the given types and node name.
 java.util.ArrayList getChildrenList(java.lang.String childName)
          Gets the child elements of the given node name.
 java.lang.String getElementName()
          Retrieves the node name of the element as a string.
 Document getOwnerDocument()
           
 java.util.Vector getSimilarChildren(java.lang.String childName)
          Gets the child elements with node names "similar to" the given node name (i.e.
 java.util.ArrayList getSimilarChildrenList(java.lang.String childName)
          Gets the child elements with node names "similar to" the given node name (i.e.
 java.lang.String getTagName()
           
 java.util.Hashtable loadProperties()
          Loads the Jbo Properties
 java.util.HashMap loadPropertiesMap()
          Loads the Jbo Properties
 java.util.Hashtable loadTable(java.lang.String attrName, java.lang.String elemName, java.lang.String name, java.lang.String value)
           
 java.util.HashMap loadTableMap(java.lang.String attrName, java.lang.String elemName, java.lang.String name, java.lang.String value)
           
 boolean readBoolean(java.lang.String attrName)
          Given the Object name and Attribute name loads that attribute
 java.lang.String readCDataObject(java.lang.String attrName)
           
 java.lang.Class readClassName(java.lang.String attrName)
           
 int readInt(java.lang.String attrName)
          Given the Object name and Attribute name loads that attribute and returns the int value.
 long readLong(java.lang.String attrName)
          Given the Object name and Attribute name loads that attribute
 java.lang.String readString(java.lang.String attrName)
          Given the Object name and Attribute name loads that attribute
 java.util.Vector readStringArray(java.lang.String attrName)
          Given the Attribute name loads the array
 java.util.ArrayList readStringArrayList(java.lang.String attrName)
          Given the Attribute name loads the array
 java.util.ArrayList readStringArrayListElement(java.lang.String attrName)
          Given the Attribute name loads the array
 java.lang.String readUserNodeValue(java.lang.String attrName)
          Given the Object name and Attribute name loads that attribute
 java.lang.String readUserObject(java.lang.String attrName)
           
 java.lang.String readUserObjectTrim(java.lang.String attrName)
           
 java.util.ArrayList readUserStringArrayListElement(java.lang.String elemName)
          Given the Attribute name loads the array
 java.util.HashMap readUserStringElementsMap(java.lang.String elemName)
           
 void removeAttribute(java.lang.String param1)
           
 void setAttribute(java.lang.String param1, java.lang.String param2)
           
 
Methods inherited from interface oracle.jbo.mom.xml.DefNode
getLocalName, getNamespaceURI, getNodeName, getNodeType, getNodeValue
 

Field Detail

NODETYPES_TEXT_CDATA

static final short[] NODETYPES_TEXT_CDATA
Method Detail

getElementName

java.lang.String getElementName()
Retrieves the node name of the element as a string. The string will be in uppercase. ### [edelaube 2005/02/19] really??

Returns:
Returns the node name of the element.

getChildren

java.util.Vector getChildren(java.lang.String childName)
Gets the child elements of the given node name.

Parameters:
childName - the node name of the child - null indicates all names.
Returns:
Returns the child Vector.

findChildElement

DefElement findChildElement(java.lang.String childName)
Finds the first child element of the given node name

Parameters:
childName - the node name of the child - null indicates all names.
Returns:
Returns the child.

getChildrenList

java.util.ArrayList getChildrenList()
Gets all the child elements.

Returns:
Returns the child ArrayList.

getChildrenList

java.util.ArrayList getChildrenList(short[] nodeTypes)
Gets all the child nodes of the given types.

Parameters:
nodeTypes - the types of nodes to be retrieved. Notes: (1) Only ELEMENT_NODE, TEXT_NODE, and CDATA_SECTION_NODE are currently supported. (2) The order in which node types are listed has no effect, even on performance.
Returns:
Returns the child ArrayList.

getChildrenList

java.util.ArrayList getChildrenList(java.lang.String childName)
Gets the child elements of the given node name.

Parameters:
childName - the node name of the child - null indicates all names.
Returns:
Returns the child ArrayList.

getChildrenList

java.util.ArrayList getChildrenList(short[] nodeTypes,
                                    java.lang.String childName)
Gets the child nodes of the given types and node name.

Parameters:
nodeTypes - the types of nodes to be retrieved. Notes: (1) Only ELEMENT_NODE, TEXT_NODE, and CDATA_SECTION_NODE are currently supported. (2) The order in which node types are listed has no effect, even on performance.
childName - the node name of the child - null indicates all names.
Returns:
Returns the child ArrayList.

getSimilarChildren

java.util.Vector getSimilarChildren(java.lang.String childName)
Gets the child elements with node names "similar to" the given node name (i.e. whose node names contain the given node name as a substring).

Parameters:
childName - the substring within node name of the child.
Returns:
Returns the child Vector.

getSimilarChildrenList

java.util.ArrayList getSimilarChildrenList(java.lang.String childName)
Gets the child elements with node names "similar to" the given node name (i.e. whose node names contain the given node name as a substring).

Parameters:
childName - the Substring within node name of the child.
Returns:
Returns the child ArrayList.

getAttrsList

java.util.ArrayList getAttrsList()
Gets all the attributes of the element, in no particular order.

Returns:
ArrayList of DefNode objects that represent the attributes.

readInt

int readInt(java.lang.String attrName)
Given the Object name and Attribute name loads that attribute and returns the int value. If no such attribute found, returns 0 for the attribute default value.

Parameters:
attrName - Name of the Attribute
Returns:
Returns the Attribute

readLong

long readLong(java.lang.String attrName)
Given the Object name and Attribute name loads that attribute

Parameters:
attrName - Name of the Attribute
Returns:
Returns the Attribute

readBoolean

boolean readBoolean(java.lang.String attrName)
Given the Object name and Attribute name loads that attribute

Parameters:
attrName - Name of the Attribute
Returns:
Returns the Attribute

readString

java.lang.String readString(java.lang.String attrName)
Given the Object name and Attribute name loads that attribute

Parameters:
attrName - Name of the Attribute
Returns:
Returns the Attribute

readUserNodeValue

java.lang.String readUserNodeValue(java.lang.String attrName)
Given the Object name and Attribute name loads that attribute

Parameters:
attrName - Name of the Attribute
Returns:
Returns the Attribute

readUserStringArrayListElement

java.util.ArrayList readUserStringArrayListElement(java.lang.String elemName)
Given the Attribute name loads the array

Parameters:
elemName - Name of the child element that is a list of CData strings
Returns:
Returns the List of CData strings

readUserStringElementsMap

java.util.HashMap readUserStringElementsMap(java.lang.String elemName)

readCDataObject

java.lang.String readCDataObject(java.lang.String attrName)

readUserObject

java.lang.String readUserObject(java.lang.String attrName)

readUserObjectTrim

java.lang.String readUserObjectTrim(java.lang.String attrName)

readStringArray

java.util.Vector readStringArray(java.lang.String attrName)
Given the Attribute name loads the array

Parameters:
attrName - Name of the Attribute
Returns:
Returns the Vector

readStringArrayList

java.util.ArrayList readStringArrayList(java.lang.String attrName)
Given the Attribute name loads the array

Parameters:
attrName - Name of the Attribute
Returns:
Returns the Vector

readStringArrayListElement

java.util.ArrayList readStringArrayListElement(java.lang.String attrName)
Given the Attribute name loads the array

Parameters:
attrName - Name of the Attribute
Returns:
Returns the Vector

readClassName

java.lang.Class readClassName(java.lang.String attrName)

loadProperties

java.util.Hashtable loadProperties()
Loads the Jbo Properties

Returns:
Returns the Properties hashtable

loadPropertiesMap

java.util.HashMap loadPropertiesMap()
Loads the Jbo Properties

Returns:
Returns the Properties hashtable

loadTable

java.util.Hashtable loadTable(java.lang.String attrName,
                              java.lang.String elemName,
                              java.lang.String name,
                              java.lang.String value)

loadTableMap

java.util.HashMap loadTableMap(java.lang.String attrName,
                               java.lang.String elemName,
                               java.lang.String name,
                               java.lang.String value)

getTagName

java.lang.String getTagName()

getAttribute

java.lang.String getAttribute(java.lang.String param1)

setAttribute

void setAttribute(java.lang.String param1,
                  java.lang.String param2)

removeAttribute

void removeAttribute(java.lang.String param1)

getAttributes

NamedNodeMap getAttributes()

getChildNodes

NodeList getChildNodes()

getChildrenByTagName

NodeList getChildrenByTagName(java.lang.String param1)

getChildrenByTagName

NodeList getChildrenByTagName(java.lang.String param1,
                              java.lang.String param2)

getOwnerDocument

Document getOwnerDocument()

Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1.4.0)

E10653-05

Copyright © 1997, 2011, Oracle. All rights reserved.