Package com.nfbsoftware.xml

Class XmlDocument

java.lang.Object

com.nfbsoftware.xml.XmlDocument

All Implemented Interfaces:

IXmlDocument, IXmlElement, Serializable

public class XmlDocument
extends Object
implements IXmlDocument

Author:

Brendan Clemenzi

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Document	mDocument	mDocument stores the Document Node of the XML document.
protected Node	mRootNode	mRootNode stores the root Element node of the XML document.
protected static final String	SEPARATOR	sSeparator contains the separator symbol used in child path.

Constructor Summary

Constructors

Constructor	Description
XmlDocument()
XmlDocument(IXmlDocument xmlDocument)
XmlDocument(File file)
XmlDocument(File file, String enc)
XmlDocument(InputStream in)
XmlDocument(InputStream in, String enc)
XmlDocument(Reader reader)
XmlDocument(String xml)
XmlDocument(Node node, Document doc)

Method Summary

Modifier and Type	Method	Description
void	addChild(IXmlElement child)	This appends an IXmlElement object to the this element.
void	addToChild(IXmlElement child, String parent)	This method appends the input IXmlElement object to the element identified by the path.
void	appendChildByName(String parent, XmlDocument child)
IXmlDocument	clone(boolean deep)	This method creates a copy of the existing IXmlElement object, including a clone of every child if and only if the deep parameter is set to be true.
static Node	cloneChildren(Document doc, Node child)	Clone a child node using the input document node
IXmlElement	createChild(String childName)	This method creates a new child under this element with an element name equal to the childName parameter.
IXmlElement	createChild(String childName, String value)	This method creates a new child under this element with an element name equal to the childName parameter and a value equal to the value parameter.
XmlDocument	createChildByName(String child)	This method creates a standing alone XmlData object with sName and sValue.
IXmlElement	createChildren(String fullChildPath)	This method creates aall of the child elements referenced by the child path.
protected Node	examineChild(Document rootDoc, Node child)	Description of the Method
String	getAttribute(String name)	This method returns the attribute's value according to input attribute name.
final String	getAttributeByName(String sName)
final int	getAttributeCount()
final String	getAttributeNameByIndex(int index)
Collection<String>	getAttributeNames()	This method returns all of the attribute names of the current node
Collection<String>	getAttributeValues()	This method returns all of the attribute values of the current node.
String	getCDATASection(String childName)	This method returns the descendent's value.
protected final String	getCDATATextValue(Node node)
final String	getCDATAValue(String sChild)
IXmlElement	getChild(int index)	.
IXmlElement	getChild(String childName)	This method returns the first child element identified by the path.
String	getChildAttribute(String child, String attr)	This method returns the attribute value of a child node.
int	getChildCount()	This method returns the number of children.
Collection<IXmlElement>	getChildren()	This method returns all of this element's children.
Collection<IXmlElement>	getChildrenByName(String name)	This method returns all of this element's children with the given name.
final int	getChildrenCount()
String	getChildValue(String childName)	This method returns the descendent's value.
Document	getDocument()	This method returns the document node of the internal XML document.
String	getName()	This method returns the name of this element
String	getNameSpace()	This method returns the namespace of the current node.
protected final String	getNodeTextValue(Node node)
final String	getNodeValue(String sChild)
Document	getPrivateDocument()	This method returns the document node of the internal XML document.
Node	getPrivateElementNode()	This method returns the root node of the internal XML document.
IXmlElement	getRootElement()	Method getRootElement returns the root element for the xml document.
Node	getRootNode()	This method returns the root node of the internal XML document.
String	getValue()	This method returns the element's value
void	isValid()	Determine if the xml document in question
void	load(File file)	This method replaces the content of the current root node with that of the input file.
void	load(File file, String enc)	This method replaces the content of the current root node with that of the input file.
void	load(InputStream in)	This method replaces the content of the current root node with that of the InputStream.
void	load(InputStream in, String enc)	This method replaces the content of the current root node with that of the InputStream.
void	load(Reader reader)	This method replaces the content of the current root node with that of the Reader.
void	load(String xml)	This method replaces the content of the current root node with that of the input string.
protected Node	prvGetChildByName(String sChildName)	Description of the Method
protected Node	prvGetChildByName(String sChildName, Node rootNode)	Description of the Method
void	removeAttribute(String attrName)	This method removes an attribute from this element..
IXmlElement	removeChild(int index)	This method removes the index-th child element.
IXmlElement	removeChild(String childName)	This method removes a child element.
void	removeChildAttribute(String childName, String attrName)	This method removes an attribute from a child element
List<IXmlElement>	removeChildrenWithXpath(String xpathQuery)	This method removes all child elements with the given xpath query.
IXmlElement	removeChildWithXpath(String xpathQuery)	This method removes a single child element with the given xpath query.
void	replaceAllChildren(IXmlElement parent)	Removes all of the element's children and adds all of the children of the provided parent element.
IXmlElement	replaceChild(int index, IXmlElement newChild)	This method replaces the index-th element with the new element.
IXmlElement	replaceChild(String childName, IXmlElement newChild)	This method replaces the child element with the new element.
boolean	replaceFromReader(Reader reader)	This method replaces the content of the current root node with that of the reader.
boolean	replaceFromStream(InputStream in)	This method replaces the content of the current root node with that of the InputStream.
boolean	replaceFromStream(InputStream in, String encoding)	This method replaces the content of the current root node with that of the InputStream.
final boolean	replaceFromString(String xml)	This method replaces the content of the current root node with that of the input string.
IXmlElement	selectChild(String xpathQuery)
List<IXmlElement>	selectChildren(String xpathQuery)
protected NodeList	selectNodesViaXPath(String childName, Node root)
IXmlElement	setAttribute(String attrName, String value)	Sets the value of an attribute of this element.
void	setCDATASection(String value)	Sets this element's CDATA value
protected final void	setCDATASection(Node node, String sValue)
protected final void	setTextValue(Node node, String sValue)
void	setValue(String value)	Sets this element's value
String	toString()
void	write(File file)	This method saves the stored XML document as a file.
void	write(OutputStream output)	This methods writes the content of the current XML document to the output stream.

Methods inherited from class java.lang.Object

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

Field Details

mDocument

protected Document mDocument

mDocument stores the Document Node of the XML document. In W3C's DOM model, each XML document must have a Document node and a root Element node.

mRootNode

protected Node mRootNode

mRootNode stores the root Element node of the XML document.

SEPARATOR

protected static final String SEPARATOR

sSeparator contains the separator symbol used in child path.

See Also:

• Constant Field Values

Constructor Details

XmlDocument

public XmlDocument()
            throws XmlDocumentCheckedException

Throws:

XmlDocumentCheckedException - If the XML is invalid.

XmlDocument

public XmlDocument(File file)
            throws XmlDocumentCheckedException

Parameters:

file - The XML file.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

XmlDocument

public XmlDocument(File file,
 String enc)
            throws XmlDocumentCheckedException

Parameters:

file - The file containing the XML document

enc - The encoding

Throws:

XmlDocumentCheckedException - If the XML is invalid.

XmlDocument

public XmlDocument(InputStream in)
            throws XmlDocumentCheckedException

Parameters:

in - The input stream with the xml document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

XmlDocument

public XmlDocument(InputStream in,
 String enc)
            throws XmlDocumentCheckedException

Parameters:

in - The input stream with the xml document.

enc - the encoding

Throws:

XmlDocumentCheckedException - If the XML is invalid.

XmlDocument

public XmlDocument(Reader reader)
            throws XmlDocumentCheckedException

Parameters:

reader - The reader with the xml document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

XmlDocument

public XmlDocument(Node node,
 Document doc)

Parameters:

node - Node to create element from.

doc - Document to create element from.

