Package eu.bandm.tools.d2d2.base

Class UdomClient

java.lang.Object

eu.bandm.tools.d2d2.base.UdomClient

All Implemented Interfaces:

DocumentClient<UdomClient.Node<?>>

public class UdomClient
extends Object
implements DocumentClient<UdomClient.Node<?>>

Adapter to use bandm xpath (and thus txsl) with internal d2d udom objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	UdomClient.Attribute
(package private) class	UdomClient.Element
(package private) class	UdomClient.Node<O extends Udom>
(package private) class	UdomClient.Pcdata

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final int	ATTR
(package private) static final int	ELEMENT
protected final NodeSet<UdomClient.Node<?>>	emptyNodeSet
protected final NodeSet<UdomClient.Node<?>>	emptyNodeSetReverse
(package private) static final int	PCDATA

Constructor Summary

Constructors

Constructor	Description
UdomClient()

Method Summary

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

ELEMENT

static final int ELEMENT

See Also:

• Constant Field Values

ATTR

static final int ATTR

See Also:

• Constant Field Values

PCDATA

static final int PCDATA

See Also:

• Constant Field Values

emptyNodeSet

protected final NodeSet<UdomClient.Node<?>> emptyNodeSet

emptyNodeSetReverse

protected final NodeSet<UdomClient.Node<?>> emptyNodeSetReverse

Constructor Details

UdomClient

public UdomClient()

Method Details

getLocalName

@Opt
public String getLocalName(UdomClient.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<UdomClient.Node<?>>

getNamespaceURI

@Opt
public String getNamespaceURI(UdomClient.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<UdomClient.Node<?>>

getNamespaceName

@Opt
public @Opt NamespaceName getNamespaceName(UdomClient.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<UdomClient.Node<?>>

getBaseURI

@Opt
public URI getBaseURI(UdomClient.Node<?> node)

Returns null iff not possible to find out. This implementation does NOT work for character nodes, but for attributes and elements.

Specified by:

getBaseURI in interface DocumentClient<UdomClient.Node<?>>

getDocument

@Opt
public @Opt UdomClient.Node<?> getDocument(URI uri)

Description copied from interface: DocumentClient

Reads a document from the given address and converts it into a (Document-)node.

Specified by:

getDocument in interface DocumentClient<UdomClient.Node<?>>

getRoot

public UdomClient.Node<?> getRoot(UdomClient.Node<?> node)

Description copied from interface: DocumentClient

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

Specified by:

getRoot in interface DocumentClient<UdomClient.Node<?>>

stringValue

public String stringValue(UdomClient.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<UdomClient.Node<?>>

svCollect

protected void svCollect(StringBuilder sb,
 Udom orig)

documentOrder

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

Specified by:

documentOrder in interface DocumentClient<UdomClient.Node<?>>

attributeAxis

public NodeSet<UdomClient.Node<?>> attributeAxis(UdomClient.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<UdomClient.Node<?>>

childAxis

public NodeSet<UdomClient.Node<?>> childAxis(UdomClient.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<UdomClient.Node<?>>

childAxis

public NodeSet<UdomClient.Node<?>> childAxis(UdomClient.Element el,
 boolean reverse)

followingSiblingAxis

public NodeSet<UdomClient.Node<?>> followingSiblingAxis(UdomClient.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<UdomClient.Node<?>>

getParent

public UdomClient.Node<?> getParent(UdomClient.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<UdomClient.Node<?>>

getPITarget

public String getPITarget(UdomClient.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<UdomClient.Node<?>>

parentAxis

public NodeSet<UdomClient.Node<?>> parentAxis(UdomClient.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<UdomClient.Node<?>>

precedingSiblingAxis

public NodeSet<UdomClient.Node<?>> precedingSiblingAxis(UdomClient.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<UdomClient.Node<?>>

nameTest

public boolean nameTest(UdomClient.Node<?> node,
 PrincipalNodeType pnt,
 @Opt
 String uri,
 @Opt
 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<UdomClient.Node<?>>

commentTest

public boolean commentTest(UdomClient.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<UdomClient.Node<?>>

textTest

public boolean textTest(UdomClient.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<UdomClient.Node<?>>

processingInstructionTest

public boolean processingInstructionTest(UdomClient.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<UdomClient.Node<?>>

getElementById

@Opt
public @Opt UdomClient.Node<?> getElementById(UdomClient.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<UdomClient.Node<?>>