com.knowgate.xhtml

Class XMLDocument

java.lang.Object

com.knowgate.xhtml.XMLDocument

public class XMLDocument
extends Object

Direct character-level manipulations for XML documents. This class modifies XML document files by directly seeking substrings inside its text. Given a well-knonw XML file structure is easier and faster to seek for <nodes> as substrings instead of parsing the whole documents into a DOM tree.

Version:

2.2

Author:

Sergio Montoro Ten

Constructor Summary

Constructors

Constructor and Description
XMLDocument()
XMLDocument(String sFile) Create XMLDocument and load an XML file into memory.
XMLDocument(String sFile, String sEnc) Create XMLDocument and load an XML file into memory.

Method Summary

Modifier and Type	Method and Description
void	addNode(String sAfterXPath, String sNode) Add a piece of XML text after a given node identifier by an XPath expression.
void	addNodeAndSave(String sAfterXPath, String sNode) Add a piece of XML text after a given node and save document.
String	getCharacterEncoding()
void	load(String sFile) Load an XML file into memory.
void	load(String sFile, String sEnc) Load an XML file into memory.
void	removeNode(String sXPath) Remove a node.
void	removeNodeAndSave(String sXPath) Remove a node and save document.
void	save() Save file to disk.
void	save(String sFile) Save file to disk.
void	setCharacterEncoding(String sEnc)
String	toString() Get loaded file as a String

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLDocument

public XMLDocument()

XMLDocument

public XMLDocument(String sFile)
            throws IOException,
                   OutOfMemoryError

Create XMLDocument and load an XML file into memory.

No node parsing is done, but file is loaded directly into a String.

Parameters:

sFile - File Path

Throws:

IOException

OutOfMemoryError

XMLDocument

public XMLDocument(String sFile,
                   String sEnc)
            throws IOException,
                   OutOfMemoryError

Create XMLDocument and load an XML file into memory.

Parameters:

sFile - File Path

sEnc - Character Encoding

Throws:

IOException

OutOfMemoryError

Method Detail

getCharacterEncoding

public String getCharacterEncoding()

setCharacterEncoding

public void setCharacterEncoding(String sEnc)

load

public void load(String sFile,
                 String sEnc)
          throws IOException,
                 OutOfMemoryError

Load an XML file into memory. No node parsing is done, but file is loaded directly into a String.

Parameters:

sFile - File Path

sEnc - Character encoding

Throws:

IOException

OutOfMemoryError

load

public void load(String sFile)
          throws IOException,
                 OutOfMemoryError

Load an XML file into memory.

No node parsing is done, but file is loaded directly into a String.
Character encoding is UTF-8 by default unless changed by calling setEncoding()

Parameters:

sFile - File Path

Throws:

IOException

OutOfMemoryError

save

public void save(String sFile)
          throws IOException

Save file to disk. If it already exists it is overwritten.

Parameters:

sFile - File Path

Throws:

IOException

save

public void save()
          throws IOException

Save file to disk. Save to same path used for loading the file.

Throws:

IOException

toString

public String toString()

Get loaded file as a String

Overrides:

toString in class Object

addNode

public void addNode(String sAfterXPath,
                    String sNode)
             throws DOMException

Add a piece of XML text after a given node identifier by an XPath expression.

Parameters:

sAfterXPath - Restricted XPath expression for node after witch the next node is to be placed. For example :
"pageset/pages/page[@guid="123456789012345678901234567890AB"]/blocks/block[@id="003"]" will add sNode text after <block id="003">…</block> substring.
"pageset/pages/page[position()=last()]" will add sNode text after last <page>…</page> substring.

sNode - XML Text to be added.

Throws:

DOMException - DOMException Codes:

NOT_FOUND_ERR	A node or attribute from the XPath expression was not found
INVALID_ACCESS_ERR	An attribute expression is invalid
NOT_SUPPORTED_ERR	position() function was used but last() was not specified as value for it

addNodeAndSave

public void addNodeAndSave(String sAfterXPath,
                           String sNode)
                    throws DOMException,
                           IOException

Add a piece of XML text after a given node and save document. Document is saved to the same file path where if was loaded.

Parameters:

sAfterXPath - Restricted XPath expression for node after witch the next node is to be placed.

sNode - XML Text to be added.

Throws:

DOMException

IOException

removeNode

public void removeNode(String sXPath)
                throws DOMException

Remove a node.

Parameters:

sXPath - Restricted XPath expression for node to remove. For example: "pageset/pages/page[@guid="123456789012345678901234567890AB"]/blocks/block[@id="003"]" will remove <block id="003">…</block> substring.

Throws:

DOMException

removeNodeAndSave

public void removeNodeAndSave(String sXPath)
                       throws DOMException,
                              IOException

Remove a node and save document. Document is saved to the same file path where if was loaded.

Parameters:

sXPath - XPath expression for node to remove.

Throws:

DOMException

IOException