IXMLElement is an XML element. It provides an easy to use generic interface
on top of an XML like data structure like e.g. a DOM like structure.
Elements returned by StdXMLBuilder also implement this interface.
addChild
public void addChild(IXMLElement child)
Adds a child element.
child
- the non-null child to add.
createElement
public IXMLElement createElement(String fullName)
Creates an empty element.
fullName
- the name of the element.
createElement
public IXMLElement createElement(String fullName,
String namespace)
Creates an empty element.
fullName
- the full name of the elementnamespace
- the namespace URI.
createElement
public IXMLElement createElement(String fullName,
String namespace,
String systemID,
int lineNr)
Creates an empty element.
fullName
- the full name of the elementnamespace
- the namespace URI.systemID
- the system ID of the XML data where the element starts.lineNr
- the line in the XML data where the element starts.
createElement
public IXMLElement createElement(String fullName,
String systemID,
int lineNr)
Creates an empty element.
fullName
- the name of the element.systemID
- the system ID of the XML data where the element starts.lineNr
- the line in the XML data where the element starts.
createPCDataElement
public IXMLElement createPCDataElement()
Creates an element to be used for #PCDATA content.
enumerateAttributeNames
public Enumeration enumerateAttributeNames()
Returns an enumeration of all attribute names.
- the non-null enumeration.
enumerateChildren
public Enumeration enumerateChildren()
Returns an enumeration of all child elements.
equals
public boolean equals(Object rawElement)
Returns true if the element equals another element.
rawElement
- the element to compare to
equalsXMLElement
public boolean equalsXMLElement(IXMLElement elt)
Returns true if the element equals another element.
getAttribute
public String getAttribute(String name)
As of NanoXML/Java 2.0.1, replaced by
getAttribute(java.lang.String,java.lang.String)
Returns the value of an attribute.
name
- the non-null name of the attribute.
- the value, or null if the attribute does not exist.
getAttribute
public String getAttribute(String name,
String defaultValue)
Returns the value of an attribute.
name
- the non-null full name of the attribute.defaultValue
- the default value of the attribute.
- the value, or defaultValue if the attribute does not exist.
getAttribute
public String getAttribute(String name,
String namespace,
String defaultValue)
Returns the value of an attribute.
name
- the non-null name of the attribute.namespace
- the namespace URI, which may be null.defaultValue
- the default value of the attribute.
- the value, or defaultValue if the attribute does not exist.
getAttribute
public int getAttribute(String name,
String namespace,
int defaultValue)
Returns the value of an attribute.
name
- the non-null name of the attribute.namespace
- the namespace URI, which may be null.defaultValue
- the default value of the attribute.
- the value, or defaultValue if the attribute does not exist.
getAttribute
public int getAttribute(String name,
int defaultValue)
Returns the value of an attribute.
name
- the non-null full name of the attribute.defaultValue
- the default value of the attribute.
- the value, or defaultValue if the attribute does not exist.
getAttributeCount
public int getAttributeCount()
Returns the number of attributes.
getAttributeNamespace
public String getAttributeNamespace(String name)
Returns the namespace of an attribute.
name
- the non-null full name of the attribute.
- the namespace, or null if there is none associated.
getAttributeType
public String getAttributeType(String name)
Returns the type of an attribute.
name
- the non-null full name of the attribute.
- the type, or null if the attribute does not exist.
getAttributeType
public String getAttributeType(String name,
String namespace)
Returns the type of an attribute.
name
- the non-null name of the attribute.namespace
- the namespace URI, which may be null.
- the type, or null if the attribute does not exist.
getAttributes
public Properties getAttributes()
Returns all attributes as a Properties object.
getAttributesInNamespace
public Properties getAttributesInNamespace(String namespace)
Returns all attributes in a specific namespace as a Properties object.
namespace
- the namespace URI of the attributes, which may be null.
getChildAtIndex
public IXMLElement getChildAtIndex(int index)
throws ArrayIndexOutOfBoundsException
Returns the child at a specific index.
index
- the index of the child
getChildren
public Vector getChildren()
Returns a vector containing all the child elements.
getChildrenCount
public int getChildrenCount()
Returns the number of children.
getChildrenNamed
public Vector getChildrenNamed(String name)
Returns a vector of all child elements named name.
name
- the full name of the children to search for.
- the non-null vector of child elements.
getChildrenNamed
public Vector getChildrenNamed(String name,
String namespace)
Returns a vector of all child elements named name.
name
- the name of the children to search for.namespace
- the namespace, which may be null.
- the non-null vector of child elements.
getContent
public String getContent()
Return the #PCDATA content of the element. If the element has a
combination of #PCDATA content and child elements, the #PCDATA
sections can be retrieved as unnamed child objects. In this case,
this method returns null.
getFirstChildNamed
public IXMLElement getFirstChildNamed(String name)
Searches a child element.
name
- the full name of the child to search for.
- the child element, or null if no such child was found.
getFirstChildNamed
public IXMLElement getFirstChildNamed(String name,
String namespace)
Searches a child element.
name
- the name of the child to search for.namespace
- the namespace, which may be null.
- the child element, or null if no such child was found.
getFullName
public String getFullName()
Returns the full name (i.e. the name including an eventual namespace
prefix) of the element.
- the name, or null if the element only contains #PCDATA.
getLineNr
public int getLineNr()
Returns the line number in the data where the element started.
- the line number, or NO_LINE if unknown.
getName
public String getName()
Returns the name of the element.
- the name, or null if the element only contains #PCDATA.
getNamespace
public String getNamespace()
Returns the namespace of the element.
- the namespace, or null if no namespace is associated with the
element.
getParent
public IXMLElement getParent()
Returns the parent element. This method returns null for the root
element.
getSystemID
public String getSystemID()
Returns the system ID of the data where the element started.
- the system ID, or null if unknown.
hasAttribute
public boolean hasAttribute(String name)
Returns whether an attribute exists.
name
- the non-null name of the attribute.
- true if the attribute exists.
hasAttribute
public boolean hasAttribute(String name,
String namespace)
Returns whether an attribute exists.
name
- the non-null name of the attribute.namespace
- the namespace URI of the attribute, which may be null.
- true if the attribute exists.
hasChildren
public boolean hasChildren()
Returns whether the element has children.
- true if the element has children.
isLeaf
public boolean isLeaf()
Returns whether the element is a leaf element.
- true if the element has no children.
removeAttribute
public void removeAttribute(String name)
Removes an attribute.
name
- the non-null name of the attribute.
removeAttribute
public void removeAttribute(String name,
String namespace)
Removes an attribute.
name
- the non-null name of the attribute.namespace
- the namespace URI of the attribute, which may be null.
removeChild
public void removeChild(IXMLElement child)
Removes a child element.
child
- the non-null child to remove.
removeChildAtIndex
public void removeChildAtIndex(int index)
Removes the child located at a certain index.
index
- the index of the child, where the first child has index 0.
setAttribute
public void setAttribute(String name,
String value)
Sets an attribute.
name
- the non-null full name of the attribute.value
- the non-null value of the attribute.
setAttribute
public void setAttribute(String fullName,
String namespace,
String value)
Sets an attribute.
fullName
- the non-null full name of the attribute.namespace
- the namespace URI of the attribute, which may be null.value
- the non-null value of the attribute.
setContent
public void setContent(String content)
Sets the #PCDATA content. It is an error to call this method with a
non-null value if there are child objects.
content
- the (possibly null) content.
setName
public void setName(String name)
Sets the full name. This method also sets the short name and clears the
namespace URI.
name
- the non-null name.
setName
public void setName(String fullName,
String namespace)
Sets the name.
fullName
- the non-null full name.namespace
- the namespace URI, which may be null.