tigase.xml
Class Element

java.lang.Object
  extended by 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:

Created: Mon Oct 4 17:55:16 2004

Version:
$Rev: 456 $
Author:
Artur Hefczyc

Field Summary
protected  java.util.IdentityHashMap<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
Element(Element element)
           
Element(java.lang.String argName)
           
Element(java.lang.String argName, Element[] children, java.lang.String[] att_names, java.lang.String[] att_values)
           
Element(java.lang.String argName, java.lang.String argCData)
           
Element(java.lang.String argName, java.lang.String[] att_names, java.lang.String[] att_values)
           
Element(java.lang.String argName, java.lang.String argCData, java.lang.String[] att_names, java.lang.String[] att_values)
           
Element(java.lang.String argName, java.lang.String argCData, java.lang.StringBuilder[] att_names, java.lang.StringBuilder[] att_values)
           
 
Method Summary
 void addAttribute(java.lang.String attName, java.lang.String attValue)
           
 void addAttributes(java.util.Map<java.lang.String,java.lang.String> attrs)
           
 void addChild(XMLNodeIfc child)
           
 void addChildren(java.util.List<Element> children)
           
protected  java.lang.String cdataToString()
           
 java.lang.String childrenToString()
           
 java.lang.String childrenToStringSecure()
           
 Element clone()
           
 int compareTo(Element elem)
          Method compareTo is used to perform
 boolean equals(java.lang.Object obj)
           
 Element findChild(java.lang.String elementPath)
           
 java.lang.String getAttribute(java.lang.String attName)
           
 java.lang.String getAttribute(java.lang.String elementPath, java.lang.String att_name)
           
 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)
           
 Element getChild(java.lang.String name)
           
 Element getChild(java.lang.String name, java.lang.String child_xmlns)
           
 java.lang.String getChildCData(java.lang.String elementPath)
           
 java.util.List<Element> getChildren()
           
 java.util.List<Element> getChildren(java.lang.String elementPath)
           
 java.lang.String getName()
          Gets the value of name
 java.lang.String getXMLNS()
           
 java.lang.String getXMLNS(java.lang.String elementPath)
           
 int hashCode()
           
static void main(java.lang.String[] args)
           
 void removeAttribute(java.lang.String key)
           
 boolean removeChild(Element child)
           
 void setAttribute(java.lang.String key, java.lang.String value)
           
 void setAttribute(java.lang.String elementPath, java.lang.String att_name, java.lang.String att_value)
           
 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)
           
 void setAttributes(java.lang.StringBuilder[] names, java.lang.StringBuilder[] values)
           
 void setCData(java.lang.String argCData)
          Sets the value of cdata
 void setChildren(java.util.List<XMLNodeIfc> children)
           
 void setDefXMLNS(java.lang.String ns)
           
 void setName(java.lang.String argName)
          Sets the value of name
 void setXMLNS(java.lang.String ns)
           
 java.lang.String toString()
           
 java.lang.String toStringNoChildren()
           
 java.lang.String toStringSecure()
           
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

name

protected java.lang.String name

defxmlns

protected java.lang.String defxmlns

xmlns

protected java.lang.String xmlns

attributes

protected java.util.IdentityHashMap<java.lang.String,java.lang.String> attributes

children

protected java.util.LinkedList<XMLNodeIfc> children
Constructor Detail

Element

public Element(Element element)

Element

public Element(java.lang.String argName)

Element

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

Element

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

Element

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

Element

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

Element

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

clone

public Element clone()
Specified by:
clone in interface XMLNodeIfc<Element>
Overrides:
clone in class java.lang.Object

getChildren

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

getChildren

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

setChildren

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

addChildren

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

toStringNoChildren

public java.lang.String toStringNoChildren()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

toStringSecure

public java.lang.String toStringSecure()
Specified by:
toStringSecure in interface XMLNodeIfc<Element>

cdataToString

protected java.lang.String cdataToString()

childrenToString

public java.lang.String childrenToString()

childrenToStringSecure

public java.lang.String childrenToStringSecure()

addChild

public void addChild(XMLNodeIfc child)

removeChild

public boolean removeChild(Element child)

getChild

public Element getChild(java.lang.String name)

getChild

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

findChild

public Element findChild(java.lang.String elementPath)

getChildCData

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

getCData

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

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()
Get the Attributes value.

Returns:
the Attributes 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.

getAttribute

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

addAttribute

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

addAttributes

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

setDefXMLNS

public void setDefXMLNS(java.lang.String ns)

setXMLNS

public void setXMLNS(java.lang.String ns)

getXMLNS

public java.lang.String getXMLNS()
Returns:

getXMLNS

public java.lang.String getXMLNS(java.lang.String elementPath)
Parameters:
elementPath -
Returns:

getAttribute

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

setAttribute

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

setAttribute

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

removeAttribute

public void removeAttribute(java.lang.String key)

setAttributes

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

setAttributes

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

getName

public java.lang.String getName()
Gets the value of name

Returns:
the value of name

setName

public void setName(java.lang.String argName)
Sets the value of name

Parameters:
argName - Value to assign to this.name

getCData

public java.lang.String getCData()
Gets the value of cdata

Returns:
the value of cdata

setCData

public void setCData(java.lang.String argCData)
Sets the value of cdata

Parameters:
argCData - Value to assign to this.cdata

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)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

main

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


Copyright © 2001-2006 Tigase Developers Team. All rights Reserved.