API

com.ibm.xml.xapi
Interface XNodeView

All Known Subinterfaces:
XItemView, XSequenceCursor, XTreeCursor

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
static class XNodeView.Kind
          Enumeration of node kinds.
 
Method Summary
 Node getDOMNode()
          Get a DOM Node for this item.
 XNodeView.Kind getKind()
          Get the node kind.
 QName getNodeQName()
          Get the qualified node name.
 XTreeCursor getTreeCursor()
          Get a tree cursor for this item.
 boolean isSameDocument(XItemView item)
          Indicates if the specified node and this node are in the same document.
 int 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.

Returns:
An enumerator indicating the node kind.
Throws:
XViewException - if this item is atomic.

getNodeQName

QName getNodeQName()
Get the qualified node name.

Returns:
The node name as a QName object.
Throws:
XViewException - if this item is atomic.

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:
isSameDocument(XItemView)

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:
XTreeCursor

getDOMNode

Node getDOMNode()
Get a DOM Node for this item.

Returns:
A DOM Node object for this node.
Throws:
XViewException - if this item is atomic.

IBM Copyright 2004-2008