DomUtils (Clinical Document Library 2.0.2 API)

java.lang.Object
- au.gov.nehta.common.utils.DomUtils

public final class DomUtils
extends Object

Utility class to manipulate DOM objects.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addAttribute(Element elem, String attrName, String attrValue)` Adds an attribute to the element.
`static boolean`	`checkElement(Element elem, String name, String namespace)` Returns true if the element matches the name and namespace.
`static void`	`checkNotNullOrEmpty(Document xmlDoc, String name)` Throws an exception if the document is null or contains no nodes.
`static Element`	`getChildElement(Element element, String namespace, String tagName)` Get the child `Element` of the `Element` with the namespace and tagName.
`static List<Element>`	`getChildElements(Element element, String namespace, String tagName)` Get the child `Element`s of the `Element` with the namespace and tagName.
`static List<Element>`	`getChildElements(Node node)` Extract all child DOM `Element`s from the DOM `Node`.
`static Element`	`getFirstChildElement(Node node)` Returns the first element from a nodes child nodes.
`static boolean`	`isDocumentEmpty(Document xmlDoc)` Returns 'true' if the XML document contains no nodes, otherwise 'false'.
`static Document`	`newDocument()` Creates a new empty XML document.
`static Document`	`newDocument(Node rootNode)` Creates a new XML document using the node as the root.
`static Document`	`parse(File file)` Loads an XML document from file.
`static Document`	`parse(Reader reader)` Loads an XML document from a reader.
`static Document`	`parse(Reader reader, ErrorHandler errorHandler)` Loads an XML document from a reader.
`static void`	`removeFormatting(Document xmlDoc)` Removes the formatting whitespaces, namely removes whitespace between child elements and removes leading and trailing whitespaces in elements with textual content.
`static void`	`removeFormatting(Element xmlElem)` Removes the formatting whitespaces, namely removes whitespace between child elements and removes leading and trailing whitespaces in elements with textual content.
`static void`	`serialise(Document xmlDoc, File file)` Serialises an XML `Document` to a file.
`static void`	`serialise(Document xmlDoc, Writer writer)` Serialises an XML `Document` to a character stream.
`static String`	`serialiseToString(Document xmlDoc)` Returns a serialised XML representation of the XML `Document`.
`static String`	`serialiseToString(Element xmlElem)` Returns a serialised XML representation of the XML `Document`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - newDocument
```
public static Document newDocument()
                            throws ParserConfigurationException
```
    Creates a new empty XML document.
    
    Returns:
    
    Empty XML document.
    
    Throws:
    
    ParserConfigurationException - Exception if any parser problem.
  - newDocument
```
public static Document newDocument(Node rootNode)
                            throws ParserConfigurationException
```
    Creates a new XML document using the node as the root.
    
    Parameters:
    
    rootNode - Root node. Cannot be null.
    
    Returns:
    
    Created XML document.
    
    Throws:
    
    ParserConfigurationException - Exception if any parser problem.
  - parse
```
public static Document parse(File file)
                      throws ParserConfigurationException,
                             IOException,
                             SAXException
```
    Loads an XML document from file.
    
    Parameters:
    
    file - File path to the XML file. Cannot be null.
    
    Returns:
    
    Loaded XML document.
    
    Throws:
    
    ParserConfigurationException - Exception if any parser problem.
    
    IOException - Exception if problems reading file.
    
    SAXException - Exception if problems with SAX.
  - parse
```
public static Document parse(Reader reader)
                      throws ParserConfigurationException,
                             IOException,
                             SAXException
```
    Loads an XML document from a reader.
    
    Parameters:
    
    reader - Input character stream containing the XML content. Cannot be null.
    
    Returns:
    
    Loaded XML document.
    
    Throws:
    
    ParserConfigurationException - Exception if any parser problem.
    
    IOException - Exception if problems reading file.
    
    SAXException - Exception if problems with SAX.
  - parse
```
public static Document parse(Reader reader,
                             ErrorHandler errorHandler)
                      throws ParserConfigurationException,
                             SAXException,
                             IOException
```
    Loads an XML document from a reader.
    
    Parameters:
    
    reader - Input character stream containing the XML content. Cannot be null.
    
    errorHandler - Callback handler for errors from parser. Optional.
    
    Returns:
    
    Loaded XML document.
    
    Throws:
    
    ParserConfigurationException - Exception if any parser problem.
    
    IOException - Exception if problems reading file.
    
    SAXException - Exception if problems with SAX.
  - serialiseToString
```
public static String serialiseToString(Element xmlElem)
                                throws TransformerException,
                                       IOException
```
    Returns a serialised XML representation of the XML Document.
    
    Parameters:
    
    xmlElem - An XML Element. Cannot be null.
    
    Returns:
    
    A serialised XML representation of the XML Document.
    
    Throws:
    
    TransformerException - Exception if any transformation problems.
    
    IOException - Exception if problems writing.
  - serialiseToString
```
public static String serialiseToString(Document xmlDoc)
                                throws TransformerException,
                                       IOException
