com.soundhelix.util

Class XMLUtils

java.lang.Object

com.soundhelix.util.XMLUtils

public final class XMLUtils
extends Object

Implements some static methods for parsing XML data.

Author:

Thomas Schuerger (thomas@schuerger.com)

Method Summary

Methods

Modifier and Type	Method and Description
static <T> T	getInstance(SongContext songContext, Class<T> superclazz, Node node, long parentRandomSeed, int salt) Tries to instantiate an instance from the class defined by the node's attribute "class" by calling its nullary (empty) constructor.
static Node	getNode(String path, Node node) Returns the node found at the given path.
static NodeList	getNodeList(String path, Node node) Returns the node list found at the given path.
static boolean	parseBoolean(Random random, Node node) Tries to parse the text content of the given node as a boolean.
static boolean	parseBoolean(Random random, String path, Node node) Searches for the element pointed to by path and tries to parse it as a boolean.
static double	parseDouble(Random random, Node node) Tries to parse the text content of the given node as an integer.
static double	parseDouble(Random random, String path, Node node) Searches for the element pointed to by path and tries to parse it as an integer.
static int	parseInteger(Random random, Node node) Tries to parse the text content of the given node as an integer.
static int	parseInteger(Random random, String path, Node node) Searches for the element pointed to by path and tries to parse it as an integer.
static int[]	parseIntegerListString(Random random, String path, Node node) Searches for the element pointed to by path and tries to parse it as an integer list.
static String	parseString(Random random, Node node) Tries to parse the given node as a string.
static String	parseString(Random random, String path, Node node) Searches for the element pointed to by path and tries to parse it as a string.
static String[]	parseStringList(Random random, Node node, char separatorChar) Tries to parse the given node as a string.
static String[]	parseStringList(Random random, String path, Node node, char separatorChar) Searches for the element pointed to by path and tries to parse it as a string list, split by the given separator character.

Methods inherited from class java.lang.Object

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

Method Detail

getNode

public static Node getNode(String path,
           Node node)
                    throws XPathExpressionException

Returns the node found at the given path.

Parameters:

path - the XPath expression relative to the node

node - the node

Returns:

the node list

Throws:

XPathExpressionException - in case of an XPath expression problem

getNodeList

public static NodeList getNodeList(String path,
                   Node node)
                            throws XPathExpressionException

Returns the node list found at the given path.

Parameters:

path - the XPath expression relative to the node

node - the node

Returns:

the node list

Throws:

XPathExpressionException - in case of an XPath expression problem

parseInteger

public static int parseInteger(Random random,
               String path,
               Node node)

Searches for the element pointed to by path and tries to parse it as an integer.

Parameters:

random - the random generator

path - the XPath expression relative to the node

node - the node

Returns:

the integer

parseInteger

public static int parseInteger(Random random,
               Node node)

Tries to parse the text content of the given node as an integer. If it is an integer, the integer is returned. Otherwise, the node is checked for valid subelements, which are then evaluated.

Parameters:

random - the random generator

node - the node to parse

Returns:

the integer

parseDouble

public static double parseDouble(Random random,
                 String path,
                 Node node)

Searches for the element pointed to by path and tries to parse it as an integer.

Parameters:

random - the random generator

path - the XPath expression relative to the node

node - the node

Returns:

the integer

parseDouble

public static double parseDouble(Random random,
                 Node node)

Tries to parse the text content of the given node as an integer. If it is an integer, the integer is returned. Otherwise, the node is checked for valid subelements, which are then evaluated.

Parameters:

random - the random generator

node - the node to parse

Returns:

the integer

parseBoolean

public static boolean parseBoolean(Random random,
                   String path,
                   Node node)

Searches for the element pointed to by path and tries to parse it as a boolean.

Parameters:

random - the random generator

path - the XPath expression relative to the node

node - the node

Returns:

the boolean

parseBoolean

public static boolean parseBoolean(Random random,
                   Node node)

Tries to parse the text content of the given node as a boolean. If it is a boolean, the boolean. Otherwise, the node is checked for valid subelements, which are then evaluated.

Parameters:

random - the random generator

node - the node to parse

Returns:

the boolean

parseString

public static String parseString(Random random,
                 String path,
                 Node node)

Searches for the element pointed to by path and tries to parse it as a string.

Parameters:

random - the random generator

path - the XPath expression relative to the node

node - the node

Returns:

the integer

parseStringList

public static String[] parseStringList(Random random,
                       String path,
                       Node node,
                       char separatorChar)

Searches for the element pointed to by path and tries to parse it as a string list, split by the given separator character.

Parameters:

random - the random generator

path - the XPath expression relative to the node

node - the node

separatorChar - the separator character

Returns:

the integer

parseString

public static String parseString(Random random,
                 Node node)

Tries to parse the given node as a string.

Parameters:

random - the random generator

node - the node

Returns:

the string (or null)

parseStringList

public static String[] parseStringList(Random random,
                       Node node,
                       char separatorChar)

Tries to parse the given node as a string.

Parameters:

random - the random generator

node - the node

separatorChar - the separator character

Returns:

the string (or null)

parseIntegerListString

public static int[] parseIntegerListString(Random random,
                           String path,
                           Node node)

Searches for the element pointed to by path and tries to parse it as an integer list.

Parameters:

random - the random generator

path - the XPath expression relative to the node

node - the node

Returns:

the integer array

getInstance

public static <T> T getInstance(SongContext songContext,
                Class<T> superclazz,
                Node node,
                long parentRandomSeed,
                int salt)
                     throws InstantiationException,
                            XPathException,
                            IllegalAccessException,
                            ClassNotFoundException

Tries to instantiate an instance from the class defined by the node's attribute "class" by calling its nullary (empty) constructor. If the given class name is not fully qualified (i.e., contains no dot), the package of the given superclass plus "." is prefixed to the class name (unless the given superclass is an interface, then the package plus ".impl." is prefixed to the class name). The class must be a subclass of the given class (or implement the interface) to succeed. If the class defines the interface RandomSeedable, it is random-seeded by creating a random seed based on the specified random seed, the class name and the specified modifier. If the class defines the interface XMLConfigurable, it is configured by calling configure() with the node as the configuration root. The given salt value can be overridden by using a "salt" or "seed" attribute.

Type Parameters:

T - the type

Parameters:

songContext - the song context

superclazz - the superclass

node - the node to use for configuration

parentRandomSeed - the random seed origin to use (the random seed of the parent component)

salt - the random salt (each instance created by the parent should use a different salt value)

Returns:

the instance

Throws:

InstantiationException - if the class cannot be instantiated

XPathException - in case of an XPath problem

ClassNotFoundException - if the class cannot be found

IllegalAccessException - if the class cannot be instantiated