oracle.jbo.mom.xml
Interface DefElement

All Superinterfaces:

DefNode

All Known Implementing Classes:

DefElementImpl, 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

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()
com.sun.java.util.collections.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)
com.sun.java.util.collections.ArrayList	getChildrenList() Gets all the child elements.
com.sun.java.util.collections.ArrayList	getChildrenList(short[] nodeTypes) Gets all the child nodes of the given types.
com.sun.java.util.collections.ArrayList	getChildrenList(short[] nodeTypes, java.lang.String childName) Gets the child nodes of the given types and node name.
com.sun.java.util.collections.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.
com.sun.java.util.collections.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
com.sun.java.util.collections.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)
com.sun.java.util.collections.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.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
com.sun.java.util.collections.ArrayList	readStringArrayList(java.lang.String attrName) Given the Attribute name loads the array
com.sun.java.util.collections.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
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

Method Detail

getElementName

public 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

public 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

public 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

public com.sun.java.util.collections.ArrayList getChildrenList()

Gets all the child elements.

Returns:

Returns the child ArrayList.

getChildrenList

public com.sun.java.util.collections.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

public com.sun.java.util.collections.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

public com.sun.java.util.collections.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

public 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

public com.sun.java.util.collections.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

public com.sun.java.util.collections.ArrayList getAttrsList()

Gets all the attributes of the element, in no particular order.

Returns:

ArrayList of DefNode objects that represent the attributes.

readInt

public 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

public 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

public 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

public 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

public 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

readStringArray

public 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

public com.sun.java.util.collections.ArrayList readStringArrayList(java.lang.String attrName)

Given the Attribute name loads the array

Parameters:

attrName - Name of the Attribute

Returns:

Returns the Vector

readStringArrayListElement

public com.sun.java.util.collections.ArrayList readStringArrayListElement(java.lang.String attrName)

Given the Attribute name loads the array

Parameters:

attrName - Name of the Attribute

Returns:

Returns the Vector

readClassName

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

loadProperties

public java.util.Hashtable loadProperties()

Loads the Jbo Properties

Returns:

Returns the Properties hashtable

loadPropertiesMap

public com.sun.java.util.collections.HashMap loadPropertiesMap()

Loads the Jbo Properties

Returns:

Returns the Properties hashtable

loadTable

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

loadTableMap

public com.sun.java.util.collections.HashMap loadTableMap(java.lang.String attrName,
                                                          java.lang.String elemName,
                                                          java.lang.String name,
                                                          java.lang.String value)

getTagName

public java.lang.String getTagName()

getAttribute

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

setAttribute

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

removeAttribute

public void removeAttribute(java.lang.String param1)

getAttributes

public NamedNodeMap getAttributes()

getChildNodes

public NodeList getChildNodes()

getChildrenByTagName

public NodeList getChildrenByTagName(java.lang.String param1)

getChildrenByTagName

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

getOwnerDocument

public Document getOwnerDocument()