XmlDocument

public XmlDocument(IXmlDocument xmlDocument)
            throws XmlDocumentCheckedException

Parameters:

xmlDocument - An xml document

Throws:

XmlDocumentCheckedException - If the XML is invalid.

XmlDocument

public XmlDocument(String xml)
            throws XmlDocumentCheckedException

Parameters:

xml - A string with hopefully valid XML.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

Method Details

addChild

public void addChild(IXmlElement child)
              throws XmlDocumentCheckedException

Description copied from interface: IXmlElement

This appends an IXmlElement object to the this element.

Specified by:

addChild in interface IXmlElement

Parameters:

child - Child to be added to current root node of this object.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

addToChild

public void addToChild(IXmlElement child,
 String parent)
                throws XmlDocumentCheckedException

Description copied from interface: IXmlElement

This method appends the input IXmlElement object to the element identified by the path.

Specified by:

addToChild in interface IXmlElement

Parameters:

parent - Parent XML that will have the child added to it.

child - XML Document

Throws:

XmlDocumentCheckedException - If the XML is invalid.

appendChildByName

public void appendChildByName(String parent,
 XmlDocument child)
                       throws XmlDocumentCheckedException

Parameters:

parent - Parent XML that will have the child added to it.

child - XML Document

Throws:

XmlDocumentCheckedException - If the XML is invalid.

clone

public IXmlDocument clone(boolean deep)
                   throws XmlDocumentCheckedException

Description copied from interface: IXmlElement

This method creates a copy of the existing IXmlElement object, including a clone of every child if and only if the deep parameter is set to be true.

Specified by:

clone in interface IXmlElement

Parameters:

deep - If true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element).

Returns:

A new XMLDocument that should be a copy of the current one.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

createChild

public IXmlElement createChild(String childName)
                        throws XmlDocumentCheckedException

Description copied from interface: IXmlElement

This method creates a new child under this element with an element name equal to the childName parameter. The returned element is referenced directly by this element's document after the operation.

Specified by:

createChild in interface IXmlElement

Parameters:

childName - the child name

Returns:

XmlDocument Contains the newly created child node

Throws:

XmlDocumentCheckedException - If the XML is invalid.

createChild

public IXmlElement createChild(String childName,
 String value)
                        throws XmlDocumentCheckedException

Description copied from interface: IXmlElement

This method creates a new child under this element with an element name equal to the childName parameter and a value equal to the value parameter. The returned element is referenced directly by this element's document after the operation.

Specified by:

createChild in interface IXmlElement

Parameters:

childName - The element's desired name.

value - The element's value.

Returns:

A new XMLElement with the name and value assigned to it.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

createChildren

public IXmlElement createChildren(String fullChildPath)
                           throws XmlDocumentCheckedException

Description copied from interface: IXmlElement

This method creates aall of the child elements referenced by the child path. The returned element is referenced directly by this element's document after the operation succeeds.

Specified by:

createChildren in interface IXmlElement

Parameters:

fullChildPath - The full child path for the element to be created from.

Returns:

A new XmlElement from the child.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

createChildByName

public XmlDocument createChildByName(String child)
                              throws XmlDocumentCheckedException

This method creates a standing alone XmlData object with sName and sValue. Note: NameSpace is not supported for all the implementations.

Parameters:

child - Child name in XPath format, like REQUEST/HEADER/INFO

Returns:

A new XML Document from the child.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getRootNode

public Node getRootNode()
                 throws XmlDocumentCheckedException

This method returns the root node of the internal XML document.

Specified by:

getRootNode in interface IXmlElement

Returns:

root node

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getDocument

public Document getDocument()
                     throws XmlDocumentCheckedException

This method returns the document node of the internal XML document.

Specified by:

getDocument in interface IXmlElement

Returns:

document node

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getPrivateElementNode

public Node getPrivateElementNode()

This method returns the root node of the internal XML document.

Returns:

root node