```
    Returns a serialised XML representation of the XML Document.
    
    Parameters:
    
    xmlDoc - An XML Document. Cannot be null.
    
    Returns:
    
    A serialised XML representation of the XML Document.
    
    Throws:
    
    TransformerException - Exception if any transformation problems.
    
    IOException - Exception if problems writing.
  - serialise
```
public static void serialise(Document xmlDoc,
                             File file)
                      throws TransformerException,
                             IOException
```
    Serialises an XML Document to a file.
    
    Parameters:
    
    xmlDoc - An XML Document. Cannot be null.
    
    file - The file to serialise the the XML Document to. Cannot be null.
    
    Throws:
    
    TransformerException - Exception if any transformation problems.
    
    IOException - Exception if problems writing.
  - serialise
```
public static void serialise(Document xmlDoc,
                             Writer writer)
                      throws TransformerException,
                             IOException
```
    Serialises an XML Document to a character stream.
    
    Parameters:
    
    xmlDoc - An XML Document. Cannot be null.
    
    writer - A character stream to which the XML Document is serialised. Cannot be null.
    
    Throws:
    
    TransformerException - Exception if any transformation problems.
    
    IOException - Exception if any problems writing.
  - getFirstChildElement
```
public static Element getFirstChildElement(Node node)
```
    Returns the first element from a nodes child nodes.
    
    Parameters:
    
    node - Node that has child nodes. Cannot be null.
    
    Returns:
    
    Returns the first element found else returns null.
  - getChildElements
```
public static List<Element> getChildElements(Node node)
```
    Extract all child DOM Elements from the DOM Node.
    
    Parameters:
    
    node - The DOM Node. Cannot be null.
    
    Returns:
    
    A list of child Elements of the Node.
  - getChildElement
```
public static Element getChildElement(Element element,
                                      String namespace,
                                      String tagName)
```
    Get the child Element of the Element with the namespace and tagName.
    
    Parameters:
    
    element - The source Element. Cannot be null.
    
    namespace - The namespace of the child Element. Cannot be null nor blank.
    
    tagName - The tagName of the child Element. Cannot be null nor blank.
    
    Returns:
    
    The child Element with the given namespace and tagName.
    
    Throws:
    
    IllegalArgumentException - If the element does not have exactly one child element with the required namespace and tagName.
  - getChildElements
```
public static List<Element> getChildElements(Element element,
                                             String namespace,
                                             String tagName)
```
    Get the child Elements of the Element with the namespace and tagName.
    
    Parameters:
    
    element - The source Element. Cannot be null.
    
    namespace - The namespace of the child Elements. Cannot be null nor blank.
    
    tagName - The tagName of the child Elements. Cannot be null nor blank.
    
    Returns:
    
    A list of child Elements with the given namespace and tagName.
    
    Throws:
    
    IllegalArgumentException - If the element does not have at least one child element with the required namespace and tagName.
  - addAttribute
```
public static void addAttribute(Element elem,
                                String attrName,
                                String attrValue)
```
    Adds an attribute to the element.
    
    Parameters:
    
    elem - Element to add the attribute to. Cannot be null.
    
    attrName - Name of the attribute. Cannot be null nor blank.
    
    attrValue - Value of the attribute. Cannot be null nor blank.
  - isDocumentEmpty
```
public static boolean isDocumentEmpty(Document xmlDoc)
```
    Returns 'true' if the XML document contains no nodes, otherwise 'false'.
    
    Parameters:
    
    xmlDoc - XML document. Cannot be null.
    
    Returns:
    
    'true' if empty otherwise 'false'.
  - checkNotNullOrEmpty
```
public static void checkNotNullOrEmpty(Document xmlDoc,
                                       String name)
```
    Throws an exception if the document is null or contains no nodes.
    
    Parameters:
    
    xmlDoc - XML document to check.
    
    name - Name of the instance. Cannot be null.
  - checkElement
```
public static boolean checkElement(Element elem,
                                   String name,
                                   String namespace)
```
    Returns true if the element matches the name and namespace.
    
    Parameters:
    
    elem - Element. Cannot be null.
    
    name - Name of the element. Cannot be null nor blank.
    
    namespace - Namespace of the element. Cannot be null nor blank.
    
    Returns:
    
    True if the element matches the name and namespace otherwise false.
  - removeFormatting
```
public static void removeFormatting(Document xmlDoc)
```
    Removes the formatting whitespaces, namely removes whitespace between child elements and removes leading and trailing whitespaces in elements with textual content.
    
    Parameters:
    
    xmlDoc - The DOM document to format. The formatting whitespaces will be removed from this document. If the document is null, nothing happens.
  - removeFormatting
```
public static void removeFormatting(Element xmlElem)
```
    Removes the formatting whitespaces, namely removes whitespace between child elements and removes leading and trailing whitespaces in elements with textual content.
    
    Parameters:
    
    xmlElem - The DOM element to format. The formatting whitespaces will be removed from this element. If the element is null, nothing happens.

Class DomUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

newDocument

newDocument

parse

parse

parse

serialiseToString

serialiseToString

serialise

serialise

getFirstChildElement

getChildElements

getChildElement

getChildElements

addAttribute

isDocumentEmpty

checkNotNullOrEmpty

checkElement

removeFormatting

removeFormatting