|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
StdXMLBuilder
Field Summary | |
static int |
NO_LINE
No line number defined. |
Method Summary | |
void |
addChild(IXMLElement child)
Adds a child element. |
IXMLElement |
createElement(java.lang.String fullName)
Creates an empty element. |
IXMLElement |
createElement(java.lang.String fullName,
java.lang.String namespace)
Creates an empty element. |
IXMLElement |
createElement(java.lang.String fullName,
java.lang.String systemID,
int lineNr)
Creates an empty element. |
IXMLElement |
createElement(java.lang.String fullName,
java.lang.String namespace,
java.lang.String systemID,
int lineNr)
Creates an empty element. |
IXMLElement |
createPCDataElement()
Creates an element to be used for #PCDATA content. |
java.util.Enumeration |
enumerateAttributeNames()
Returns an enumeration of all attribute names. |
java.util.Enumeration |
enumerateChildren()
Returns an enumeration of all child elements. |
boolean |
equals(java.lang.Object rawElement)
Returns true if the element equals another element. |
boolean |
equalsXMLElement(IXMLElement elt)
Returns true if the element equals another element. |
java.lang.String |
getAttribute(java.lang.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. |
int |
getAttribute(java.lang.String name,
int defaultValue)
Returns the value of an attribute. |
java.lang.String |
getAttribute(java.lang.String name,
java.lang.String defaultValue)
Returns the value of an attribute. |
int |
getAttribute(java.lang.String name,
java.lang.String namespace,
int defaultValue)
Returns the value of an attribute. |
java.lang.String |
getAttribute(java.lang.String name,
java.lang.String namespace,
java.lang.String defaultValue)
Returns the value of an attribute. |
int |
getAttributeCount()
Returns the number of attributes. |
java.lang.String |
getAttributeNamespace(java.lang.String name)
Returns the namespace of an attribute. |
java.util.Properties |
getAttributes()
Returns all attributes as a Properties object. |
java.util.Properties |
getAttributesInNamespace(java.lang.String namespace)
Returns all attributes in a specific namespace as a Properties object. |
java.lang.String |
getAttributeType(java.lang.String name)
Returns the type of an attribute. |
java.lang.String |
getAttributeType(java.lang.String name,
java.lang.String namespace)
Returns the type of an attribute. |
IXMLElement |
getChildAtIndex(int index)
Returns the child at a specific index. |
java.util.Vector |
getChildren()
Returns a vector containing all the child elements. |
int |
getChildrenCount()
Returns the number of children. |
java.util.Vector |
getChildrenNamed(java.lang.String name)
Returns a vector of all child elements named name. |
java.util.Vector |
getChildrenNamed(java.lang.String name,
java.lang.String namespace)
Returns a vector of all child elements named name. |
java.lang.String |
getContent()
Return the #PCDATA content of the element. |
IXMLElement |
getFirstChildNamed(java.lang.String name)
Searches a child element. |
IXMLElement |
getFirstChildNamed(java.lang.String name,
java.lang.String namespace)
Searches a child element. |
java.lang.String |
getFullName()
Returns the full name (i.e. |
int |
getLineNr()
Returns the line number in the data where the element started. |
java.lang.String |
getName()
Returns the name of the element. |
java.lang.String |
getNamespace()
Returns the namespace of the element. |
IXMLElement |
getParent()
Returns the parent element. |
java.lang.String |
getSystemID()
Returns the system ID of the data where the element started. |
boolean |
hasAttribute(java.lang.String name)
Returns whether an attribute exists. |
boolean |
hasAttribute(java.lang.String name,
java.lang.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(java.lang.String name)
Removes an attribute. |
void |
removeAttribute(java.lang.String name,
java.lang.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(java.lang.String name,
java.lang.String value)
Sets an attribute. |
void |
setAttribute(java.lang.String fullName,
java.lang.String namespace,
java.lang.String value)
Sets an attribute. |
void |
setContent(java.lang.String content)
Sets the #PCDATA content. |
void |
setName(java.lang.String name)
Sets the full name. |
void |
setName(java.lang.String fullName,
java.lang.String namespace)
Sets the name. |
Field Detail |
public static final int NO_LINE
Method Detail |
public IXMLElement createPCDataElement()
public IXMLElement createElement(java.lang.String fullName)
fullName
- the name of the element.public IXMLElement createElement(java.lang.String fullName, java.lang.String systemID, int lineNr)
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.public IXMLElement createElement(java.lang.String fullName, java.lang.String namespace)
fullName
- the full name of the elementnamespace
- the namespace URI.public IXMLElement createElement(java.lang.String fullName, java.lang.String namespace, java.lang.String systemID, int lineNr)
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.public IXMLElement getParent()
public java.lang.String getFullName()
public java.lang.String getName()
public java.lang.String getNamespace()
public void setName(java.lang.String name)
name
- the non-null name.public void setName(java.lang.String fullName, java.lang.String namespace)
fullName
- the non-null full name.namespace
- the namespace URI, which may be null.public void addChild(IXMLElement child)
child
- the non-null child to add.public void removeChild(IXMLElement child)
child
- the non-null child to remove.public void removeChildAtIndex(int index)
index
- the index of the child, where the first child has index 0.public java.util.Enumeration enumerateChildren()
public boolean isLeaf()
public boolean hasChildren()
public int getChildrenCount()
public java.util.Vector getChildren()
public IXMLElement getChildAtIndex(int index) throws java.lang.ArrayIndexOutOfBoundsException
index
- the index of the child
java.lang.ArrayIndexOutOfBoundsException
- if the index is out of bounds.public IXMLElement getFirstChildNamed(java.lang.String name)
name
- the full name of the child to search for.
public IXMLElement getFirstChildNamed(java.lang.String name, java.lang.String namespace)
name
- the name of the child to search for.namespace
- the namespace, which may be null.
public java.util.Vector getChildrenNamed(java.lang.String name)
name
- the full name of the children to search for.
public java.util.Vector getChildrenNamed(java.lang.String name, java.lang.String namespace)
name
- the name of the children to search for.namespace
- the namespace, which may be null.
public int getAttributeCount()
public java.lang.String getAttribute(java.lang.String name)
getAttribute(java.lang.String,java.lang.String)
Returns the value of an attribute.
name
- the non-null name of the attribute.
public java.lang.String getAttribute(java.lang.String name, java.lang.String defaultValue)
name
- the non-null full name of the attribute.defaultValue
- the default value of the attribute.
public java.lang.String getAttribute(java.lang.String name, java.lang.String namespace, java.lang.String defaultValue)
name
- the non-null name of the attribute.namespace
- the namespace URI, which may be null.defaultValue
- the default value of the attribute.
public int getAttribute(java.lang.String name, int defaultValue)
name
- the non-null full name of the attribute.defaultValue
- the default value of the attribute.
public int getAttribute(java.lang.String name, java.lang.String namespace, int defaultValue)
name
- the non-null name of the attribute.namespace
- the namespace URI, which may be null.defaultValue
- the default value of the attribute.
public java.lang.String getAttributeType(java.lang.String name)
name
- the non-null full name of the attribute.
public java.lang.String getAttributeNamespace(java.lang.String name)
name
- the non-null full name of the attribute.
public java.lang.String getAttributeType(java.lang.String name, java.lang.String namespace)
name
- the non-null name of the attribute.namespace
- the namespace URI, which may be null.
public void setAttribute(java.lang.String name, java.lang.String value)
name
- the non-null full name of the attribute.value
- the non-null value of the attribute.public void setAttribute(java.lang.String fullName, java.lang.String namespace, java.lang.String value)
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.public void removeAttribute(java.lang.String name)
name
- the non-null name of the attribute.public void removeAttribute(java.lang.String name, java.lang.String namespace)
name
- the non-null name of the attribute.namespace
- the namespace URI of the attribute, which may be null.public java.util.Enumeration enumerateAttributeNames()
public boolean hasAttribute(java.lang.String name)
name
- the non-null name of the attribute.
public boolean hasAttribute(java.lang.String name, java.lang.String namespace)
name
- the non-null name of the attribute.namespace
- the namespace URI of the attribute, which may be null.
public java.util.Properties getAttributes()
public java.util.Properties getAttributesInNamespace(java.lang.String namespace)
namespace
- the namespace URI of the attributes, which may be null.
public java.lang.String getSystemID()
getLineNr()
public int getLineNr()
NO_LINE
,
getSystemID()
public java.lang.String getContent()
public void setContent(java.lang.String content)
content
- the (possibly null) content.public boolean equals(java.lang.Object rawElement)
rawElement
- the element to compare topublic boolean equalsXMLElement(IXMLElement elt)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |