to.etc.xml

Class NSDomTools

java.lang.Object

to.etc.xml.NSDomTools

public class NSDomTools
extends Object

DomTools version that is namespace-aware. Created on Oct 12, 2005

Author:

jal

Constructor Summary

Constructors

Constructor and Description
NSDomTools()

Method Summary

Modifier and Type	Method and Description
static boolean	boolAttr(Node n, String ns, String aname)
static boolean	boolAttr(Node n, String ns, String aname, boolean defval)
static boolean	boolNode(Node rootnode, String ns, String name) Finds the child node with the name specified, and returns it as a boolean value.
static Date	dateNode(Node rn, String ns, String name)
static Date	dateNode(Node rn, String ns, String name, Date dflt)
static double	doubleNode(Node rootnode, String ns, String name, double val)
static int	getNodeAttribute(Node n, String ns, String aname, int defval) Get the named attribute from a node.
static String	getNodeAttribute(Node n, String ns, String aname, String defval) Get the named attribute from a node.
static Node	getRootElement(Document doc)
static String[]	getStringList(Node inn, String itemname)
static List<String>	getStringList(Node inn, String listname, String itemname)
static int	intAttr(Node n, String ns, String aname)
static int	intAttr(Node n, String ns, String aname, int defval)
static int	intNode(Node rootnode, String ns, String name)
static int	intNode(Node rootnode, String ns, String name, int val)
static long	longNode(Node rootnode, String ns, String name)
static long	longNode(Node rootnode, String ns, String name, long val)
static Node	nodeFind(Node rn, String ns, String name) Finds a single element with the name spec'd in the node.
static String	strAttr(Node n, String ns, String aname, String def)
static String	stringNode_untrimmed(Node rootnode, String ns, String name) Finds the child node with the name specified, and returns it's text value.
static String	stringNode_untrimmed(Node rootnode, String ns, String name, String deflt) Finds the child node with the name specified, and returns it's text value.
static String	stringNode(Node rootnode, String ns, String name) Finds the child node with the name specified, and returns it's text value.
static String	stringNode(Node rootnode, String ns, String name, int trunclen) Finds the child node with the name specified, and returns it's text value.
static String	stringNode(Node rootnode, String ns, String name, String deflt) Finds the child node with the name specified, and returns it's text value.
static String	textFrom_untrimmed(Node n) Gets the text part contained in a node...
static String	textFrom(Node n) Gets the text part contained in a node...
static int	timeNode(Node rn, String ns, String name, int dflt) Scans a node as a hh:mm:ss time (or hh:mm).

Methods inherited from class java.lang.Object

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

Constructor Detail

NSDomTools

public NSDomTools()

Method Detail

nodeFind

public static Node nodeFind(Node rn,
                            String ns,
                            String name)
                     throws Exception

Finds a single element with the name spec'd in the node. If more than one node with the same name exists this throws an exception.

Throws:

Exception

textFrom_untrimmed

public static String textFrom_untrimmed(Node n)

Gets the text part contained in a node... All text parts are obtained and concatenated with a single space.

textFrom

public static String textFrom(Node n)

Gets the text part contained in a node... All text parts are obtained and concatenated with a single space.

stringNode

public static String stringNode(Node rootnode,
                                String ns,
                                String name)
                         throws Exception

Finds the child node with the name specified, and returns it's text value. If the node is not found it returns null.

Throws:

Exception

stringNode

public static String stringNode(Node rootnode,
                                String ns,
                                String name,
                                int trunclen)
                         throws Exception

Finds the child node with the name specified, and returns it's text value. If the node is not found it returns null.

Throws:

Exception

stringNode

public static String stringNode(Node rootnode,
                                String ns,
                                String name,
                                String deflt)
                         throws Exception

Finds the child node with the name specified, and returns it's text value. If the node is not found it returns the default string.

Throws:

Exception

stringNode_untrimmed

