org.kxml2.kdom

Class Element

java.lang.Object

org.kxml2.kdom.Node

org.kxml2.kdom.Element

public class Element
extends Node

In order to create an element, please use the createElement method instead of invoking the constructor directly. The right place to add user defined initialization code is the init method.

Field Summary

Fields

Modifier and Type	Field and Description
protected Vector	attributes
protected String	name
protected String	namespace
protected Node	parent
protected Vector	prefixes

Fields inherited from class org.kxml2.kdom.Node

CDSECT, children, COMMENT, DOCDECL, DOCUMENT, ELEMENT, ENTITY_REF, IGNORABLE_WHITESPACE, PROCESSING_INSTRUCTION, TEXT, types

Constructor Summary

Constructors

Constructor and Description
Element()

Method Summary

Modifier and Type	Method and Description
void	clear() removes all children and attributes
Element	createElement(String namespace, String name) Forwards creation request to parent if any, otherwise calls super.createElement.
int	getAttributeCount() Returns the number of attributes of this element.
String	getAttributeName(int index)
String	getAttributeNamespace(int index)
String	getAttributeValue(int index)
String	getAttributeValue(String namespace, String name)
String	getName() returns the (local) name of the element
String	getNamespace() returns the namespace of the element
int	getNamespaceCount() returns the number of declared namespaces, NOT including parent elements
String	getNamespacePrefix(int i)
String	getNamespaceUri(int i)
String	getNamespaceUri(String prefix) returns the namespace for the given prefix
Node	getParent() Returns the parent node of this element
Node	getRoot() Returns the root node, determined by ascending to the all parents un of the root element.
void	init() called when all properties are set, but before children are parsed.
void	parse(XmlPullParser parser) Builds the child elements from the given Parser.
void	setAttribute(String namespace, String name, String value) Sets the given attribute; a value of null removes the attribute
void	setName(String name) sets the name of the element
void	setNamespace(String namespace) sets the namespace of the element.
protected void	setParent(Node parent) Sets the Parent of this element.
void	setPrefix(String prefix, String namespace) Sets the given prefix; a namespace value of null removess the prefix
void	write(XmlSerializer writer) Writes this element and all children to the given XmlWriter.

Methods inherited from class org.kxml2.kdom.Node

addChild, addChild, getChild, getChildCount, getElement, getElement, getText, getType, indexOf, isText, removeChild, writeChildren

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

attributes

protected Vector attributes

name

protected String name

namespace

protected String namespace

parent

protected Node parent

prefixes

protected Vector prefixes

Constructor Detail

Element

public Element()

Method Detail

clear

public void clear()

removes all children and attributes

createElement

public Element createElement(String namespace,
                             String name)

Forwards creation request to parent if any, otherwise calls super.createElement.

Overrides:

createElement in class Node

getAttributeCount

public int getAttributeCount()

Returns the number of attributes of this element.

getAttributeName

public String getAttributeName(int index)

getAttributeNamespace

public String getAttributeNamespace(int index)

getAttributeValue

public String getAttributeValue(int index)

getAttributeValue

public String getAttributeValue(String namespace,
                                String name)

getName

public String getName()

returns the (local) name of the element

getNamespace

public String getNamespace()

returns the namespace of the element

getNamespaceCount

public int getNamespaceCount()

returns the number of declared namespaces, NOT including parent elements

getNamespacePrefix

public String getNamespacePrefix(int i)

getNamespaceUri

public String getNamespaceUri(int i)

getNamespaceUri

public String getNamespaceUri(String prefix)

returns the namespace for the given prefix

getParent

public Node getParent()

Returns the parent node of this element

getRoot

public Node getRoot()

Returns the root node, determined by ascending to the all parents un of the root element.

init

public void init()

called when all properties are set, but before children are parsed. Please do not use setParent for initialization code any longer.

parse

public void parse(XmlPullParser parser)
           throws IOException,
                  XmlPullParserException

Builds the child elements from the given Parser. By overwriting parse, an element can take complete control over parsing its subtree.

Overrides:

parse in class Node

Throws:

IOException

XmlPullParserException

setAttribute

public void setAttribute(String namespace,
                         String name,
                         String value)

Sets the given attribute; a value of null removes the attribute

setName

public void setName(String name)

sets the name of the element

setNamespace

public void setNamespace(String namespace)

sets the namespace of the element. Please note: For no namespace, please use Xml.NO_NAMESPACE, null is not a legal value. Currently, null is converted to Xml.NO_NAMESPACE, but future versions may throw an exception.

setParent

protected void setParent(Node parent)

Sets the Parent of this element. Automatically called from the add method. Please use with care, you can simply create inconsitencies in the document tree structure using this method!

setPrefix

public void setPrefix(String prefix,
                      String namespace)

Sets the given prefix; a namespace value of null removess the prefix

write

public void write(XmlSerializer writer)
           throws IOException

Writes this element and all children to the given XmlWriter.

Overrides:

write in class Node

Throws:

IOException