getPrivateDocument

public Document getPrivateDocument()

This method returns the document node of the internal XML document.

Returns:

document node

getAttribute

public String getAttribute(String name)
                    throws XmlDocumentCheckedException

Description copied from interface: IXmlElement

This method returns the attribute's value according to input attribute name.

Specified by:

getAttribute in interface IXmlElement

Parameters:

name - The attribute name.

Returns:

The attrivute's value. If there is no value it will return an empty string.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getAttributeByName

public final String getAttributeByName(String sName)
                                throws XmlDocumentCheckedException

Parameters:

sName - The attribute's name.

Returns:

The attribute's value; if there is no value it will return an empty string.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getAttributeNames

public Collection<String> getAttributeNames()
                                     throws XmlDocumentCheckedException

Description copied from interface: IXmlElement

This method returns all of the attribute names of the current node

Specified by:

getAttributeNames in interface IXmlElement

Returns:

A collection of attribute names associated with this document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getAttributeValues

public Collection<String> getAttributeValues()
                                      throws XmlDocumentCheckedException

Description copied from interface: IXmlElement

This method returns all of the attribute values of the current node.

Specified by:

getAttributeValues in interface IXmlElement

Returns:

A collection of attribute values associated with this document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getChild

public IXmlElement getChild(int index)
                     throws XmlDocumentCheckedException

.

Specified by:

getChild in interface IXmlElement

Parameters:

index - The desired position

Returns:

The child

Throws:

XmlDocumentCheckedException - If the XML is invalid.

selectChildren

public List<IXmlElement> selectChildren(String xpathQuery)
                                 throws XmlDocumentCheckedException

Specified by:

selectChildren in interface IXmlElement

Parameters:

xpathQuery - The XPath string designated the desired children.

Returns:

A list of the matching children. If there are no matching children it will return an empty list.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

selectChild

public IXmlElement selectChild(String xpathQuery)
                        throws XmlDocumentCheckedException

Specified by:

selectChild in interface IXmlElement

Parameters:

xpathQuery - The XPath string designated the desired child.

Returns:

The element with the matching child. Returns null if there is no match.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getChild

public IXmlElement getChild(String childName)
                     throws XmlDocumentCheckedException

Description copied from interface: IXmlElement

This method returns the first child element identified by the path. If multiple children with the given name exist, the first child found is returned. This method throws an exception if no child element matches the specified name.

Specified by:

getChild in interface IXmlElement

Parameters:

childName - The child's name.

Returns:

The corresponding element.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getChildAttribute

public String getChildAttribute(String child,
 String attr)
                         throws XmlDocumentCheckedException

Description copied from interface: IXmlElement

This method returns the attribute value of a child node.

Specified by:

getChildAttribute in interface IXmlElement

Parameters:

child - The child.

attr - The attribute of the child.

Returns:

The matching value; if there is no matching value it will return an empty string.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getChildrenCount

public final int getChildrenCount()
                           throws XmlDocumentCheckedException

Returns:

The number of children in this document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getChildCount

public int getChildCount()
                  throws XmlDocumentCheckedException

Description copied from interface: IXmlElement

This method returns the number of children.

Specified by:

getChildCount in interface IXmlElement

Returns:

The number of children.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getChildren

public Collection<IXmlElement> getChildren()
                                    throws XmlDocumentCheckedException

Description copied from interface: IXmlElement

This method returns all of this element's children.

Specified by:

getChildren in interface IXmlElement

Returns:

A list of children in the current document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getChildrenByName

public Collection<IXmlElement> getChildrenByName(String name)
                                          throws XmlDocumentCheckedException

Description copied from interface: IXmlElement

This method returns all of this element's children with the given name.

Specified by:

getChildrenByName in interface IXmlElement

Parameters:

name - The children's name.

Returns:

A list of children matching the name; it will return an empty collection if there are no matches.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getChildValue

public String getChildValue(String childName)
                     throws XmlDocumentCheckedException