public static String stringNode_untrimmed(Node rootnode,
                                          String ns,
                                          String name)
                                   throws Exception

Finds the child node with the name specified, and returns it's text value. If the node is not found it returns null.

Throws:

Exception

stringNode_untrimmed

public static String stringNode_untrimmed(Node rootnode,
                                          String ns,
                                          String name,
                                          String deflt)
                                   throws Exception

Finds the child node with the name specified, and returns it's text value. If the node is not found it returns the default string.

Throws:

Exception

dateNode

public static Date dateNode(Node rn,
                            String ns,
                            String name)
                     throws Exception

Throws:

Exception

dateNode

public static Date dateNode(Node rn,
                            String ns,
                            String name,
                            Date dflt)
                     throws Exception

Throws:

Exception

timeNode

public static int timeNode(Node rn,
                           String ns,
                           String name,
                           int dflt)
                    throws Exception

Scans a node as a hh:mm:ss time (or hh:mm). The time is returned as a #seconds in the day.

Parameters:

rn -

name -

dflt -

Returns:

Throws:

Exception

intNode

public static int intNode(Node rootnode,
                          String ns,
                          String name)
                   throws Exception

Throws:

Exception

intNode

public static int intNode(Node rootnode,
                          String ns,
                          String name,
                          int val)
                   throws Exception

Throws:

Exception

longNode

public static long longNode(Node rootnode,
                            String ns,
                            String name)
                     throws Exception

Throws:

Exception

longNode

public static long longNode(Node rootnode,
                            String ns,
                            String name,
                            long val)
                     throws Exception

Throws:

Exception

doubleNode

public static double doubleNode(Node rootnode,
                                String ns,
                                String name,
                                double val)
                         throws Exception

Throws:

Exception

boolNode

public static boolean boolNode(Node rootnode,
                               String ns,
                               String name)
                        throws Exception

Finds the child node with the name specified, and returns it as a boolean value. If the node has NO text associated then this returns TRUE, if the node is not present then this returns false; if the node is present and has text the text field is interpreted: if numeric we return T if the number is not null; if text the value must start with T for true and F for false. All other values throw an exception.

Throws:

Exception

getNodeAttribute

public static String getNodeAttribute(Node n,
                                      String ns,
                                      String aname,
                                      String defval)

Get the named attribute from a node. If the attribute is not present return the default value in defval

Parameters:

n - the node to containing the attribute.

aname - the name of the attribute.

defval - the value to return if the attribute is not present,

Returns:

a string containing the attribute's value or the default.

strAttr

public static String strAttr(Node n,
                             String ns,
                             String aname,
                             String def)

intAttr

public static int intAttr(Node n,
                          String ns,
                          String aname,
                          int defval)
                   throws Exception

Throws:

Exception

intAttr

public static int intAttr(Node n,
                          String ns,
                          String aname)
                   throws Exception

Throws:

Exception

boolAttr

public static boolean boolAttr(Node n,
                               String ns,
                               String aname)
                        throws Exception

Throws:

Exception

boolAttr

public static boolean boolAttr(Node n,
                               String ns,
                               String aname,
                               boolean defval)
                        throws Exception

Throws:

Exception

getNodeAttribute

public static int getNodeAttribute(Node n,
                                   String ns,
                                   String aname,
                                   int defval)
                            throws Exception

Get the named attribute from a node. If the attribute is not present return the default value in defval

Parameters:

n - the node to containing the attribute.

aname - the name of the attribute.

defval - the value to return if the attribute is not present,

Returns:

a string containing the attribute's value or the default.

Throws:

Exception

getStringList

public static final String[] getStringList(Node inn,
                                           String itemname)
                                    throws Exception

Throws:

Exception

getStringList

public static final List<String> getStringList(Node inn,
                                               String listname,
                                               String itemname)
                                        throws Exception

Throws:

Exception

getRootElement

public static Node getRootElement(Document doc)
                           throws Exception

Throws:

Exception