tigase.xml

Class Element

java.lang.Object

tigase.xml.Element

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<Element>, XMLNodeIfc<Element>

Direct Known Subclasses:

DBElement

@TODO(note="Make it a bit lighter.")
public class Element
extends java.lang.Object
implements XMLNodeIfc<Element>

Element - basic document tree node implementation. Supports Java 5.0 generic feature to make it easier to extend this class and still preserve some useful functionality. Sufficient for simple cases but probably in the most more advanced cases should be extended with additional features. Look in API documentation for more details and information about existing extensions. The most important features apart from abvious tree implementation are:

• toString() implementation so it can generate valid XML content from this element and all children.
• addChild(...), getChild(childName) supporting generic types.
• findChild(childPath) finding child in subtree by given path to element.
• getChildCData(childPath), getAttribute(childPath, attName) returning element CData from child in subtree by given path to element.

Created: Mon Oct 4 17:55:16 2004

Version:

$Rev: 481 $

Author:

Artur Hefczyc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Element.XMLIdentityHashMap<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected Element.XMLIdentityHashMap<java.lang.String,java.lang.String>	attributes
protected java.util.LinkedList<XMLNodeIfc>	children
protected java.lang.String	defxmlns
protected java.lang.String	name
protected java.lang.String	xmlns

Constructor Summary

Constructors

Constructor and Description
Element(Element element) Constructs ...
Element(java.lang.String argName) Constructs ...
Element(java.lang.String argName, Element[] children, java.lang.String[] att_names, java.lang.String[] att_values) Constructs ...
Element(java.lang.String argName, java.lang.String argCData) Constructs ...
Element(java.lang.String argName, java.lang.String[] att_names, java.lang.String[] att_values) Constructs ...
Element(java.lang.String argName, java.lang.String argCData, java.lang.String[] att_names, java.lang.String[] att_values) Constructs ...
Element(java.lang.String argName, java.lang.String argCData, java.lang.StringBuilder[] att_names, java.lang.StringBuilder[] att_values) Constructs ...

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String attName, java.lang.String attValue) Method description
void	addAttributes(java.util.Map<java.lang.String,java.lang.String> attrs) Method description
void	addChild(XMLNodeIfc child) Method description
void	addChildren(java.util.List<Element> children) Method description
protected java.lang.String	cdataToString()
java.lang.String	childrenToString() Method description
java.lang.String	childrenToStringSecure() Method description
Element	clone() Method description
int	compareTo(Element elem) Method compareTo is used to perform
boolean	equals(java.lang.Object obj) Method description
Element	findChild(java.lang.String elementPath) Method description
java.lang.String	getAttribute(java.lang.String attName) Method description
java.lang.String	getAttribute(java.lang.String elementPath, java.lang.String att_name) Method description
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Get the Attributes value.
java.lang.String	getCData() Gets the value of cdata
java.lang.String	getCData(java.lang.String elementPath) Method description
Element	getChild(java.lang.String name) Method description
Element	getChild(java.lang.String name, java.lang.String child_xmlns) Method description
java.lang.String	getChildCData(java.lang.String elementPath) Method description
java.util.List<Element>	getChildren() Method description
java.util.List<Element>	getChildren(java.lang.String elementPath) Method description
java.lang.String	getName() Gets the value of name
java.lang.String	getXMLNS()
java.lang.String	getXMLNS(java.lang.String elementPath)
int	hashCode() Method description
static void	main(java.lang.String[] args) Method description
void	removeAttribute(java.lang.String key) Method description
boolean	removeChild(Element child) Method description
void	setAttribute(java.lang.String key, java.lang.String value) Method description
void	setAttribute(java.lang.String elementPath, java.lang.String att_name, java.lang.String att_value) Method description
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> newAttributes) Set the Attributes value.
void	setAttributes(java.lang.String[] names, java.lang.String[] values) Method description
void	setAttributes(java.lang.StringBuilder[] names, java.lang.StringBuilder[] values) Method description
void	setCData(java.lang.String argCData) Sets the value of cdata
void	setChildren(java.util.List<XMLNodeIfc> children) Method description
void	setDefXMLNS(java.lang.String ns) Method description
void	setName(java.lang.String argName) Sets the value of name
void	setXMLNS(java.lang.String ns) Method description
java.lang.String	toString() Method description
java.lang.String	toStringNoChildren() Method description
java.lang.String	toStringSecure() Method description

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

attributes

protected Element.XMLIdentityHashMap<java.lang.String,java.lang.String> attributes

children

protected java.util.LinkedList<XMLNodeIfc> children

defxmlns

protected java.lang.String defxmlns

name

protected java.lang.String name

xmlns

protected java.lang.String xmlns

Constructor Detail

Element

public Element(Element element)

Constructs ...

Parameters:

element -

Element

public Element(java.lang.String argName)

Constructs ...

Parameters:

argName -

Element

public Element(java.lang.String argName,
               java.lang.String argCData)

Constructs ...

Parameters:

argName -

argCData -

Element

public Element(java.lang.String argName,
               java.lang.String[] att_names,
               java.lang.String[] att_values)

Constructs ...

Parameters:

argName -

att_names -

att_values -

Element

public Element(java.lang.String argName,
               Element[] children,
               java.lang.String[] att_names,
               java.lang.String[] att_values)

