to.etc.xml

Class DOMDecoderBase

java.lang.Object

to.etc.xml.DOMDecoderBase

Direct Known Subclasses:

DOMDecoder

public class DOMDecoderBase
extends Object

Constructor Summary

Constructors

Constructor and Description
DOMDecoderBase()
DOMDecoderBase(Node root)
DOMDecoderBase(Node currentRoot, String defaultNamespace, String encodingNamespace)
DOMDecoderBase(String encodingNamespace)

Method Summary

Modifier and Type	Method and Description
Date	dateOnly(String name) Returns an encoded DATE string, represented by xsd:date.
Date	dateOnly(String name, Date deflt) Returns an encoded DATE string, represented by xsd:date.
Date	dateTime(String name) Returns an encoded DATE string, encoded by xsd:dateTime.
Iterable<DOMDecoder>	getChildIterator() Creates an iterator for ALL nodes below the currently selected node.
Node	getCurrentRoot() Return the current root for node lookups.
String	getDefaultNamespace()
String	getEncodingNamespace()
void	into(String name) Like select this locates the named element and makes it current, but this one aborts if the element is not present.
Iterable<DOMDecoder>	list(String name) When present this selects the node with the specified name, and initializes a list-walk at this level.
Iterable<DOMDecoder>	list(String name, String childNodeName)
Node	nodeFind(Node rn, String ns, String name) Finds a single element with the name spec'd in the node.
Node	nodeGet(Node rn, String ns, String name)
String	oneOf(String name, String... list)
boolean	selectNode(String name) Checks if the specified node in the current namespace is present in the currentRoot.
void	setCurrentRoot(Node currentRoot)
void	setDefaultNamespace(String defaultNamespace)
void	setEncodingNamespace(String encodingNamespace)
String	string(String name) Mandatory string node.
String	string(String name, int maxlen)
String	string(String name, String dflt) Finds the 0..1 string in the specified root, returns the default value if the string is not found.
String	string(String name, String dflt, int maxlen)
String	textFrom_untrimmed(Node n) Gets the text part contained in a node...
String	textFrom(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(Node root)

DOMDecoderBase

public DOMDecoderBase(String encodingNamespace)

DOMDecoderBase

public DOMDecoderBase(Node currentRoot,
                      String defaultNamespace,
                      String encodingNamespace)

Method Detail

string

public String string(String name)

Mandatory string node.

Parameters:

rootnode -

ns -

name -

Returns:

string

public String string(String name,
                     int maxlen)

string

public String string(String name,
                     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 String string(String name,
                     String dflt,
                     int maxlen)

oneOf

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

dateOnly

public Date dateOnly(String name)

Returns an encoded DATE string, represented by xsd:date.

Parameters:

name -

Returns:

dateOnly

public Date dateOnly(String name,
                     Date deflt)

Returns an encoded DATE string, represented by xsd:date.

Parameters:

name -

Returns:

dateTime

public Date dateTime(String name)

Returns an encoded DATE string, encoded by xsd:dateTime.

Parameters:

name -

Returns:

getCurrentRoot

public Node getCurrentRoot()

Return the current root for node lookups.

Returns:

selectNode

public boolean selectNode(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(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 Iterable<DOMDecoder> list(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 Iterable<DOMDecoder> list(String name,
                                 String childNodeName)

getChildIterator

public Iterable<DOMDecoder> getChildIterator()

Creates an iterator for ALL nodes below the currently selected node.

Returns:

nodeFind

public Node nodeFind(Node rn,
                     String ns,
                     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 Node nodeGet(Node rn,
                    String ns,
                    String name)

textFrom_untrimmed

public 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 String textFrom(Node n)

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

getEncodingNamespace

public String getEncodingNamespace()

setEncodingNamespace

public void setEncodingNamespace(String encodingNamespace)

getDefaultNamespace

public String getDefaultNamespace()

setDefaultNamespace

public void setDefaultNamespace(String defaultNamespace)

setCurrentRoot

public void setCurrentRoot(Node currentRoot)