2005/5/9

--
down ACDK
down API Docs
down Namespaces
down org
down org::w3c
down org::w3c::dom
down org::w3c::dom::xpath
down XPathResult
  down members
See also:
  down XPathResult.h

(c) 2005 by
Roger Rene Kommer

Kindly hosted at:
SourceForge.net Logo

     
 

class XPathResult
artefaktur
Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   Namespace Members   Compound Members   Related Pages  

org::w3c::dom::xpath::XPathResult Class Reference

#include <XPathResult.h>

Inheritance diagram for org::w3c::dom::xpath::XPathResult:

acdk::xml::libxmldom::LibXMLXPathResult List of all members.

Public Member Functions

virtual short getResultType ()=0
 A code representing the type of this result, as defined by the type constants.

virtual double getNumberValue ()=0 throw ( RXPathException )
 The value of this number result.

virtual RString getStringValue ()=0 throw ( RXPathException )
 The value of this string result.

virtual bool getBooleanValue ()=0 throw ( RXPathException )
 The value of this boolean result.

virtual org::w3c::dom::RNode getSingleNodeValue ()=0 throw ( RXPathException )
 The value of this single node result, which may be null.

virtual bool getInvalidIteratorState ()=0
 Signifies that the iterator has become invalid.

virtual int getSnapshotLength ()=0 throw ( RXPathException )
 The number of nodes in the result snapshot.

virtual org::w3c::dom::RNode iterateNext ()=0 throw ( RXPathException , RDOMException )
 Iterates and returns the next node from the node set or nullif there are no more nodes.

virtual org::w3c::dom::RNode snapshotItem (int index)=0 throw ( RXPathException )
 Returns the indexth item in the snapshot collection.

virtual org::w3c::dom::RNodeList getSnapshotNodeList ()
 Extended API, that return a node list for given snapshot.

acdk::util::RIterator iterator ()
 extended API return a NodeListIterator of the getSnapshotNodeList

Member Function Documentation

virtual bool org::w3c::dom::xpath::XPathResult::getBooleanValue (   )  throw ( RXPathException ) [pure virtual]
 

The value of this boolean result.

Exceptions:
XPathException TYPE_ERR: raised if resultType is not BOOLEAN_TYPE.

Implemented in acdk::xml::libxmldom::LibXMLXPathResult.

virtual bool org::w3c::dom::xpath::XPathResult::getInvalidIteratorState (   )  [pure virtual]
 

Signifies that the iterator has become invalid.

True if resultType is UNORDERED_NODE_ITERATOR_TYPE or ORDERED_NODE_ITERATOR_TYPE and the document has been modified since this result was returned.

Implemented in acdk::xml::libxmldom::LibXMLXPathResult.

virtual double org::w3c::dom::xpath::XPathResult::getNumberValue (   )  throw ( RXPathException ) [pure virtual]
 

The value of this number result.

If the native double type of the DOM binding does not directly support the exact IEEE 754 result of the XPath expression, then it is up to the definition of the binding to specify how the XPath number is converted to the native binding number.

Exceptions:
XPathException TYPE_ERR: raised if resultType is not NUMBER_TYPE.

Implemented in acdk::xml::libxmldom::LibXMLXPathResult.

virtual short org::w3c::dom::xpath::XPathResult::getResultType (   )  [pure virtual]
 

A code representing the type of this result, as defined by the type constants.

Implemented in acdk::xml::libxmldom::LibXMLXPathResult.

virtual org::w3c::dom::RNode org::w3c::dom::xpath::XPathResult::getSingleNodeValue (   )  throw ( RXPathException ) [pure virtual]
 

The value of this single node result, which may be null.

Exceptions:
XPathException TYPE_ERR: raised if resultType is not ANY_UNORDERED_NODE_TYPE or FIRST_ORDERED_NODE_TYPE.

Implemented in acdk::xml::libxmldom::LibXMLXPathResult.

virtual int org::w3c::dom::xpath::XPathResult::getSnapshotLength (   )  throw ( RXPathException ) [pure virtual]
 

The number of nodes in the result snapshot.

Valid values for snapshotItem indices are 0 to snapshotLength-1 inclusive.

Exceptions:
XPathException TYPE_ERR: raised if resultType is not UNORDERED_NODE_SNAPSHOT_TYPE or ORDERED_NODE_SNAPSHOT_TYPE.

Implemented in acdk::xml::libxmldom::LibXMLXPathResult.

org::w3c::dom::RNodeList org::w3c::dom::xpath::XPathResult::getSnapshotNodeList (   )  [inline, virtual]
 

Extended API, that return a node list for given snapshot.

virtual RString org::w3c::dom::xpath::XPathResult::getStringValue (   )  throw ( RXPathException ) [pure virtual]
 

The value of this string result.

Exceptions:
XPathException TYPE_ERR: raised if resultType is not STRING_TYPE.

Implemented in acdk::xml::libxmldom::LibXMLXPathResult.

virtual org::w3c::dom::RNode org::w3c::dom::xpath::XPathResult::iterateNext (   )  throw ( RXPathException , RDOMException ) [pure virtual]
 

Iterates and returns the next node from the node set or nullif there are no more nodes.

Returns:
Returns the next node.
Exceptions:
XPathException TYPE_ERR: raised if resultType is not UNORDERED_NODE_ITERATOR_TYPE or ORDERED_NODE_ITERATOR_TYPE.
DOMException INVALID_STATE_ERR: The document has been mutated since the result was returned.

Implemented in acdk::xml::libxmldom::LibXMLXPathResult.

acdk::util::RIterator org::w3c::dom::xpath::XPathResult::iterator (   )  [inline]
 

extended API return a NodeListIterator of the getSnapshotNodeList

virtual org::w3c::dom::RNode org::w3c::dom::xpath::XPathResult::snapshotItem (  int  index  )  throw ( RXPathException ) [pure virtual]
 

Returns the indexth item in the snapshot collection.

If index is greater than or equal to the number of nodes in the list, this method returns null. Unlike the iterator result, the snapshot does not become invalid, but may not correspond to the current document if it is mutated.

Parameters:
index Index into the snapshot collection.
Returns:
The node at the indexth position in the NodeList, or null if that is not a valid index.
Exceptions:
XPathException TYPE_ERR: raised if resultType is not UNORDERED_NODE_SNAPSHOT_TYPE or ORDERED_NODE_SNAPSHOT_TYPE.

Implemented in acdk::xml::libxmldom::LibXMLXPathResult.