Description copied from interface: IXmlElement

This method returns the descendent's value.

Specified by:

getChildValue in interface IXmlElement

Parameters:

childName - The name of the child.

Returns:

The value of the corresponding child.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getCDATASection

public String getCDATASection(String childName)
                       throws XmlDocumentCheckedException

Description copied from interface: IXmlElement

This method returns the descendent's value.

Specified by:

getCDATASection in interface IXmlElement

Parameters:

childName - The name of the child.

Returns:

The corresponding CDATA of the child.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getNodeValue

public final String getNodeValue(String sChild)
                          throws XmlDocumentCheckedException

Parameters:

sChild - The name of the child.

Returns:

The corresponding name value.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

selectNodesViaXPath

protected NodeList selectNodesViaXPath(String childName,
 Node root)
                                throws XmlDocumentCheckedException

Parameters:

childName - The child name.

root - The root node.

Returns:

The corresponding nodes.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getNodeTextValue

protected final String getNodeTextValue(Node node)
                                 throws XmlDocumentCheckedException

Parameters:

node - The node.

Returns:

The value of the corresponding node or an empty string if there is no value.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getCDATAValue

public final String getCDATAValue(String sChild)
                           throws XmlDocumentCheckedException

Parameters:

sChild - The child.

Returns:

The corresponding CDATA value or an empty String if there is none.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getCDATATextValue

protected final String getCDATATextValue(Node node)
                                  throws XmlDocumentCheckedException

Parameters:

node - The desired node.

Returns:

The corresponding CDATA value or an empty String if there is none.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getName

public String getName()
               throws XmlDocumentCheckedException

Description copied from interface: IXmlElement

This method returns the name of this element

Specified by:

getName in interface IXmlElement

Returns:

The name of the root node.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getNameSpace

public String getNameSpace()
                    throws XmlDocumentCheckedException

This method returns the namespace of the current node.

Specified by:

getNameSpace in interface IXmlDocument

Returns:

The namespace of the current node.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getValue

public String getValue()
                throws XmlDocumentCheckedException

This method returns the element's value

Specified by:

getValue in interface IXmlElement

Returns:

the value of the element

Throws:

XmlDocumentCheckedException - If the XML is invalid.

load

public void load(File file)
          throws XmlDocumentCheckedException

This method replaces the content of the current root node with that of the input file.

Specified by:

load in interface IXmlDocument

Parameters:

file - points to the XML file

Throws:

XmlDocumentCheckedException - If the XML is invalid.

load

public void load(File file,
 String enc)
          throws XmlDocumentCheckedException

This method replaces the content of the current root node with that of the input file.

Specified by:

load in interface IXmlDocument

Parameters:

file - points to the XML file

enc - The name of the supported character encoding

Throws:

XmlDocumentCheckedException - If the XML is invalid.

load

public void load(InputStream in)
          throws XmlDocumentCheckedException

This method replaces the content of the current root node with that of the InputStream.

Specified by:

load in interface IXmlDocument

Parameters:

in - A stream containing an XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

load

public void load(InputStream in,
 String enc)
          throws XmlDocumentCheckedException

This method replaces the content of the current root node with that of the InputStream.

Specified by:

load in interface IXmlDocument

Parameters:

in - A stream containing an XML document.

enc - The name of the supported character encoding

Throws:

XmlDocumentCheckedException - If the XML is invalid.

load

public void load(Reader reader)
          throws XmlDocumentCheckedException

This method replaces the content of the current root node with that of the Reader.

Specified by:

load in interface IXmlDocument

Parameters:

reader - A reader containing an XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

load

public void load(String xml)
          throws XmlDocumentCheckedException

This method replaces the content of the current root node with that of the input string.

Specified by:

load in interface IXmlDocument

Parameters:

xml - A string contains an XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

removeAttribute

public void removeAttribute(String attrName)
                     throws XmlDocumentCheckedException

This method removes an attribute from this element..

