All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class oracle.xml.parser.v2.XMLElement

java.lang.Object
   |
   +----oracle.xml.parser.v2.XMLNode
           |
           +----oracle.xml.parser.v2.XMLElement

public class XMLElement

extends XMLNode

implements Element, Serializable, NSName, NSResolver

See Also:

Element, XMLParser, NodeFactory, setNodeFactory

XMLElement(String)

Creates an element with the given name

XMLElement(String, boolean)

Creates an element with the given name

XMLElement(String, String, String)

Creates an element with the given name, prefix, and namespace

checkNamespace(String, String)

Returns if the element belongs to the namespace specified.

cloneNode(boolean)

Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.

getAttribute(String)

Retrieves an attribute value by name.

getAttributeNode(String)

Retrieves an Attr node by name.

getAttributes()

A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

getChildrenByTagName(String)

Returns a NodeList of all immediate children with a given tag name,

getChildrenByTagName(String, String)

Returns a NodeList of all immediate children with a given tag name and namespace

getElementsByTagName(String)

Returns a NodeList of all descendant elements with a given tag name, in the order in which they would be encountered in a preorder traversal of the Element tree.

getElementsByTagName(String, String)

Returns a NodeList of all descendant elements with a given tag name, and namespace in the order in which they would be encountered in a preorder traversal of the Element tree.

getExpandedName()

Get the fully resolved name for this element.

getLocalName()

Get the local Name for this element.

getNamespace()

Get the resolved Namespace for this element.

getPrefix()

Get the namespace prefix for this element.

getQualifiedName()

Get the qualified name for this element.

getTagName()

Gets the name of the element.

normalize()

Puts all Text nodes in the full depth of the sub-tree underneath this Element into a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are no adjacent Text nodes.

removeAttribute(String)

Removes an attribute by name.

removeAttributeNode(Attr)

Removes the specified attribute.

resolveNamespacePrefix(String)

Given a namespace prefix, find the namespace definition in scope in this element.

setAttribute(String, String)

Adds a new attribute.

setAttributeNode(Attr)

Adds a new attribute.

 public XMLElement(String tag)

Creates an element with the given name

Parameters:

tag - Name of the element

 public XMLElement(String tag,
                   boolean empty)

Creates an element with the given name

Parameters:

tag - Name of the element

empty - flag to indicate if the element is empty

 public XMLElement(String name,
                   String prefix,
                   String namespace)

Creates an element with the given name, prefix, and namespace

Parameters:

name - Local name of the element

prefix - Prefix of the element

namespace - Namespace of the element

 public String getTagName()

Gets the name of the element. For example, in: <elementExample id="demo"> ... </elementExample> , tagName has the value "elementExample". Note that this is case-preserving in XML, as are all of the operations of the DOM. The HTML DOM returns the tagName of an HTML element in the canonical uppercase form, regardless of the case in the source HTML document.

Returns:

The element name

 public String getQualifiedName()

Get the qualified name for this element.

Returns:

the qualified name

 public String getNamespace()

Get the resolved Namespace for this element.

Returns:

the resolved Namespace

 public String getLocalName()

Get the local Name for this element.

Returns:

the local Name

 public String getPrefix()

Get the namespace prefix for this element.

Returns:

the namespace prefix

 public String getExpandedName()

Get the fully resolved name for this element.

Returns:

the fully resolved name

 public String getAttribute(String name)

Retrieves an attribute value by name.

Parameters:

name - The name of the attribute to retrieve.

Returns:

The Attr value as a string, or the empty string if that attribute does not have a specified or default value.

 public void setAttribute(String name,
                          String value) throws DOMException

Adds a new attribute. If an attribute with that name is already present in the element, its value is changed to be that of the value parameter. This value is a simple string, it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an Attr node plus any Text and EntityReference nodes, build the appropriate subtree, and use setAttributeNode to assign it as the value of an attribute.

Parameters:

name - The name of the attribute to create or alter.

value - Value to set in string form.

Throws: DOMException

INVALID_CHARACTER_ERR: Raised if the specified name contains an invalid character.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

 public void removeAttribute(String name) throws DOMException

Removes an attribute by name. If the removed attribute has a default value it is immediately replaced.

Parameters:

name - The name of the attribute to remove.

Throws: DOMException

NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

 public Attr getAttributeNode(String name)

Retrieves an Attr node by name.

Parameters:

name - The name of the attribute to retrieve.

Returns:

The Attr node with the specified attribute name or null if there is no such attribute.

 public Attr setAttributeNode(Attr newAttr) throws DOMException

Adds a new attribute. If an attribute with that name is already present in the element, it is replaced by the new one.

Parameters:

newAttr - The Attr node to add to the attribute list.

Returns:

If the newAttr attribute replaces an existing attribute with the same name, the previously existing Attr node is returned, otherwise null is returned.

Throws: DOMException

WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.

 public Attr removeAttributeNode(Attr oldAttr) throws DOMException

Removes the specified attribute.

Parameters:

oldAttr - The Attr node to remove from the attribute list. If the removed Attr has a default value it is immediately replaced.

Returns:

The Attr node that was removed.

Throws: DOMException

NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldAttr is not an attribute of the element.

 public boolean checkNamespace(String localname,
                               String ns)

Returns if the element belongs to the namespace specified.

Parameters:

ns - Expanded namespace string

Returns:

true - if the element belongs to the namespace

 public NodeList getChildrenByTagName(String name)

Returns a NodeList of all immediate children with a given tag name,

Parameters:

name - The name of the tag to match on.

Returns:

A list of matching children

 public NodeList getChildrenByTagName(String name,
                                      String ns)

Returns a NodeList of all immediate children with a given tag name and namespace

Parameters:

name - The name of the tag to match on. (should be local name)

ns - The name space

Returns:

A list of matching children

 public NodeList getElementsByTagName(String name)

Returns a NodeList of all descendant elements with a given tag name, in the order in which they would be encountered in a preorder traversal of the Element tree.

Parameters:

name - The name of the tag to match on. The special value "*" matches all tags.

Returns:

A list of matching Element nodes.

 public NodeList getElementsByTagName(String name,
                                      String ns)

Returns a NodeList of all descendant elements with a given tag name, and namespace in the order in which they would be encountered in a preorder traversal of the Element tree.

Parameters:

name - The name of the tag to match on. The special value "*" matches all tags. (should be local name)

ns - The namespace of the elements

Returns:

A list of matching Element nodes.

 public String resolveNamespacePrefix(String prefix)

Given a namespace prefix, find the namespace definition in scope in this element.

Parameters:

prefix - Namespace prefix to be resolved

Returns:

the resolved Namespace (null, if prefix could not be resolved)

 public void normalize()

Puts all Text nodes in the full depth of the sub-tree underneath this Element into a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are no adjacent Text nodes. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer lookups) that depend on a particular doc1ument tree structure are to be used.

 public NamedNodeMap getAttributes()

A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

Returns:

The list of attributes of this element

Overrides:

getAttributes in class XMLNode

 public Node cloneNode(boolean deep)

Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent ( parentNode returns null.).
Cloning an Element copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any text it contains unless it is a deep clone, since the text is contained in a child Text node. Cloning any other type of node simply returns a copy of this node.

Parameters:

deep - If true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element).

Returns:

The duplicate node.

Overrides:

cloneNode in class XMLNode

All Packages  Class Hierarchy  This Package  Previous  Next  Index