com.databasesandlife.util

Class DomParser

java.lang.Object

com.databasesandlife.util.DomParser

Direct Known Subclasses:

DomElementReplacer

public class DomParser
extends Object

Author:

This source is copyright Adrian Smith and licensed under the LGPL 3.

See Also:

Project on GitHub

Constructor Summary

Constructors

Constructor and Description
DomParser()

Method Summary

Modifier and Type	Method and Description
static void	assertNoOtherElements(Node container, String... elements)
static Element	from(File f)
static Element	from(InputStream f)
static Element	getElementFromXPath(Document document, String expression)
static Element	getElementFromXPath(Element root, String expression)
static List<Element>	getElementsFromXPath(Document document, String expression)
static List<Element>	getElementsFromXPath(Element root, String expression)
static XPathExpression	getExpression(String expression)
static String	getMandatoryAttribute(Element node, String attributeName)
static Element	getMandatorySingleSubElement(Node node, String subNodeName)
static NodeList	getNodesFromXPath(Document document, String expression)
static NodeList	getNodesFromXPath(Element root, String expression)
static String	getOptionalAttribute(Element node, String attributeName)
static String	getOptionalAttribute(Element node, String attributeName, String defaultValue)
static Element	getOptionalSingleSubElement(Element node, String subNodeName)
static String	getOptionalSingleSubElementTextContent(Element node, String subNodeName)
static List<Element>	getSubElements(Node container, String... elementNames)
static DocumentBuilder	newDocumentBuilder()
static Map<String,Double>	parseDoubleMap(Element container, String elementName, String keyAttribute, String valueAttribute)
static List<String>	parseList(Element container, String elementName)
static List<String>	parseList(Element container, String elementName, String attribute)
static double	parseMandatoryDoubleAttribute(Element node, String attributeName)
static Map<String,String>	parseMap(Element container, String elementName, String keyAttribute)
static Map<String,String>	parseMap(Element container, String elementName, String keyAttribute, String valueAttribute)
static int	parseOptionalIntAttribute(Element node, String attributeName, int defaultValue)
static Integer	parseOptionalIntegerAttribute(Element node, String attributeName)
static Set<String>	parseSet(Element container, String elementName)
static Set<String>	parseSet(Element container, String elementName, String attribute)
static List<Element>	toElementList(NodeList nl)

Methods inherited from class java.lang.Object

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

Constructor Detail

DomParser

public DomParser()

Method Detail

getSubElements

public static List<Element> getSubElements(Node container,
                                           String... elementNames)

Parameters:

elementNames - can be "*"

assertNoOtherElements

public static void assertNoOtherElements(Node container,
                                         String... elements)
                                  throws ConfigurationException

Throws:

ConfigurationException

getMandatoryAttribute

public static String getMandatoryAttribute(Element node,
                                           String attributeName)
                                    throws ConfigurationException

Throws:

ConfigurationException

getOptionalAttribute

public static String getOptionalAttribute(Element node,
                                          String attributeName,
                                          String defaultValue)

getOptionalAttribute

public static String getOptionalAttribute(Element node,
                                          String attributeName)

Returns:

null if the attribute is not defined

parseMandatoryDoubleAttribute

public static double parseMandatoryDoubleAttribute(Element node,
                                                   String attributeName)
                                            throws ConfigurationException

Throws:

ConfigurationException

parseOptionalIntegerAttribute

public static Integer parseOptionalIntegerAttribute(Element node,
                                                    String attributeName)
                                             throws ConfigurationException

Returns:

null if attribute not found

Throws:

ConfigurationException

parseOptionalIntAttribute

public static int parseOptionalIntAttribute(Element node,
                                            String attributeName,
                                            int defaultValue)
                                     throws ConfigurationException

Throws:

ConfigurationException

getMandatorySingleSubElement

public static Element getMandatorySingleSubElement(Node node,
                                                   String subNodeName)
                                            throws ConfigurationException

Parameters:

subNodeName - can be "*"

Throws:

ConfigurationException - if more than one element found

getOptionalSingleSubElement

public static Element getOptionalSingleSubElement(Element node,
                                                  String subNodeName)
                                           throws ConfigurationException

Parameters:

subNodeName - can be "*"

Returns:

null if element not found

Throws:

ConfigurationException - if more than one element found

getOptionalSingleSubElementTextContent

public static String getOptionalSingleSubElementTextContent(Element node,
                                                            String subNodeName)
                                                     throws ConfigurationException

Parameters:

subNodeName - can be "*"

Returns:

null if element not found

Throws:

ConfigurationException - if more than one element found

parseList

public static List<String> parseList(Element container,
                                     String elementName,
                                     String attribute)
                              throws ConfigurationException

Throws:

ConfigurationException

parseSet

public static Set<String> parseSet(Element container,
                                   String elementName,
                                   String attribute)
                            throws ConfigurationException

Throws:

ConfigurationException

parseList

public static List<String> parseList(Element container,
                                     String elementName)
                              throws ConfigurationException

Throws:

ConfigurationException

parseSet

public static Set<String> parseSet(Element container,
                                   String elementName)
                            throws ConfigurationException

Throws:

ConfigurationException

parseMap

public static Map<String,String> parseMap(Element container,
                                          String elementName,
                                          String keyAttribute,
                                          String valueAttribute)
                                   throws ConfigurationException

Throws:

ConfigurationException

parseMap

public static Map<String,String> parseMap(Element container,
                                          String elementName,
                                          String keyAttribute)
                                   throws ConfigurationException

Throws:

ConfigurationException

parseDoubleMap

public static Map<String,Double> parseDoubleMap(Element container,
                                                String elementName,
                                                String keyAttribute,
                                                String valueAttribute)
                                         throws ConfigurationException

Throws:

ConfigurationException

getExpression

public static XPathExpression getExpression(String expression)
                                     throws XPathExpressionException

Throws:

XPathExpressionException

getNodesFromXPath

public static NodeList getNodesFromXPath(Document document,
                                         String expression)
                                  throws XPathExpressionException

Throws:

XPathExpressionException

getNodesFromXPath

public static NodeList getNodesFromXPath(Element root,
                                         String expression)
                                  throws XPathExpressionException

Throws:

XPathExpressionException

getElementsFromXPath

public static List<Element> getElementsFromXPath(Document document,
                                                 String expression)
                                          throws XPathExpressionException

Throws:

XPathExpressionException

getElementsFromXPath

public static List<Element> getElementsFromXPath(Element root,
                                                 String expression)
                                          throws XPathExpressionException

Throws:

XPathExpressionException

toElementList

public static List<Element> toElementList(NodeList nl)

getElementFromXPath

public static Element getElementFromXPath(Document document,
                                          String expression)
                                   throws XPathExpressionException

Throws:

XPathExpressionException

getElementFromXPath

public static Element getElementFromXPath(Element root,
                                          String expression)
                                   throws XPathExpressionException

Throws:

XPathExpressionException

from

public static Element from(File f)
                    throws ConfigurationException

Throws:

ConfigurationException

from

public static Element from(InputStream f)
                    throws ConfigurationException

Throws:

ConfigurationException

newDocumentBuilder

public static DocumentBuilder newDocumentBuilder()