Package 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<TdomClient.Node>

public class TdomClient<E extends TypedElement<E,X>,X extends TypedExtension>
extends Object
implements DocumentClient<TdomClient.Node>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	TdomClient.Attribute
(package private) class	TdomClient.Comment
(package private) class	TdomClient.Element
(package private) class	TdomClient.Node<N extends TypedNode>
(package private) class	TdomClient.Pcdata
(package private) class	TdomClient.ProcessingInstruction

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final int	ATTR
(package private) final int	COMMENT
(package private) Map<URI,TdomClient.Node>	documentCache
(package private) final int	ELEMENT
protected final NodeSet<TdomClient.Node>	emptyNodeSet
protected final NodeSet<TdomClient.Node>	emptyNodeSetReverse
(package private) Map<TypedDocument,ElementDictionary<?,?>>	maps
protected MessageReceiver<? super SimpleMessage<XMLDocumentIdentifier>>	msg
(package private) final int	PCDATA
(package private) final int	PI

Constructor Summary

Constructors

Constructor	Description
TdomClient()

Method Summary

Modifier and Type	Method	Description
NodeSet<TdomClient.Node>	attributeAxis(TdomClient.Node node)	Returns a NodeSet with all attribute nodes.
NodeSet<TdomClient.Node>	childAxis(TdomClient.Node node, boolean reverse)	Returns a NodeSet with all child elements.
NodeSet<TdomClient.Node>	childAxis(TdomClient<E,X>.Element el, boolean reverse)
boolean	commentTest(TdomClient.Node node)	Returns whether a node is a comment.
Comparator<? super TdomClient.Node>	documentOrder()
NodeSet<TdomClient.Node>	followingSiblingAxis(TdomClient.Node node)	Returns a NodeSet with all following sibling elements.
URI	getBaseURI(TdomClient.Node node)	Returns null iff not possible to find out.
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.
TdomClient.Node	getElementById(TdomClient.Node node, String id)	retrieves an element (or null) by the text value of the ID-type attribute.
String	getLocalName(TdomClient.Node node)	Returns null iff node is neither Element nor Attribute; otherwise the local name.
NamespaceName	getNamespaceName(TdomClient.Node node)	Returns null iff node is neither Element nor Attribute; otherwise the NamespaceName.
String	getNamespaceURI(TdomClient.Node node)	Returns null iff node is neither Element nor Attribute; otherwise the URI the namespace prefix is bound to.
TdomClient.Node	getParent(TdomClient.Node node)	returns the parent node; null for Document.
String	getPITarget(TdomClient.Node node)	returns the target identifier; may only be called with a PI-node!
TdomClient.Node	getRoot(TdomClient.Node node)	returns the owning Document.
(package private) TdomClient.Node	makeNode(TypedNode orig, TdomClient<E,X>.Element parent, int index)
boolean	nameTest(TdomClient.Node node, PrincipalNodeType pnt, String uri, String suffix)	uri and suffix may be ==null, which means "not tested".
NodeSet<TdomClient.Node>	parentAxis(TdomClient.Node node)	Returns a NodeSet with the one direct parent.
NodeSet<TdomClient.Node>	precedingSiblingAxis(TdomClient.Node node)	Returns a NodeSet with all preceding sibling elements.
boolean	processingInstructionTest(TdomClient.Node node, String target)	Returns whether a node is PI.
void	setMessageReceiver(MessageReceiver<? super SimpleMessage<XMLDocumentIdentifier>> msg)
String	stringValue(TdomClient.Node node)	Never returns null, but possibly empty String [XPath 1.0:5].
boolean	textTest(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 Details

msg

protected MessageReceiver<? super SimpleMessage<XMLDocumentIdentifier>> msg

ELEMENT

final int ELEMENT

See Also:

• Constant Field Values

ATTR

final int ATTR

See Also:

• Constant Field Values

PCDATA

final int PCDATA

See Also:

• Constant Field Values

COMMENT

final int COMMENT

See Also:

• Constant Field Values

PI

final int PI

See Also:

• Constant Field Values

emptyNodeSet

protected final NodeSet<TdomClient.Node> emptyNodeSet

emptyNodeSetReverse

protected final NodeSet<TdomClient.Node> emptyNodeSetReverse

documentCache

Map<URI,TdomClient.Node> documentCache

maps

Map<TypedDocument,ElementDictionary<?,?>> maps

Constructor Details

TdomClient

public TdomClient()

Method Details

setMessageReceiver

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

makeNode

TdomClient.Node makeNode(TypedNode orig,
 TdomClient<E,X>.Element parent,
 int index)

getLocalName

public String getLocalName(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<E extends TypedElement<E,X>>

getNamespaceURI

public String getNamespaceURI(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<E extends TypedElement<E,X>>

getNamespaceName

public NamespaceName getNamespaceName(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<E extends TypedElement<E,X>>

getBaseURI

public URI getBaseURI(TdomClient.Node node)

Returns null iff not possible to find out.

Specified by:

getBaseURI in interface DocumentClient<E extends TypedElement<E,X>>

getDocument

public 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<E extends TypedElement<E,X>>

getRoot

public TdomClient.Node getRoot(TdomClient.Node node)

Description copied from interface: DocumentClient

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

Specified by:

getRoot in interface DocumentClient<E extends TypedElement<E,X>>

stringValue

public String stringValue(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<E extends TypedElement<E,X>>

documentOrder

public Comparator<? super TdomClient.Node> documentOrder()

Specified by:

documentOrder in interface DocumentClient<E extends TypedElement<E,X>>

attributeAxis

public NodeSet<TdomClient.Node> attributeAxis(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<E extends TypedElement<E,X>>

childAxis

public NodeSet<TdomClient.Node> childAxis(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<E extends TypedElement<E,X>>

childAxis

public NodeSet<TdomClient.Node> childAxis(TdomClient<E,X>.Element el,
 boolean reverse)

followingSiblingAxis

public NodeSet<TdomClient.Node> followingSiblingAxis(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<E extends TypedElement<E,X>>

getParent

public TdomClient.Node getParent(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<E extends TypedElement<E,X>>

getPITarget

public String getPITarget(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<E extends TypedElement<E,X>>

parentAxis

public NodeSet<TdomClient.Node> parentAxis(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<E extends TypedElement<E,X>>

precedingSiblingAxis

public NodeSet<TdomClient.Node> precedingSiblingAxis(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<E extends TypedElement<E,X>>

nameTest

public boolean nameTest(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<E extends TypedElement<E,X>>

commentTest

public boolean commentTest(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<E extends TypedElement<E,X>>

textTest

public boolean textTest(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<E extends TypedElement<E,X>>

processingInstructionTest

public boolean processingInstructionTest(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<E extends TypedElement<E,X>>

getElementById

public TdomClient.Node getElementById(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<E extends TypedElement<E,X>>