to.etc.xml
Class DOMDecoderBase

java.lang.Object
  extended by to.etc.xml.DOMDecoderBase
Direct Known Subclasses:
DOMDecoder

public class DOMDecoderBase
extends java.lang.Object


Constructor Summary
DOMDecoderBase()
           
DOMDecoderBase(org.w3c.dom.Node root)
           
DOMDecoderBase(org.w3c.dom.Node currentRoot, java.lang.String defaultNamespace, java.lang.String encodingNamespace)
           
DOMDecoderBase(java.lang.String encodingNamespace)
           
 
Method Summary
 java.util.Date dateOnly(java.lang.String name)
          Returns an encoded DATE string, represented by xsd:date.
 java.util.Date dateOnly(java.lang.String name, java.util.Date deflt)
          Returns an encoded DATE string, represented by xsd:date.
 java.util.Date dateTime(java.lang.String name)
          Returns an encoded DATE string, encoded by xsd:dateTime.
 java.lang.Iterable<DOMDecoder> getChildIterator()
          Creates an iterator for ALL nodes below the currently selected node.
 org.w3c.dom.Node getCurrentRoot()
          Return the current root for node lookups.
 java.lang.String getDefaultNamespace()
           
 java.lang.String getEncodingNamespace()
           
 void into(java.lang.String name)
          Like select this locates the named element and makes it current, but this one aborts if the element is not present.
 java.lang.Iterable<DOMDecoder> list(java.lang.String name)
          When present this selects the node with the specified name, and initializes a list-walk at this level.
 java.lang.Iterable<DOMDecoder> list(java.lang.String name, java.lang.String childNodeName)
           
 org.w3c.dom.Node nodeFind(org.w3c.dom.Node rn, java.lang.String ns, java.lang.String name)
          Finds a single element with the name spec'd in the node.
 org.w3c.dom.Node nodeGet(org.w3c.dom.Node rn, java.lang.String ns, java.lang.String name)
           
 java.lang.String oneOf(java.lang.String name, java.lang.String... list)
           
 boolean selectNode(java.lang.String name)
          Checks if the specified node in the current namespace is present in the currentRoot.
 void setCurrentRoot(org.w3c.dom.Node currentRoot)
           
 void setDefaultNamespace(java.lang.String defaultNamespace)
           
 void setEncodingNamespace(java.lang.String encodingNamespace)
           
 java.lang.String string(java.lang.String name)
          Mandatory string node.
 java.lang.String string(java.lang.String name, int maxlen)
           
 java.lang.String string(java.lang.String name, java.lang.String dflt)
          Finds the 0..1 string in the specified root, returns the default value if the string is not found.
 java.lang.String string(java.lang.String name, java.lang.String dflt, int maxlen)
           
 java.lang.String textFrom_untrimmed(org.w3c.dom.Node n)
          Gets the text part contained in a node...
 java.lang.String textFrom(org.w3c.dom.Node n)
          Gets the text part contained in a node...
 void up()
           
 void up(int count)
          Move n nodes UP.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DOMDecoderBase

public DOMDecoderBase()

DOMDecoderBase

public DOMDecoderBase(org.w3c.dom.Node root)

DOMDecoderBase

public DOMDecoderBase(java.lang.String encodingNamespace)

DOMDecoderBase

public DOMDecoderBase(org.w3c.dom.Node currentRoot,
                      java.lang.String defaultNamespace,
                      java.lang.String encodingNamespace)
Method Detail

string

public java.lang.String string(java.lang.String name)
Mandatory string node.

Parameters:
rootnode -
ns -
name -
Returns:

string

public java.lang.String string(java.lang.String name,
                               int maxlen)

string

public java.lang.String string(java.lang.String name,
                               java.lang.String dflt)
Finds the 0..1 string in the specified root, returns the default value if the string is not found.

Parameters:
rootnode -
ns -
name -
dflt -
Returns:

string

public java.lang.String string(java.lang.String name,
                               java.lang.String dflt,
                               int maxlen)

oneOf

public java.lang.String oneOf(java.lang.String name,
                              java.lang.String... list)

dateOnly

public java.util.Date dateOnly(java.lang.String name)
Returns an encoded DATE string, represented by xsd:date.

Parameters:
name -
Returns:

dateOnly

public java.util.Date dateOnly(java.lang.String name,
                               java.util.Date deflt)
Returns an encoded DATE string, represented by xsd:date.

Parameters:
name -
Returns:

dateTime

public java.util.Date dateTime(java.lang.String name)
Returns an encoded DATE string, encoded by xsd:dateTime.

Parameters:
name -
Returns:

getCurrentRoot

public org.w3c.dom.Node getCurrentRoot()
Return the current root for node lookups.

Returns:

selectNode

public boolean selectNode(java.lang.String name)
Checks if the specified node in the current namespace is present in the currentRoot. If the node is not present it returns false, leaving the currentRoot unaltered. If the node is present it gets selected as the new currentRoot and the routine returns true.

Parameters:
name -
Returns:

into

public void into(java.lang.String name)
Like select this locates the named element and makes it current, but this one aborts if the element is not present.

Parameters:
name -

up

public void up(int count)
Move n nodes UP.

Parameters:
count -

up

public void up()

list

public java.lang.Iterable<DOMDecoder> list(java.lang.String name)
When present this selects the node with the specified name, and initializes a list-walk at this level. This returns an iterator for the nodes below the list. If the node specified does not exist it returns the empty iterator. this call returns true (indicating the node exists) you can


list

public java.lang.Iterable<DOMDecoder> list(java.lang.String name,
                                           java.lang.String childNodeName)

getChildIterator

public java.lang.Iterable<DOMDecoder> getChildIterator()
Creates an iterator for ALL nodes below the currently selected node.

Returns:

nodeFind

public org.w3c.dom.Node nodeFind(org.w3c.dom.Node rn,
                                 java.lang.String ns,
                                 java.lang.String name)
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.


nodeGet

public org.w3c.dom.Node nodeGet(org.w3c.dom.Node rn,
                                java.lang.String ns,
                                java.lang.String name)

textFrom_untrimmed

public java.lang.String textFrom_untrimmed(org.w3c.dom.Node n)
Gets the text part contained in a node... All text parts are obtained and concatenated with a single space.


textFrom

public java.lang.String textFrom(org.w3c.dom.Node n)
Gets the text part contained in a node... All text parts are obtained and concatenated with a single space.


getEncodingNamespace

public java.lang.String getEncodingNamespace()

setEncodingNamespace

public void setEncodingNamespace(java.lang.String encodingNamespace)

getDefaultNamespace

public java.lang.String getDefaultNamespace()

setDefaultNamespace

public void setDefaultNamespace(java.lang.String defaultNamespace)

setCurrentRoot

public void setCurrentRoot(org.w3c.dom.Node currentRoot)