Constructs ...

Parameters:

argName -

children -

att_names -

att_values -

Element

public Element(java.lang.String argName,
               java.lang.String argCData,
               java.lang.String[] att_names,
               java.lang.String[] att_values)

Constructs ...

Parameters:

argName -

argCData -

att_names -

att_values -

Element

public Element(java.lang.String argName,
               java.lang.String argCData,
               java.lang.StringBuilder[] att_names,
               java.lang.StringBuilder[] att_values)

Constructs ...

Parameters:

argName -

argCData -

att_names -

att_values -

Method Detail

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Method description

Parameters:

args -

Throws:

java.lang.Exception

addAttribute

public void addAttribute(java.lang.String attName,
                         java.lang.String attValue)

Method description

Parameters:

attName -

attValue -

addAttributes

public void addAttributes(java.util.Map<java.lang.String,java.lang.String> attrs)

Method description

Parameters:

attrs -

addChild

public void addChild(XMLNodeIfc child)

Method description

Parameters:

child -

addChildren

public void addChildren(java.util.List<Element> children)

Method description

Parameters:

children -

childrenToString

public java.lang.String childrenToString()

Method description

Returns:

childrenToStringSecure

public java.lang.String childrenToStringSecure()

Method description

Returns:

clone

public Element clone()

Method description

Specified by:

clone in interface XMLNodeIfc<Element>

Overrides:

clone in class java.lang.Object

Returns:

compareTo

public int compareTo(Element elem)

Method compareTo is used to perform

Specified by:

compareTo in interface java.lang.Comparable<Element>

Parameters:

elem - an Object value

Returns:

an int value

equals

public boolean equals(java.lang.Object obj)

Method description

Overrides:

equals in class java.lang.Object

Parameters:

obj -

Returns:

findChild

public Element findChild(java.lang.String elementPath)

Method description

Parameters:

elementPath -

Returns:

getAttribute

public java.lang.String getAttribute(java.lang.String attName)

Method description

Parameters:

attName -

Returns:

getAttribute

public java.lang.String getAttribute(java.lang.String elementPath,
                                     java.lang.String att_name)

Method description

Parameters:

elementPath -

att_name -

Returns:

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

Get the Attributes value.

Returns:

the Attributes value.

getCData

public java.lang.String getCData(java.lang.String elementPath)

Method description

Parameters:

elementPath -

Returns:

getCData

public java.lang.String getCData()

Gets the value of cdata

Returns:

the value of cdata

getChild

public Element getChild(java.lang.String name)

Method description

Parameters:

name -

Returns:

getChild

public Element getChild(java.lang.String name,
                        java.lang.String child_xmlns)

Method description

Parameters:

name -

child_xmlns -

Returns:

getChildCData

public java.lang.String getChildCData(java.lang.String elementPath)

Method description

Parameters:

elementPath -

Returns:

getChildren

public java.util.List<Element> getChildren()

Method description

Returns:

getChildren

public java.util.List<Element> getChildren(java.lang.String elementPath)

Method description

Parameters:

elementPath -

Returns:

getName

public java.lang.String getName()

Gets the value of name

Returns:

the value of name

getXMLNS

public java.lang.String getXMLNS()

Returns:

getXMLNS

public java.lang.String getXMLNS(java.lang.String elementPath)

Parameters:

elementPath -

Returns:

hashCode

public int hashCode()

Method description

Overrides:

hashCode in class java.lang.Object

Returns:

removeAttribute

public void removeAttribute(java.lang.String key)

Method description

Parameters:

key -

removeChild

public boolean removeChild(Element child)

Method description

Parameters:

child -

Returns:

setAttribute

public void setAttribute(java.lang.String elementPath,
                         java.lang.String att_name,
                         java.lang.String att_value)

Method description

Parameters:

elementPath -

att_name -

att_value -

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.String value)

Method description

Parameters:

key -

value -

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.lang.String> newAttributes)

Set the Attributes value.

Parameters:

newAttributes - The new Attributes value.

setAttributes

public void setAttributes(java.lang.StringBuilder[] names,
                          java.lang.StringBuilder[] values)

Method description

Parameters:

names -

values -

setAttributes

public void setAttributes(java.lang.String[] names,
                          java.lang.String[] values)

Method description

Parameters:

names -

values -

setCData

public void setCData(java.lang.String argCData)

Sets the value of cdata

Parameters:

argCData - Value to assign to this.cdata

setChildren

public void setChildren(java.util.List<XMLNodeIfc> children)

Method description

Parameters:

children -

setDefXMLNS

public void setDefXMLNS(java.lang.String ns)

Method description

Parameters:

ns -

setName

public void setName(java.lang.String argName)

Sets the value of name

Parameters:

argName - Value to assign to this.name

setXMLNS

public void setXMLNS(java.lang.String ns)

Method description

Parameters:

ns -

toString

public java.lang.String toString()

Method description

Overrides:

toString in class java.lang.Object

Returns:

toStringNoChildren

public java.lang.String toStringNoChildren()

Method description

Returns:

toStringSecure

public java.lang.String toStringSecure()

Method description

Specified by:

toStringSecure in interface XMLNodeIfc<Element>

Returns:

cdataToString

protected java.lang.String cdataToString()