net.n3.nanoxml

Interface IXMLElement

Known Implementing Classes:
XMLElement

public interface IXMLElement

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.
Version:
$Name: RELEASE_2_2_1 $, $Revision: 1.4 $
Author:
Marc De Scheemaecker
See Also:
StdXMLBuilder

Field Summary

static int
NO_LINE
No line number defined.

Method Summary

void
addChild(IXMLElement child)
Adds a child element.
IXMLElement
createElement(String fullName)
Creates an empty element.
IXMLElement
createElement(String fullName, String namespace)
Creates an empty element.
IXMLElement
createElement(String fullName, String namespace, String systemID, int lineNr)
Creates an empty element.
IXMLElement
createElement(String fullName, String systemID, int lineNr)
Creates an empty element.
IXMLElement
createPCDataElement()
Creates an element to be used for #PCDATA content.
Enumeration
enumerateAttributeNames()
Returns an enumeration of all attribute names.
Enumeration
enumerateChildren()
Returns an enumeration of all child elements.
boolean
equals(Object rawElement)
Returns true if the element equals another element.
boolean
equalsXMLElement(IXMLElement elt)
Returns true if the element equals another element.
String
getAttribute(String name)
Deprecated. As of NanoXML/Java 2.0.1, replaced by getAttribute(java.lang.String,java.lang.String) Returns the value of an attribute.
String
getAttribute(String name, String defaultValue)
Returns the value of an attribute.
String
getAttribute(String name, String namespace, String defaultValue)
Returns the value of an attribute.
int
getAttribute(String name, String namespace, int defaultValue)
Returns the value of an attribute.
int
getAttribute(String name, int defaultValue)
Returns the value of an attribute.
int
getAttributeCount()
Returns the number of attributes.
String
getAttributeNamespace(String name)
Returns the namespace of an attribute.
String
getAttributeType(String name)
Returns the type of an attribute.
String
getAttributeType(String name, String namespace)
Returns the type of an attribute.
Properties
getAttributes()
Returns all attributes as a Properties object.
Properties
getAttributesInNamespace(String namespace)
Returns all attributes in a specific namespace as a Properties object.
IXMLElement
getChildAtIndex(int index)
Returns the child at a specific index.
Vector
getChildren()
Returns a vector containing all the child elements.
int
getChildrenCount()
Returns the number of children.
Vector
getChildrenNamed(String name)
Returns a vector of all child elements named name.
Vector
getChildrenNamed(String name, String namespace)
Returns a vector of all child elements named name.
String
getContent()
Return the #PCDATA content of the element.
IXMLElement
getFirstChildNamed(String name)
Searches a child element.
IXMLElement
getFirstChildNamed(String name, String namespace)
Searches a child element.
String
getFullName()
Returns the full name (i.e.
int
getLineNr()
Returns the line number in the data where the element started.
String
getName()
Returns the name of the element.
String
getNamespace()
Returns the namespace of the element.
IXMLElement
getParent()
Returns the parent element.
String
getSystemID()
Returns the system ID of the data where the element started.
boolean
hasAttribute(String name)
Returns whether an attribute exists.
boolean
hasAttribute(String name, String namespace)
Returns whether an attribute exists.
boolean
hasChildren()
Returns whether the element has children.
boolean
isLeaf()
Returns whether the element is a leaf element.
void
removeAttribute(String name)
Removes an attribute.
void
removeAttribute(String name, String namespace)
Removes an attribute.
void
removeChild(IXMLElement child)
Removes a child element.
void
removeChildAtIndex(int index)
Removes the child located at a certain index.
void
setAttribute(String name, String value)
Sets an attribute.
void
setAttribute(String fullName, String namespace, String value)
Sets an attribute.
void
setContent(String content)
Sets the #PCDATA content.
void
setName(String name)
Sets the full name.
void
setName(String fullName, String namespace)
Sets the name.

Field Details

NO_LINE

public static final int NO_LINE
No line number defined.
Field Value:
-1

Method Details

addChild

public void addChild(IXMLElement child)
Adds a child element.
Parameters:
child - the non-null child to add.

createElement

public IXMLElement createElement(String fullName)
Creates an empty element.
Parameters:
fullName - the name of the element.

createElement

public IXMLElement createElement(String fullName,
                                 String namespace)
Creates an empty element.
Parameters:
fullName - the full name of the element
namespace - the namespace URI.

createElement

public IXMLElement createElement(String fullName,
                                 String namespace,
                                 String systemID,
                                 int lineNr)
Creates an empty element.
Parameters:
fullName - the full name of the element
namespace - 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.
Parameters:
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.
Returns:
the non-null enumeration.

enumerateChildren

public Enumeration enumerateChildren()
Returns an enumeration of all child elements.
Returns:
the non-null enumeration

equals

public boolean equals(Object rawElement)
Returns true if the element equals another element.
Parameters:
rawElement - the element to compare to

equalsXMLElement

public boolean equalsXMLElement(IXMLElement elt)
Returns true if the element equals another element.
Parameters:

getAttribute

public String getAttribute(String name)

Deprecated. As of NanoXML/Java 2.0.1, replaced by getAttribute(java.lang.String,java.lang.String) Returns the value of an attribute.

Parameters:
name - the non-null name of the attribute.
Returns:
the value, or null if the attribute does not exist.

getAttribute

public String getAttribute(String name,
                           String defaultValue)
Returns the value of an attribute.
Parameters:
name - the non-null full name of the attribute.
defaultValue - the default value of the attribute.
Returns:
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.
Parameters:
name - the non-null name of the attribute.
namespace - the namespace URI, which may be null.
defaultValue - the default value of the attribute.
Returns:
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.
Parameters:
name - the non-null name of the attribute.
namespace - the namespace URI, which may be null.
defaultValue - the default value of the attribute.
Returns:
the value, or defaultValue if the attribute does not exist.

getAttribute

public int getAttribute(String name,
                        int defaultValue)
Returns the value of an attribute.
Parameters:
name - the non-null full name of the attribute.
defaultValue - the default value of the attribute.
Returns:
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.
Parameters:
name - the non-null full name of the attribute.
Returns:
the namespace, or null if there is none associated.

getAttributeType

public String getAttributeType(String name)
Returns the type of an attribute.
Parameters:
name - the non-null full name of the attribute.
Returns:
the type, or null if the attribute does not exist.

getAttributeType

public String getAttributeType(String name,
                               String namespace)
Returns the type of an attribute.
Parameters:
name - the non-null name of the attribute.
namespace - the namespace URI, which may be null.
Returns:
the type, or null if the attribute does not exist.

getAttributes

public Properties getAttributes()
Returns all attributes as a Properties object.
Returns:
the non-null set.

getAttributesInNamespace

public Properties getAttributesInNamespace(String namespace)
Returns all attributes in a specific namespace as a Properties object.
Parameters:
namespace - the namespace URI of the attributes, which may be null.
Returns:
the non-null set.

getChildAtIndex

public IXMLElement getChildAtIndex(int index)
            throws ArrayIndexOutOfBoundsException
Returns the child at a specific index.
Parameters:
index - the index of the child
Returns:
the non-null child

getChildren

public Vector getChildren()
Returns a vector containing all the child elements.
Returns:
the vector.

getChildrenCount

public int getChildrenCount()
Returns the number of children.
Returns:
the count.

getChildrenNamed

public Vector getChildrenNamed(String name)
Returns a vector of all child elements named name.
Parameters:
name - the full name of the children to search for.
Returns:
the non-null vector of child elements.

getChildrenNamed

public Vector getChildrenNamed(String name,
                               String namespace)
Returns a vector of all child elements named name.
Parameters:
name - the name of the children to search for.
namespace - the namespace, which may be null.
Returns:
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.
Returns:
the content.

getFirstChildNamed

public IXMLElement getFirstChildNamed(String name)
Searches a child element.
Parameters:
name - the full name of the child to search for.
Returns:
the child element, or null if no such child was found.

getFirstChildNamed

public IXMLElement getFirstChildNamed(String name,
                                      String namespace)
Searches a child element.
Parameters:
name - the name of the child to search for.
namespace - the namespace, which may be null.
Returns:
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.
Returns:
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.
Returns:
the line number, or NO_LINE if unknown.

getName

public String getName()
Returns the name of the element.
Returns:
the name, or null if the element only contains #PCDATA.

getNamespace

public String getNamespace()
Returns the namespace of the element.
Returns:
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.
Returns:
the system ID, or null if unknown.

hasAttribute

public boolean hasAttribute(String name)
Returns whether an attribute exists.
Parameters:
name - the non-null name of the attribute.
Returns:
true if the attribute exists.

hasAttribute

public boolean hasAttribute(String name,
                            String namespace)
Returns whether an attribute exists.
Parameters:
name - the non-null name of the attribute.
namespace - the namespace URI of the attribute, which may be null.
Returns:
true if the attribute exists.

hasChildren

public boolean hasChildren()
Returns whether the element has children.
Returns:
true if the element has children.

isLeaf

public boolean isLeaf()
Returns whether the element is a leaf element.
Returns:
true if the element has no children.

removeAttribute

public void removeAttribute(String name)
Removes an attribute.
Parameters:
name - the non-null name of the attribute.

removeAttribute

public void removeAttribute(String name,
                            String namespace)
Removes an attribute.
Parameters:
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.
Parameters:
child - the non-null child to remove.

removeChildAtIndex

public void removeChildAtIndex(int index)
Removes the child located at a certain index.
Parameters:
index - the index of the child, where the first child has index 0.

setAttribute

public void setAttribute(String name,
                         String value)
Sets an attribute.
Parameters:
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.
Parameters:
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.
Parameters:
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.
Parameters:
name - the non-null name.

setName

public void setName(String fullName,
                    String namespace)
Sets the name.
Parameters:
fullName - the non-null full name.
namespace - the namespace URI, which may be null.