cz.muni.fi.mir.mathmlunificator.utils

Class DOMBuilder

java.lang.Object

cz.muni.fi.mir.mathmlunificator.utils.DOMBuilder

public class DOMBuilder
extends Object

Tools for building DOM from various string representations.

Author:

Michal Růžička

Constructor Summary

Constructors

Constructor and Description
DOMBuilder()

Method Summary

Modifier and Type	Method and Description
static Document	buildDoc(File file) Build W3C DOM representation of XML from File.
static Document	buildDoc(InputSource is) Build W3C DOM representation of XML from InputSource.
static Document	buildDoc(InputStream is) Build W3C DOM representation of XML from InputStream.
static Document	buildDoc(String doc) Build W3C DOM representation of XML file specified by filesystem path.
static Document	buildDocFromFilepath(String filepath) Build W3C DOM representation of XML file specified by filesystem path.
static Node	cloneNodeToNewDoc(Node nodeToClone, boolean deep) Create new W3C DOM document with only child node created as the clone of the given node (detached from the DOM of the source node) and return the cloned node attached to the new document.
static Document	createEmptyDoc() Create new empty document.
static Document	createNewDocWithNodeClone(Node nodeToClone, boolean deep) Create new W3C DOM document with only child node created as the clone of the given node (detached from the DOM of the source node).
static DocumentBuilder	getDocumentBuilder() Get W3C DOM document builder with common configuration set: most importantly build is set to be namesapace aware.

Methods inherited from class java.lang.Object

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

Constructor Detail

DOMBuilder

public DOMBuilder()

Method Detail

buildDocFromFilepath

public static Document buildDocFromFilepath(String filepath)
                                     throws ParserConfigurationException,
                                            SAXException,
                                            IOException

Build W3C DOM representation of XML file specified by filesystem path.

Parameters:

filepath - Path of the file in filesystem to build DOM from.

Returns:

W3C DOM representation of the XML document.

Throws:

ParserConfigurationException - If a DocumentBuilder cannot be created which satisfies the configuration requested.

SAXException - If any parse errors occur.

IOException - If any IO errors occur.

buildDoc

public static Document buildDoc(String doc)
                         throws ParserConfigurationException,
                                SAXException,
                                IOException

Build W3C DOM representation of XML file specified by filesystem path.

Parameters:

doc - String with XML document to build DOM from.

Returns:

W3C DOM representation of the XML document.

Throws:

ParserConfigurationException - If a DocumentBuilder cannot be created which satisfies the configuration requested.

SAXException - If any parse errors occur.

IOException - If any IO errors occur.

buildDoc

public static Document buildDoc(File file)
                         throws ParserConfigurationException,
                                SAXException,
                                IOException

Build W3C DOM representation of XML from File.

Parameters:

file - XML File to build DOM from.

Returns:

W3C DOM representation of the XML document.

Throws:

ParserConfigurationException - If a DocumentBuilder cannot be created which satisfies the configuration requested.

SAXException - If any parse errors occur.

IOException - If any IO errors occur.

buildDoc

public static Document buildDoc(InputSource is)
                         throws ParserConfigurationException,
                                SAXException,
                                IOException

Build W3C DOM representation of XML from InputSource.

Parameters:

is - Input source to build DOM from.

Returns:

W3C DOM representation of the XML document.

Throws:

ParserConfigurationException - If a DocumentBuilder cannot be created which satisfies the configuration requested.

SAXException - If any parse errors occur.

IOException - If any IO errors occur.

buildDoc

public static Document buildDoc(InputStream is)
                         throws ParserConfigurationException,
                                SAXException,
                                IOException

Build W3C DOM representation of XML from InputStream.

Parameters:

is - Input stream to build DOM from.

Returns:

W3C DOM representation of the XML document.

Throws:

ParserConfigurationException - If a DocumentBuilder cannot be created which satisfies the configuration requested.

SAXException - If any parse errors occur.

IOException - If any IO errors occur.

createEmptyDoc

public static Document createEmptyDoc()

Create new empty document.

Returns:

New empty W3C DOM document if successful; null otherwise.

createNewDocWithNodeClone

public static Document createNewDocWithNodeClone(Node nodeToClone,
                                                 boolean deep)

Create new W3C DOM document with only child node created as the clone of the given node (detached from the DOM of the source node).

Parameters:

nodeToClone - Node to clone as the only child node of the new document.

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

Returns:

New W3C DOM document with the only child node created as the clone of the given node (detached from the DOM of the source node).

cloneNodeToNewDoc

public static Node cloneNodeToNewDoc(Node nodeToClone,
                                     boolean deep)

Create new W3C DOM document with only child node created as the clone of the given node (detached from the DOM of the source node) and return the cloned node attached to the new document.

Parameters:

nodeToClone - Node to clone as the only child node of the new document.

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

Returns:

Clone of the given node attached as the only child node to a new W3C DOM document.

getDocumentBuilder

public static DocumentBuilder getDocumentBuilder()
                                          throws ParserConfigurationException

Get W3C DOM document builder with common configuration set: most importantly build is set to be namesapace aware.

Returns:

W3C DOM document builder with common configuration.

Throws:

ParserConfigurationException