DOMClient (BandM metatools API doc)

java.lang.Object
- eu.bandm.tools.tpath.dom.DOMClient

All Implemented Interfaces:: DocumentClient<Node>

public class DOMClient
extends Object
implements DocumentClient<Node>

Field Summary

Fields
Modifier and Type	Field and Description
`protected NodeSet<Node>`	`emptyNodeSet`
`protected NodeSet<Node>`	`emptyNodeSetReverse`
`protected DocTypes`	`metatools_doc_sources`
`protected MessageReceiver<? super SimpleMessage<XMLDocumentIdentifier>>`	`msg`

Constructor Summary

Constructors
Constructor and Description

DOMClient()

Constructors
Constructor and Description
`DOMClient()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NodeSet<Node>`	`attributeAxis(Node node)` Returns a NodeSet with all attribute nodes.
`NodeSet<Node>`	`childAxis(Node node, boolean reverse)` Returns a NodeSet with all child elements.
`boolean`	`commentTest(Node node)` Returns whether a node is a comment.
`Comparator<? super Node>`	`documentOrder()`
`NodeSet<Node>`	`followingSiblingAxis(Node node)` Returns a NodeSet with all following sibling elements.
`URI`	`getBaseURI(Node node)` Returns null iff not possible to find out.
`Node`	`getDocument(URI uri)` The xpath core library "document()" function has complicated signatures, but finally breaks down to load a document from an URI.
`Node`	`getElementById(Node document, String id)` retrieves an element (or null) by the text value of the ID-type attribute.
`String`	`getLocalName(Node node)` Returns null iff node is neither Element nor Attribute; otherwise the local name.
`NamespaceName`	`getNamespaceName(Node node)` Returns null iff node is neither Element nor Attribute; otherwise the NamespaceName.
`String`	`getNamespaceURI(Node node)` Returns null iff node is neither Element nor Attribute; otherwise the URI the namespace prefix is bound to.
`Node`	`getParent(Node node)` returns the parent node; null for Document.
`String`	`getPITarget(Node node)` returns the target identifier; may only be called with a PI-node!
`Document`	`getRoot(Node node)` returns the owning Document.
`boolean`	`nameTest(Node node, PrincipalNodeType pnt, String uri, String suffix)` uri and suffix may be ==null, which means "not tested".
`NodeSet<Node>`	`parentAxis(Node node)` Returns a NodeSet with the one direct parent.
`NodeSet<Node>`	`precedingSiblingAxis(Node node)` Returns a NodeSet with all preceding sibling elements.
`boolean`	`processingInstructionTest(Node node, String target)` Returns whether a node is PI.
`void`	`setMessageReceiver(MessageReceiver<? super SimpleMessage<XMLDocumentIdentifier>> msg)`
`String`	`stringValue(Node node)` Never returns null, but possibly empty String [XPath 1.0:5].
`void`	`stringValue(StringBuilder buf, Element elem)`
`boolean`	`textTest(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<Node> emptyNodeSet
```
  - emptyNodeSetReverse
```
protected final NodeSet<Node> emptyNodeSetReverse
```
  - metatools_doc_sources
```
protected final DocTypes metatools_doc_sources
```
- Constructor Detail
  - DOMClient
```
public DOMClient()
```
- Method Detail
  - setMessageReceiver
```
public void setMessageReceiver(MessageReceiver<? super SimpleMessage<XMLDocumentIdentifier>> msg)
```
  - getLocalName
```
public String getLocalName(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<Node>
  - getNamespaceURI
```
public String getNamespaceURI(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<Node>
  - getNamespaceName
```
public NamespaceName getNamespaceName(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<Node>
  - getBaseURI
```
public URI getBaseURI(Node node)
```
    Returns null iff not possible to find out.
    
    Specified by:
    
    getBaseURI in interface DocumentClient<Node>
  - getDocument
```
public 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<Node>
  - getRoot
```
public Document getRoot(Node node)
```
    Description copied from interface: DocumentClient
    
    returns the owning Document. May be called with any node.
    
    Specified by:
    
    getRoot in interface DocumentClient<Node>
  - getPITarget
```
public String getPITarget(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<Node>
  - stringValue
```
public String stringValue(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<Node>
  - stringValue
```
public void stringValue(StringBuilder buf,
                        Element elem)
```
  - documentOrder
```
public Comparator<? super Node> documentOrder()
```
    Specified by:
    
    documentOrder in interface DocumentClient<Node>
  - attributeAxis
```
public NodeSet<Node> attributeAxis(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<Node>
  - childAxis
```
public NodeSet<Node> childAxis(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<Node>
  - followingSiblingAxis
```
public NodeSet<Node> followingSiblingAxis(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<Node>
  - getParent
```
public Node getParent(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<Node>
  - parentAxis
```
public NodeSet<Node> parentAxis(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<Node>
  - precedingSiblingAxis
```
public NodeSet<Node> precedingSiblingAxis(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<Node>
  - nameTest
```
public boolean nameTest(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<Node>
  - commentTest
```
public boolean commentTest(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<Node>
  - textTest
```
public boolean textTest(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<Node>
  - processingInstructionTest
```
public boolean processingInstructionTest(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<Node>
  - getElementById
```
public Node getElementById(Node document,
                           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<Node>

Class DOMClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

msg

emptyNodeSet

emptyNodeSetReverse

metatools_doc_sources

Constructor Detail

DOMClient

Method Detail

setMessageReceiver

getLocalName

getNamespaceURI

getNamespaceName

getBaseURI

getDocument

getRoot

getPITarget

stringValue

stringValue

documentOrder

attributeAxis

childAxis

followingSiblingAxis

getParent

parentAxis

precedingSiblingAxis

nameTest

commentTest

textTest

processingInstructionTest

getElementById