Package com.nfbsoftware.xml

Interface IXmlDocument

All Superinterfaces:

IXmlElement, Serializable

All Known Implementing Classes:

XmlDocument

public interface IXmlDocument
extends IXmlElement

Author:

Brendan Clemenzi

Method Summary

Modifier and Type	Method	Description
String	getNameSpace()	This method returns the namespace of the current node.
IXmlElement	getRootElement()	Method getRootElement returns the root element for the xml document.
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 encoding)	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 encoding)	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.

Methods inherited from interface com.nfbsoftware.xml.IXmlElement

addChild, addToChild, clone, createChild, createChild, createChildren, getAttribute, getAttributeNames, getAttributeValues, getCDATASection, getChild, getChild, getChildAttribute, getChildCount, getChildren, getChildrenByName, getChildValue, getDocument, getName, getRootNode, getValue, removeAttribute, removeChild, removeChild, removeChildAttribute, removeChildrenWithXpath, removeChildWithXpath, replaceAllChildren, replaceChild, replaceChild, selectChild, selectChildren, setAttribute, setCDATASection, setValue, write, write

Method Details

getNameSpace

String getNameSpace()
             throws XmlDocumentCheckedException

This method returns the namespace of the current node.

Returns:

The namespace of the current node.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

load

void load(File file)
   throws XmlDocumentCheckedException

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

Parameters:

file - points to the XML file

Throws:

XmlDocumentCheckedException - If the XML is invalid.

load

void load(File file,
 String encoding)
   throws XmlDocumentCheckedException

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

Parameters:

file - points to the XML file

encoding - The name of the supported character encoding

Throws:

XmlDocumentCheckedException - If the XML is invalid.

load

void load(Reader reader)
   throws XmlDocumentCheckedException

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

Parameters:

reader - A reader containing an XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

load

void load(InputStream in)
   throws XmlDocumentCheckedException

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

Parameters:

in - A stream containing an XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

load

void load(InputStream in,
 String encoding)
   throws XmlDocumentCheckedException

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

Throws:

XmlDocumentCheckedException - If the XML is invalid.

load

void load(String xml)
   throws XmlDocumentCheckedException

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

Parameters:

xml - A string contains an XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

getRootElement

IXmlElement getRootElement()
                    throws XmlDocumentCheckedException

Method getRootElement returns the root element for the xml document.

Returns:

IXmlElement root xml element

Throws:

XmlDocumentCheckedException - If the XML is invalid.

isValid

void isValid()
      throws XmlDocumentCheckedException

Determine if the xml document in question

Throws:

XmlDocumentCheckedException - If the XML is invalid.