com.ibm.xml.xapi
Interface XNodeView
All known subinterfaces:
- public interface XNodeView
Represents a node in the data model (an item with complex type).
An object of type XNodeView
should never occur, rather XItemView
extends XNodeView
so that items of complex type can
be examined as nodes. The isAtomic
method should be
called on an XItemView
object before any of the XNodeView
methods are called as they are not valid for atomic items. If a
XNodeView
method is invoked on an atomic item, an
XViewException
will be thrown.
Nested Class Summary
Modifier and Type | Interface and Description |
---|---|
|
XNodeView.Kind
Enumeration of node kinds.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getDOMNode()
Get a DOM Node for this item.
|
getKind()
Get the node kind.
|
|
|
getNodeQName()
Get the qualified node name.
|
getTreeCursor()
Get a tree cursor for this item.
|
|
|
isSameDocument(XItemView item)
Indicates if the specified node and this node are in the same document.
|
|
relativePosition(XItemView item)
Returns -1, 0, or 1 to indicate if this node is before, the same
or after the specified node.
|
Method Detail
getKind
- XNodeView.Kind getKind()
Get the node kind.
getNodeQName
- javax.xml.namespace.QName getNodeQName( )
Get the qualified node name.
isSameDocument
- boolean isSameDocument(XItemView item)
Indicates if the specified node and this node are in the same document.
Returns:
Returns
true
if the specified item is a node in
the same document as this node, false
otherwise Throws:
XViewException
- if either this item or the specified item
is atomic. relativePosition
- int relativePosition(XItemView item)
Returns -1, 0, or 1 to indicate if this node is before, the same
or after the specified node. Nodes must be in the same document.
Use
isSameDocument
to ensure the nodes are in the
same document before calling this method.
Returns:
-1, 0 or 1
Throws:
XViewException
- if either this item or the specified item
is atomic or if the nodes are not in the same document. See Also:
getTreeCursor
- XTreeCursor getTreeCursor()
Get a tree cursor for this item.
Returns:
An
XTreeCursor
object for this node. Throws:
XViewException
- if this item is atomic. See Also:
getDOMNode
- org.w3c.dom.Node getDOMNode()
Get a DOM Node for this item.