Specified by:

removeAttribute in interface IXmlElement

Parameters:

attrName - the name of the attribute

Throws:

XmlDocumentCheckedException - If the XML is invalid.

removeChild

public IXmlElement removeChild(int index)
                        throws XmlDocumentCheckedException

This method removes the index-th child element.

Specified by:

removeChild in interface IXmlElement

Parameters:

index - the index of the child to remove

Returns:

the removed child

Throws:

XmlDocumentCheckedException - If the XML is invalid.

removeChild

public IXmlElement removeChild(String childName)
                        throws XmlDocumentCheckedException

This method removes a child element.

Specified by:

removeChild in interface IXmlElement

Parameters:

childName - the name of the element to remove

Returns:

the removed child

Throws:

XmlDocumentCheckedException - If the XML is invalid.

removeChildrenWithXpath

public List<IXmlElement> removeChildrenWithXpath(String xpathQuery)
                                          throws XmlDocumentCheckedException

This method removes all child elements with the given xpath query.

Specified by:

removeChildrenWithXpath in interface IXmlElement

Parameters:

xpathQuery - query to identify elements

Returns:

the removed child

Throws:

XmlDocumentCheckedException - If the XML is invalid.

removeChildWithXpath

public IXmlElement removeChildWithXpath(String xpathQuery)
                                 throws XmlDocumentCheckedException

This method removes a single child element with the given xpath query.

Specified by:

removeChildWithXpath in interface IXmlElement

Parameters:

xpathQuery - query to identify element

Returns:

the removed child

Throws:

XmlDocumentCheckedException - If the XML is invalid.

removeChildAttribute

public void removeChildAttribute(String childName,
 String attrName)
                          throws XmlDocumentCheckedException

This method removes an attribute from a child element

Specified by:

removeChildAttribute in interface IXmlElement

Parameters:

childName - the name of the child element

attrName - the name of the attribute to remove

Throws:

XmlDocumentCheckedException - If the XML is invalid.

replaceAllChildren

public void replaceAllChildren(IXmlElement parent)
                        throws XmlDocumentCheckedException

Removes all of the element's children and adds all of the children of the provided parent element.

Specified by:

replaceAllChildren in interface IXmlElement

Parameters:

parent - the element whose children are added to this element

Throws:

XmlDocumentCheckedException - If the XML is invalid.

replaceChild

public IXmlElement replaceChild(int index,
 IXmlElement newChild)
                         throws XmlDocumentCheckedException

This method replaces the index-th element with the new element.

Specified by:

replaceChild in interface IXmlElement

Parameters:

index - the index of the child to replace

newChild - the child to add to this element

Returns:

the replaced element

Throws:

XmlDocumentCheckedException - If the XML is invalid.

replaceChild

public IXmlElement replaceChild(String childName,
 IXmlElement newChild)
                         throws XmlDocumentCheckedException

This method replaces the child element with the new element.

Specified by:

replaceChild in interface IXmlElement

Parameters:

childName - the name of the child to replace

newChild - the child to add to this element

Returns:

the replaced element

Throws:

XmlDocumentCheckedException - If the XML is invalid.

setAttribute

public IXmlElement setAttribute(String attrName,
 String value)
                         throws XmlDocumentCheckedException

Sets the value of an attribute of this element. If the attribute doesn't exist, it is created.

Specified by:

setAttribute in interface IXmlElement

Parameters:

attrName - the attribute name

value - the attribute value

Returns:

The element.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

setTextValue

protected final void setTextValue(Node node,
 String sValue)
                           throws XmlDocumentCheckedException

Parameters:

node - The specific node that will have its value set.

sValue - The value.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

setCDATASection

protected final void setCDATASection(Node node,
 String sValue)
                              throws Exception

Parameters:

node - The specific node that will have its value set.

sValue - The value.

Throws:

Exception - If something goes horribly wrong.

setCDATASection

