org.formix.dsx

Class XmlElement

java.lang.Object

org.formix.dsx.XmlElement

All Implemented Interfaces:

XmlBloc, XmlContent

public class XmlElement
extends Object
implements XmlContent

Define an Xml node in an XML document.

Author:

jpgravel

Constructor Summary

Constructors

Constructor and Description
XmlElement(String name) Creates an XmlElement instance with the given name.

Method Summary

Modifier and Type	Method and Description
XmlElement	addAttribute(String name, String value) Deprecated. This method is deprecated. Use setAttribute method instead.
XmlCDATA	addCDATA(String text) Adds a new XmlCDATA text to the current XmlElement.
XmlElement	addChild(XmlContent child) Adds the given XmlContent to the current to the current XmlElement instance.
XmlComment	addComment(String text) Adds a new XmlComment to the current XmlElement.
XmlElement	addElement(String name) Adds a new XmlElement to the current XmlElement.
XmlText	addText(String text) Adds a new XmlText content to the current XmlElement.
static XmlElement	create(String name) Creates a new XmlElement.
boolean	deepEquals(XmlElement o) Compare the actual XmlElement along whit it's childs.
boolean	equals(Object o) Two XmlElements are equals if they have the same name, the same number of attributes and all those attributes contains the same values.
String	getAttribute(String name) Gets the named attribute value.
Map<String,String>	getAttributes() Gets the attribute map of the current XmlElement.
XmlContent	getChild(int index) Gets the child XmlContent at the given index of the current XmlElement.
List<XmlContent>	getChilds() Gets this XmlContent instance child list.
XmlElement	getElement(String name) Return the first occurence of the named child XmlElement.
XmlElement	getElement(String name, int index) Gets the named child element at the given index.
List<XmlElement>	getElements() Gets a list of all XmlElement children.
List<XmlElement>	getElements(String name) Returns all child XmlElement having the given name.
long	getId() Gets the Id of the current node.
String	getName() Gets the name of the current XmlElement.
String	getValue(String elementName) Concatenate all child's XmlContent.toString() trimmed and separated by a single space of the named XmlElement.
boolean	hasAttribute(String name) Tells if the given attribute name exists in the current XmlElement.
int	hashCode()
static XmlElement	readXML(File file) Reads an XmlElement from the given file.
static XmlElement	readXML(Reader reader) Reads an XmlElement from the given reader.
static XmlElement	readXML(Reader reader, XmlContentListener listener) Read XML from the given reader and fire events from the provided listener.
static XmlElement	readXML(String xml) Parse the given xml string into an XmlElement.
XmlElement	setAttribute(String name, String value) Sets a value to the given attribute.
void	setName(String name) Sets the name of the current element.
String	toString()
String	toXml() Method transforming the current class into its XML string representation.
void	write(Writer writer) Method defining how the current class will write itself as XML to the given writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlElement

public XmlElement(String name)

Creates an XmlElement instance with the given name.

Parameters:

name - The name given to the XmlElement.

Method Detail

create

public static XmlElement create(String name)

Creates a new XmlElement.

Parameters:

name - The name of the node to create.

Returns:

A new XmlElement.

readXML

public static XmlElement readXML(File file)
                          throws XmlException

Reads an XmlElement from the given file. Every sub child xml content will be recurseively created.

Parameters:

file - The file containing the XmlElement.

Returns:

A new XmlElement.

Throws:

XmlException - If there is any problem during Xml parsing.

readXML

public static XmlElement readXML(Reader reader)
                          throws XmlException

Reads an XmlElement from the given reader. Every sub child xml content will be recurseively created.

Parameters:

reader - The reader containing the XmlElement.

Returns:

A new XmlElement.

Throws:

XmlException - If there is any problem during Xml parsing.

readXML

public static XmlElement readXML(Reader reader,
                                 XmlContentListener listener)
                          throws XmlException

Read XML from the given reader and fire events from the provided listener.

Parameters:

reader - The reader containing the XML data.

listener - The XmlContentListener containing code to be notified each time an Xml content object is created.

Returns:

The XmsElement created by parsing the given reader data.

Throws:

XmlException - Thrown if a problem occur while reading the provided XML data.

readXML

public static XmlElement readXML(String xml)
                          throws XmlException

Parse the given xml string into an XmlElement.

Parameters:

xml - The XML string to parse.

Returns:

The XmlElement parsed from the given XML string.

Throws:

XmlException - Thrown if a problem occur while reading the provided XML data.

addAttribute

@Deprecated
public XmlElement addAttribute(String name,
                                            String value)

Deprecated. This method is deprecated. Use setAttribute method instead.

Adds an attribute to the current XmlElement.

Parameters:

name - The name of the attribute.

value - The value of the attribute.

Returns:

The current XmlElement instance for method chaining.

addCDATA

public XmlCDATA addCDATA(String text)

