com.fgm.javaUtils

Class Dom4jUtils

java.lang.Object

com.fgm.javaUtils.Dom4jUtils

public class Dom4jUtils
extends java.lang.Object

Class contining convenience methods for interecting with the dom4j library (http://dom4j.sourceforge.net/)

Field Summary

Fields

Modifier and Type	Field and Description
private org.dom4j.Document	doc The doc.

Constructor Summary

Constructors

Constructor and Description
Dom4jUtils()

Method Summary

Methods

Modifier and Type	Method and Description
org.dom4j.Document	create(java.io.File file) Build the DOM based on the xml provided in the file.
org.dom4j.Document	create(java.lang.String xmlString) Build the DOM based on the xml string provided.
static org.dom4j.Element	findNodeByFullName(org.dom4j.Element root, java.lang.String fullname) find a node with full name from children of the root.
org.dom4j.Element	findNodeByFullName(java.lang.String fullname) find a node with full name specified starting from root.
static void	findNodesByFullName(org.dom4j.Element root, java.lang.String fullname, java.util.List<org.dom4j.Element> list) find all the nodes with full name from the node.
java.util.List<org.dom4j.Element>	findNodesByFullName(java.lang.String fullname) find all the nodes with full name specifiec, start from root.
static org.dom4j.Element	findParentByName(java.lang.String name, org.dom4j.Element e) find parent with name specified.
private java.lang.String	findString(java.lang.String str) find and return text of node.
org.dom4j.Document	getDocument() return doc.
static java.lang.String	getFullName(org.dom4j.Element e) Build the fully qualified name of an element.
protected static java.lang.String	getFullyQualifiedName(org.dom4j.Element e) Return an xml string in fully qualified form - e.g foo.bar.baz
org.dom4j.Element	getRoot() returns root node of DOM tree.
static void	removeChildren(org.dom4j.Element root) remove children from the node.
static org.dom4j.Element	selectNode(org.dom4j.Element root, java.lang.String elementName) find a node with element name.
org.dom4j.Element	selectNode(java.lang.String elementName) find a node with element name - return the first one.
private static void	selectNodes(org.dom4j.Element root, java.lang.String elementName, java.util.List<org.dom4j.Element> list) find all the nodes with the name specified from the node.
java.util.List<org.dom4j.Element>	selectNodes(java.lang.String elementName) select all the nodes with the name specified, start from root node.

Methods inherited from class java.lang.Object

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

Field Detail

doc

private org.dom4j.Document doc

The doc.

Constructor Detail

Dom4jUtils

public Dom4jUtils()

Method Detail

create

public org.dom4j.Document create(java.io.File file)
                          throws org.dom4j.DocumentException

Build the DOM based on the xml provided in the file.

Parameters:

file - the file

Returns:

the document

Throws:

org.dom4j.DocumentException - the document exception

create

public org.dom4j.Document create(java.lang.String xmlString)
                          throws org.dom4j.DocumentException

Build the DOM based on the xml string provided.

Parameters:

xmlString - the xml string

Returns:

the document

Throws:

org.dom4j.DocumentException - the document exception

getRoot

public org.dom4j.Element getRoot()

returns root node of DOM tree.

Returns:

the root

getDocument

public org.dom4j.Document getDocument()

return doc.

Returns:

the document

findString

private java.lang.String findString(java.lang.String str)

find and return text of node.

Parameters:

str - the str

Returns:

the string

getFullName

public static java.lang.String getFullName(org.dom4j.Element e)

Build the fully qualified name of an element.

Parameters:

e - - the Element to check

Returns:

- a string with the full name (i.e. //actionScriptProperties/compiler/libraryPath/libraryPathEntry/excludedEntries)

findNodeByFullName

public org.dom4j.Element findNodeByFullName(java.lang.String fullname)

find a node with full name specified starting from root.

Parameters:

fullname - the fullname

Returns:

the element

findNodeByFullName

public static org.dom4j.Element findNodeByFullName(org.dom4j.Element root,
                                   java.lang.String fullname)

find a node with full name from children of the root.

Parameters:

root - the root

fullname - the fullname

Returns:

the element

findNodesByFullName

public java.util.List<org.dom4j.Element> findNodesByFullName(java.lang.String fullname)

find all the nodes with full name specifiec, start from root.

Parameters:

fullname - the fullname

Returns:

the list

findNodesByFullName

public static void findNodesByFullName(org.dom4j.Element root,
                       java.lang.String fullname,
                       java.util.List<org.dom4j.Element> list)

find all the nodes with full name from the node.

Parameters:

root - the root

fullname - the fullname

list - the list

selectNodes

public java.util.List<org.dom4j.Element> selectNodes(java.lang.String elementName)

select all the nodes with the name specified, start from root node.

Parameters:

elementName - the element name

Returns:

the list

selectNodes

private static void selectNodes(org.dom4j.Element root,
               java.lang.String elementName,
               java.util.List<org.dom4j.Element> list)

find all the nodes with the name specified from the node.

Parameters:

root - the root

elementName - the element name

list - the list

getFullyQualifiedName

protected static java.lang.String getFullyQualifiedName(org.dom4j.Element e)

Return an xml string in fully qualified form - e.g foo.bar.baz

Parameters:

e - the e

Returns:

the fully qualified name

selectNode

public static org.dom4j.Element selectNode(org.dom4j.Element root,
                           java.lang.String elementName)

find a node with element name.

Parameters:

root - the root

elementName - the element name

Returns:

the element

removeChildren

public static void removeChildren(org.dom4j.Element root)

remove children from the node.

Parameters:

root - the root

selectNode

public org.dom4j.Element selectNode(java.lang.String elementName)

find a node with element name - return the first one.

Parameters:

elementName - the element name

Returns:

the element

findParentByName

public static org.dom4j.Element findParentByName(java.lang.String name,
                                 org.dom4j.Element e)

find parent with name specified.

Parameters:

name - the name

e - the e

Returns:

the element