public void setCDATASection(String value)
                     throws Exception

Description copied from interface: IXmlElement

Sets this element's CDATA value

Specified by:

setCDATASection in interface IXmlElement

Parameters:

value - The desired String that will become the target's value.

Throws:

Exception - If something goes horribly wrong.

setValue

public void setValue(String value)
              throws XmlDocumentCheckedException

Description copied from interface: IXmlElement

Sets this element's value

Specified by:

setValue in interface IXmlElement

Parameters:

value - The desired String that will become the node's value.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

write

public void write(File file)
           throws XmlDocumentCheckedException

Description copied from interface: IXmlElement

This method saves the stored XML document as a file.

Specified by:

write in interface IXmlElement

Parameters:

file - The file the XML will be saved to.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

write

public void write(OutputStream output)
           throws XmlDocumentCheckedException

This methods writes the content of the current XML document to the output stream.

Specified by:

write in interface IXmlElement

Parameters:

output - Contains the output stream to write to

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getRootElement

public IXmlElement getRootElement()
                           throws XmlDocumentCheckedException

Method getRootElement returns the root element for the xml document.

Specified by:

getRootElement in interface IXmlDocument

Returns:

IXmlElement root xml element

Throws:

XmlDocumentCheckedException - If the XML is invalid.

toString

public String toString()

Overrides:

toString in class Object

replaceFromStream

public boolean replaceFromStream(InputStream in)

This method replaces the content of the current root node with that of the InputStream.

Parameters:

in - A stream containing an XML document.

Returns:

boolean Indicates success or failure

replaceFromStream

public boolean replaceFromStream(InputStream in,
 String encoding)
                          throws UnsupportedEncodingException

This method replaces the content of the current root node with that of the InputStream.

Parameters:

in - A stream containing an XML document.

encoding - The name of the supported character encoding

Returns:

boolean Indicates success or failure

Throws:

UnsupportedEncodingException - If the encoding is not supported.

replaceFromReader

public boolean replaceFromReader(Reader reader)

This method replaces the content of the current root node with that of the reader.

Parameters:

reader - A reader stream with an XML document.

Returns:

boolean Indicates success or failure

replaceFromString

public final boolean replaceFromString(String xml)

This method replaces the content of the current root node with that of the input string.

Parameters:

xml - A string contains an XML document.

Returns:

boolean Indicates success or failure

prvGetChildByName

protected Node prvGetChildByName(String sChildName)

Description of the Method

Parameters:

sChildName - The child element's name.

Returns:

The node with the child element's name.

prvGetChildByName

protected Node prvGetChildByName(String sChildName,
 Node rootNode)

Description of the Method

Parameters:

sChildName - Description of Parameter

rootNode - Description of Parameter

Returns:

Description of the Returned Value

examineChild

protected Node examineChild(Document rootDoc,
 Node child)
                     throws XmlDocumentCheckedException

Description of the Method

Parameters:

rootDoc - Description of Parameter

child - Description of Parameter

Returns:

Description of the Returned Value

Throws:

XmlDocumentCheckedException - Description of Exception

cloneChildren

public static Node cloneChildren(Document doc,
 Node child)
                          throws XmlDocumentCheckedException

Clone a child node using the input document node

Parameters:

doc - Input document node

child - Child node to clone

Returns:

Cloned child node

Throws:

XmlDocumentCheckedException - When fails to clone

getAttributeCount

public final int getAttributeCount()
                            throws XmlDocumentCheckedException

Returns:

The number of attributes.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

isValid

public void isValid()
             throws XmlDocumentCheckedException

Description copied from interface: IXmlDocument

Determine if the xml document in question

Specified by:

isValid in interface IXmlDocument

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getAttributeNameByIndex

public final String getAttributeNameByIndex(int index)
                                     throws XmlDocumentCheckedException

Parameters:

index - Desired position.

Returns:

Attribute name.

Throws:

XmlDocumentCheckedException - If the XML is invalid.