Adds a new XmlCDATA text to the current XmlElement.

Parameters:

text - The CDATA text.

Returns:

The XmlCDATA instance added to the current XmlElement.

addChild

public XmlElement addChild(XmlContent child)

Adds the given XmlContent to the current to the current XmlElement instance.

Parameters:

child - The child XmlContent to add.

Returns:

The current XmlElement instance for method chaining.

addComment

public XmlComment addComment(String text)

Adds a new XmlComment to the current XmlElement.

Parameters:

text - The text of the XmlComment.

Returns:

The newly created XmlComment.

addElement

public XmlElement addElement(String name)

Adds a new XmlElement to the current XmlElement.

Parameters:

name - The name of the XmlElement.

Returns:

The newly created XmlElement.

addText

public XmlText addText(String text)

Adds a new XmlText content to the current XmlElement.

Parameters:

text - The text of the XmlText.

Returns:

The newly created XmlText.

deepEquals

public boolean deepEquals(XmlElement o)

Compare the actual XmlElement along whit it's childs.

Parameters:

o - The other element to do the comparison with.

Returns:

True if bots XmlElements are equals, contains the same number of childs and all those childs are equal to each other, recursively.

equals

public boolean equals(Object o)

Two XmlElements are equals if they have the same name, the same number of attributes and all those attributes contains the same values. Sub-elements are not compared.

Overrides:

equals in class Object

Parameters:

o - The object to do the comparison with.

Returns:

true if both XmlElement are equal, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hasAttribute

public boolean hasAttribute(String name)

Tells if the given attribute name exists in the current XmlElement.

Parameters:

name - The name of the seeked attribute.

Returns:

True if the current XmlElement has the named attribute, false otherwise.

getAttribute

public String getAttribute(String name)

Gets the named attribute value.

Parameters:

name - The name of the desired attribute.

Returns:

The value of the named attribute or null if the attribute does not exists for the current XmlElement.

getAttributes

public Map<String,String> getAttributes()

Gets the attribute map of the current XmlElement.

Returns:

A Map<String, String> containing all attributes of this XmlElement.

getChild

public XmlContent getChild(int index)

Gets the child XmlContent at the given index of the current XmlElement.

Parameters:

index - The index of the child to get.

Returns:

The child XmlContent at index.

Throws:

IndexOutOfBoundsException - if the index is out of range.

getChilds

public List<XmlContent> getChilds()

Gets this XmlContent instance child list.

Returns:

This XmlContent child list.

getValue

public String getValue(String elementName)

Concatenate all child's XmlContent.toString() trimmed and separated by a single space of the named XmlElement.

for example:
given the following XML hierarchy: - root - child - "string value"

Executing:
root.getValue("child")

Will return:
"string value"

Parameters:

elementName - The name of the child element for which we want the inner value.

Returns:

The content of the named child element.

getElement

public XmlElement getElement(String name)

Return the first occurence of the named child XmlElement.

Parameters:

name - The name of the desired child element.

Returns:

The named element or null if there is no such child XmlElement.

getElement

public XmlElement getElement(String name,
                             int index)

Gets the named child element at the given index.

Parameters:

name - The name of the child XmlElement desired.

index - The index of the desired XmlElement.

Returns:

The child XmlElement corresponding to the given name at the given index or null if no element is fount at this index.

getElements

public List<XmlElement> getElements(String name)

Returns all child XmlElement having the given name.

Parameters:

name - The name of the desired child XmlElements

Returns:

A List of child XmlElement.

getElements

public List<XmlElement> getElements()

Gets a list of all XmlElement children.

Returns:

a list of all XmlElement children.

getId

public long getId()

Description copied from interface: XmlContent

Gets the Id of the current node. This id has no representation in the given XML but is useful to uniquely identify each XML node within an XML graph.

Specified by:

getId in interface XmlContent

Returns:

The Id of the current XML content.

getName

public String getName()

Gets the name of the current XmlElement.

Returns:

the name of the current XmlElement.

setAttribute

public XmlElement setAttribute(String name,
                               String value)

Sets a value to the given attribute.

Parameters:

name - The name of the attribute.

value - The value of the attribute.

Returns:

The current XmlElement instance for method chaining.

setName

public void setName(String name)

Sets the name of the current element.

Parameters:

name - The new name of the current attribute.

toString

public String toString()

Overrides:

toString in class Object

toXml

public String toXml()

Description copied from interface: XmlContent

Method transforming the current class into its XML string representation.

Specified by:

toXml in interface XmlContent

Returns:

an XML string representation of itself.

write

public void write(Writer writer)
           throws IOException

Description copied from interface: XmlContent

Method defining how the current class will write itself as XML to the given writer.

Specified by:

write in interface XmlContent

Parameters:

writer - Thw writer to write to.

Throws:

IOException - Thrown if an error occurs while writing to the writer.