to.etc.xml

Class DomTools

java.lang.Object

to.etc.xml.DomTools

public class DomTools
extends Object

Static utility class having stuff to easily obtain data from a DOM parsed document.

Author:

Frits Jalvingh

Field Summary

Fields

Modifier and Type	Field and Description
static Date	BIGBANG
static String	DBNULL
static Date	OBLIVIAN

Method Summary

Modifier and Type	Method and Description
static boolean	boolAttr(Node n, String aname)
static boolean	boolAttr(Node n, String aname, boolean defval)
static Boolean	booleanNode(Node rootnode, String name) Finds the child node with the name specified, and returns it as a boolean value.
static boolean	boolNode(Node rootnode, String name) Finds the child node with the name specified, and returns it as a boolean value.
static Date	dateDecode(String s) Decodes a date and converts it to the local time.
static String	dateEncode(Date dt) Encodes a date-only field to some readable form.
static Date	dateNode(Node rn, String name)
static Date	dateNode(Node rn, String name, Date dflt)
static boolean	decodeBoolStr(String nt, String name)
static double	doubleNode(Node rootnode, String name, double val)
static String	fileNameNode(Node rootnode, String name) Checks if there's a file node with the spec'd name in the node.
static String	findChildNodeValue(Node rootnode, String name) Deprecated.
static Document	getDocument(File inf, boolean nsaware) Creates a DOM parser, parses the document, and returns the DOM associated with the thing.
static Document	getDocument(File inf, ErrorHandler eh, boolean nsaware) Creates a DOM parser, parses the document, and returns the DOM associated with the thing.
static Document	getDocument(InputStream is, String ident, boolean nsaware) Creates a DOM parser, parses the document, and returns the DOM associated with the thing.
static Document	getDocument(InputStream is, String ident, ErrorHandler eh, boolean nsaware) Creates a DOM parser, parses the document, and returns the DOM associated with the thing.
static Document	getDocument(Reader is, String ident, boolean nsaware) Creates a DOM parser, parses the document, and returns the DOM associated with the thing.
static Document	getDocument(Reader is, String ident, ErrorHandler eh, boolean nsaware) Creates a DOM parser, parses the document, and returns the DOM associated with the thing.
static Document	getDocumentFromZIP(File zipfile, String name, ErrorHandler eh, boolean nsaware)
static Node	getDocumentRoot(String txt, String ident, boolean nsaware)
static Node	getDocumentRoot(String txt, String ident, ErrorHandler eh, boolean nsaware)
static int	getNodeAttribute(Node n, String aname, int defval) Get the named attribute from a node.
static String	getNodeAttribute(Node n, String aname, String defval) Get the named attribute from a node.
static Node	getRootElement(Document doc)
static XMLInputFactory	getStreamFactory() Get a stream reader that does not ^&*^(^$ connect to the Internet while fscking reading xml 8-(
static String[]	getStringList(Node inn, String itemname)
static List<String>	getStringList(Node inn, String listname, String itemname)
static int	intAttr(Node n, String aname)
static int	intAttr(Node n, String aname, int defval)
static int	intNode(Node rootnode, String name)
static int	intNode(Node rootnode, String name, int val)
static boolean	isBigBang(Date dt)
static boolean	isOblivian(Date dt)
static boolean	isTextOnly(Node inn)
static long	longAttr(Node n, String aname)
static Long	longAttrWrapped(Node n, String aname)
static long	longNode(Node rootnode, String name)
static long	longNode(Node rootnode, String name, long val)
static Long	longWrapperNode(Node rootnode, String name)
static Node	nodeFind(Node rn, String name) Finds a single element with the name spec'd in the node.
static Node	nodeFindXpath(Node node, String xpathQuery) Finds a child node, via the xpath query route.
static List<Node>	nodesFind(Node rn, String name) Searches for child Nodes in the specified Node which have the specified name and returns the result as a Set.
static void	saveDocument(File of, Document doc)
static void	saveDocument(Writer of, Document doc)
static void	setAttr(Node elem, String name, String value)
static String	strAttr(Node n, String aname)
static String	strAttr(Node n, String aname, String def)
static String	stringNode_untrimmed(Node rootnode, String name) Finds the child node with the name specified, and returns it's text value.
static String	stringNode_untrimmed(Node rootnode, String name, String deflt) Finds the child node with the name specified, and returns it's text value.
static String	stringNode(Node rootnode, String name) Finds the child node with the name specified, and returns it's text value.
static String	stringNode(Node rootnode, String name, int trunclen) Finds the child node with the name specified, and returns it's text value.
static String	stringNode(Node rootnode, 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 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

Field Detail

OBLIVIAN

public static final Date OBLIVIAN

BIGBANG

public static final Date BIGBANG

DBNULL

public static final String DBNULL

See Also:

Constant Field Values

Method Detail

getDocument

public static Document getDocument(InputStream is,
                                   String ident,
                                   ErrorHandler eh,
                                   boolean nsaware)
                            throws Exception

Creates a DOM parser, parses the document, and returns the DOM associated with the thing. If errors occur they are logged into an error message string; these are thrown as an exception when complete.

Throws:

Exception

getDocumentRoot

public static Node getDocumentRoot(String txt,
                                   String ident,
                                   ErrorHandler eh,
                                   boolean nsaware)
                            throws Exception

Throws:

Exception

getDocumentRoot

public static Node getDocumentRoot(String txt,
                                   String ident,
                                   boolean nsaware)
                            throws Exception

Throws:

Exception

getDocument

public static Document getDocument(Reader is,
                                   String ident,
                                   ErrorHandler eh,
                                   boolean nsaware)
                            throws Exception

Creates a DOM parser, parses the document, and returns the DOM associated with the thing. If errors occur they are logged into an error message string; these are thrown as an exception when complete.

Throws:

Exception

getDocument

public static Document getDocument(File inf,
                                   ErrorHandler eh,
                                   boolean nsaware)
                            throws Exception

Creates a DOM parser, parses the document, and returns the DOM associated with the thing. If errors occur they are logged into an error message string; these are thrown as an exception when complete.

Throws:

Exception

getDocument

@Nonnull
public static Document getDocument(@Nonnull
                                            File inf,
                                            boolean nsaware)
                                     throws Exception

Creates a DOM parser, parses the document, and returns the DOM associated with the thing. If errors occur they are logged into an error message string; these are thrown as an exception when complete.

Throws:

Exception

getDocument

public static Document getDocument(InputStream is,
                                   String ident,
                                   boolean nsaware)
                            throws Exception

Creates a DOM parser, parses the document, and returns the DOM associated with the thing. If errors occur they are logged into an error message string; these are thrown as an exception when complete.

Throws:

Exception

getDocument

public static Document getDocument(Reader is,
                                   String ident,
                                   boolean nsaware)
                            throws Exception

Creates a DOM parser, parses the document, and returns the DOM associated with the thing. If errors occur they are logged into an error message string; these are thrown as an exception when complete.

Throws:

Exception

getDocumentFromZIP

public static Document getDocumentFromZIP(File zipfile,
                                          String name,
                                          ErrorHandler eh,
                                          boolean nsaware)
                                   throws Exception

Throws:

Exception

nodeFind

public static Node nodeFind(Node rn,
                            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

nodesFind

public static List<Node> nodesFind(Node rn,
                                   String name)

Searches for child Nodes in the specified Node which have the specified name and returns the result as a Set. If null is specified for the parentNode an empty Set is returned.

Parameters:

rn, - the Node which is queried.

name, - the name of the childNodes we are searching.

Returns:

a Set containing the childnodes with the specified name.

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

@Nullable
public static String textFrom(@Nonnull
                                        Node n)

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

findChildNodeValue

@Deprecated
public static String findChildNodeValue(Node rootnode,
                                                    String name)
                                             throws Exception

Deprecated.

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

See Also:

stringNode(Node, String)

stringNode

public static String stringNode(Node rootnode,
                                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 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 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 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 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 name)
                     throws Exception

Throws:

Exception

dateNode

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

Throws:

Exception

timeNode

public static int timeNode(Node rn,
                           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 name)
                   throws Exception

Throws:

Exception

intNode

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

Throws:

Exception

longWrapperNode

public static Long longWrapperNode(Node rootnode,
                                   String name)
                            throws Exception

Throws:

Exception

longNode

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

Throws:

Exception

longNode

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

Throws:

Exception

doubleNode

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

Throws:

Exception

fileNameNode

public static String fileNameNode(Node rootnode,
                                  String name)
                           throws Exception

Checks if there's a file node with the spec'd name in the node. If so this returns the node's filename... If the node doesn't exist this returns null..

Parameters:

rootnode -

name -

Returns:

Throws:

Exception

boolNode

public static boolean boolNode(Node rootnode,
                               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

booleanNode

public static Boolean booleanNode(Node rootnode,
                                  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

decodeBoolStr

public static boolean decodeBoolStr(String nt,
                                    String name)

getNodeAttribute

public static String getNodeAttribute(@Nonnull
                                      Node n,
                                      @Nonnull
                                      String aname,
                                      @Nullable
                                      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 aname,
                             String def)

strAttr

@Nonnull
public static String strAttr(@Nonnull
                                      Node n,
                                      @Nonnull
                                      String aname)

intAttr

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

Throws:

Exception

intAttr

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

Throws:

Exception

longAttr

public static long longAttr(Node n,
                            String aname)
                     throws Exception

Throws:

Exception

longAttrWrapped

public static Long longAttrWrapped(Node n,
                                   String aname)
                            throws Exception

Throws:

Exception

boolAttr

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

Throws:

Exception

boolAttr

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

Throws:

Exception

getNodeAttribute

public static int getNodeAttribute(Node n,
                                   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

dateEncode

public static String dateEncode(Date dt)

Encodes a date-only field to some readable form. Can be decoded by decodeDate or getNodeDate(). The date contains local timezone info.

Parameters:

dt - the date to encode.

Returns:

a string

dateDecode

public static Date dateDecode(String s)

Decodes a date and converts it to the local time. The format MUST match the format generated by encode or we fail. Dates can contain three special values:

(dbnull)

The date field is null

big-bang

The date field represents a date before any other date,

oblivian

The dtae field represents a date after any other date.

 Format:
 0123456789012345678901234567
 2001-12-24 18:10:52.0012 (timezone)

Parameters:

s -

Returns:

isOblivian

public static final boolean isOblivian(Date dt)

isBigBang

public static final boolean isBigBang(Date dt)

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

isTextOnly

public static boolean isTextOnly(Node inn)

saveDocument

public static void saveDocument(File of,
                                Document doc)
                         throws Exception

Throws:

Exception

saveDocument

public static void saveDocument(Writer of,
                                Document doc)
                         throws Exception

Throws:

Exception

setAttr

public static void setAttr(Node elem,
                           String name,
                           String value)

nodeFindXpath

public static Node nodeFindXpath(Node node,
                                 String xpathQuery)
                          throws Exception

Finds a child node, via the xpath query route. Thus the name of all the nodes, separated by a "/". The path can only use unique names. If a child node with the same name exists an exception will be thrown.

Parameters:

node - the node to search

xpathQuery - path to the child node

Returns:

the child node, or null if it cannot be found.

Throws:

Exception

getStreamFactory

@Nonnull
public static XMLInputFactory getStreamFactory()

Get a stream reader that does not ^&*^(^$ connect to the Internet while fscking reading xml 8-(

Returns: