eu.bandm.tools.tpath.tdomclient

Class TdomClient<E extends TypedElement<E,X>,X extends TypedExtension>

java.lang.Object

eu.bandm.tools.tpath.tdomclient.TdomClient<E,X>

All Implemented Interfaces:

DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

public class TdomClient<E extends TypedElement<E,X>,X extends TypedExtension>
extends Object
implements DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

Field Summary

Fields

Modifier and Type	Field and Description
protected NodeSet<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>	emptyNodeSet
protected NodeSet<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>	emptyNodeSetReverse
protected MessageReceiver<? super SimpleMessage<XMLDocumentIdentifier>>	msg

Constructor Summary

Constructors

Constructor and Description
TdomClient()

Method Summary

Modifier and Type	Method and Description
NodeSet<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>	attributeAxis(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node) Returns a NodeSet with all attribute nodes.
NodeSet<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>	childAxis(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node, boolean reverse) Returns a NodeSet with all child elements.
NodeSet<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>	childAxis(eu.bandm.tools.tpath.tdomclient.TdomClient.Element el, boolean reverse)
boolean	commentTest(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node) Returns whether a node is a comment.
Comparator<? super eu.bandm.tools.tpath.tdomclient.TdomClient.Node>	documentOrder()
NodeSet<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>	followingSiblingAxis(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node) Returns a NodeSet with all following sibling elements.
URI	getBaseURI(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node) Returns null iff not possible to find out.
eu.bandm.tools.tpath.tdomclient.TdomClient.Node	getDocument(URI uri) The xpath core library "document()" function has complicated signatures, but finally breaks down to load a document from an URI.
eu.bandm.tools.tpath.tdomclient.TdomClient.Node	getElementById(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node, String id) retrieves an element (or null) by the text value of the ID-type attribute.
String	getLocalName(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node) Returns null iff node is neither Element nor Attribute; otherwise the local name.
NamespaceName	getNamespaceName(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node) Returns null iff node is neither Element nor Attribute; otherwise the NamespaceName.
String	getNamespaceURI(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node) Returns null iff node is neither Element nor Attribute; otherwise the URI the namespace prefix is bound to.
eu.bandm.tools.tpath.tdomclient.TdomClient.Node	getParent(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node) returns the parent node; null for Document.
String	getPITarget(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node) returns the target identifier; may only be called with a PI-node!
eu.bandm.tools.tpath.tdomclient.TdomClient.Node	getRoot(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node) returns the owning Document.
boolean	nameTest(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node, PrincipalNodeType pnt, String uri, String suffix) uri and suffix may be ==null, which means "not tested".
NodeSet<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>	parentAxis(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node) Returns a NodeSet with the one direct parent.
NodeSet<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>	precedingSiblingAxis(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node) Returns a NodeSet with all preceding sibling elements.
boolean	processingInstructionTest(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node, String target) Returns whether a node is PI.
void	setMessageReceiver(MessageReceiver<? super SimpleMessage<XMLDocumentIdentifier>> msg)
String	stringValue(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node) Never returns null, but possibly empty String [XPath 1.0:5].
boolean	textTest(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node) Returns whether a node is PCDATA.

Methods inherited from class java.lang.Object

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

Field Detail

msg

protected MessageReceiver<? super SimpleMessage<XMLDocumentIdentifier>> msg

emptyNodeSet

protected final NodeSet<eu.bandm.tools.tpath.tdomclient.TdomClient.Node> emptyNodeSet

emptyNodeSetReverse

protected final NodeSet<eu.bandm.tools.tpath.tdomclient.TdomClient.Node> emptyNodeSetReverse

Constructor Detail

TdomClient

public TdomClient()

Method Detail

setMessageReceiver

public void setMessageReceiver(MessageReceiver<? super SimpleMessage<XMLDocumentIdentifier>> msg)

getLocalName

public String getLocalName(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node)

Description copied from interface: DocumentClient

Returns null iff node is neither Element nor Attribute; otherwise the local name. This is the part after the colon ":" in namspace mode; otherwise the whole name. May be called with any node.

Specified by:

getLocalName in interface DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

getNamespaceURI

public String getNamespaceURI(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node)

Description copied from interface: DocumentClient

Returns null iff node is neither Element nor Attribute; otherwise the URI the namespace prefix is bound to. May be called with any node.

Specified by:

getNamespaceURI in interface DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

getNamespaceName

public NamespaceName getNamespaceName(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node)

Description copied from interface: DocumentClient

Returns null iff node is neither Element nor Attribute; otherwise the NamespaceName. May be called with any node.

Specified by:

getNamespaceName in interface DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

getBaseURI

public URI getBaseURI(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node)

Returns null iff not possible to find out.

Specified by:

getBaseURI in interface DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

getDocument

public eu.bandm.tools.tpath.tdomclient.TdomClient.Node getDocument(URI uri)

The xpath core library "document()" function has complicated signatures, but finally breaks down to load a document from an URI. This implementation needs any fragment id to be stripped, i.e. loads only COMPLETE documents (which can be inadequate for very large text bodies!-)
The parser is in NON-validating mode, because no DTD/schema is accessible.

Specified by:

getDocument in interface DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

getRoot

public eu.bandm.tools.tpath.tdomclient.TdomClient.Node getRoot(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node)

Description copied from interface: DocumentClient

returns the owning Document. May be called with any node.

Specified by:

getRoot in interface DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

stringValue

public String stringValue(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node)

Description copied from interface: DocumentClient

Never returns null, but possibly empty String [XPath 1.0:5]. May be called with any node.

Specified by:

stringValue in interface DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

documentOrder

public Comparator<? super eu.bandm.tools.tpath.tdomclient.TdomClient.Node> documentOrder()

Specified by:

documentOrder in interface DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

attributeAxis

public NodeSet<eu.bandm.tools.tpath.tdomclient.TdomClient.Node> attributeAxis(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node)

Description copied from interface: DocumentClient

Returns a NodeSet with all attribute nodes. Is an empty set for all nodes which are not elements. May be called with any node.

Specified by:

attributeAxis in interface DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

childAxis

public NodeSet<eu.bandm.tools.tpath.tdomclient.TdomClient.Node> childAxis(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node,
                                                                          boolean reverse)

Description copied from interface: DocumentClient

Returns a NodeSet with all child elements. FIXME STIMMT DAS ALLES ??

Specified by:

childAxis in interface DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

childAxis

public NodeSet<eu.bandm.tools.tpath.tdomclient.TdomClient.Node> childAxis(eu.bandm.tools.tpath.tdomclient.TdomClient.Element el,
                                                                          boolean reverse)

followingSiblingAxis

public NodeSet<eu.bandm.tools.tpath.tdomclient.TdomClient.Node> followingSiblingAxis(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node)

Description copied from interface: DocumentClient

Returns a NodeSet with all following sibling elements. May be called with any node.

Specified by:

followingSiblingAxis in interface DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

getParent

public eu.bandm.tools.tpath.tdomclient.TdomClient.Node getParent(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node)

Description copied from interface: DocumentClient

returns the parent node; null for Document. May be called with any node.

Specified by:

getParent in interface DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

getPITarget

public String getPITarget(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node)

Description copied from interface: DocumentClient

returns the target identifier; may only be called with a PI-node!

Specified by:

getPITarget in interface DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

parentAxis

public NodeSet<eu.bandm.tools.tpath.tdomclient.TdomClient.Node> parentAxis(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node)

Description copied from interface: DocumentClient

Returns a NodeSet with the one direct parent. May be called with any node.

Specified by:

parentAxis in interface DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

precedingSiblingAxis

public NodeSet<eu.bandm.tools.tpath.tdomclient.TdomClient.Node> precedingSiblingAxis(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node)

Description copied from interface: DocumentClient

Returns a NodeSet with all preceding sibling elements. May be called with any node.

Specified by:

precedingSiblingAxis in interface DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

nameTest

public boolean nameTest(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node,
                        PrincipalNodeType pnt,
                        String uri,
                        String suffix)

uri and suffix may be ==null, which means "not tested". This is different from being the empty String.

Specified by:

nameTest in interface DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

commentTest

public boolean commentTest(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node)

Description copied from interface: DocumentClient

Returns whether a node is a comment. May be called with any node.

Specified by:

commentTest in interface DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

textTest

public boolean textTest(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node)

Description copied from interface: DocumentClient

Returns whether a node is PCDATA. May be called with any node.

Specified by:

textTest in interface DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

processingInstructionTest

public boolean processingInstructionTest(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node,
                                         String target)

Description copied from interface: DocumentClient

Returns whether a node is PI. target==null: returns true if node is any process instruction.
target!=null: returns true if node is a process instruction for this special target.
May be called with any node.

Specified by:

processingInstructionTest in interface DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>

getElementById

public eu.bandm.tools.tpath.tdomclient.TdomClient.Node getElementById(eu.bandm.tools.tpath.tdomclient.TdomClient.Node node,
                                                                      String id)

Description copied from interface: DocumentClient

retrieves an element (or null) by the text value of the ID-type attribute. Each Element may define 0 or 1 of this attribute.

Specified by:

getElementById in interface DocumentClient<eu.bandm.tools.tpath.tdomclient.TdomClient.Node>