2005/5/9

--
down ACDK
down API Docs
down Namespaces
down acdk
down acdk::xml
down acdk::xml::libxmldom
down LibXMLXPathResult
  down members
See also:
  down LibXMLXPathResult.cpp
  down LibXMLXPathResult.h

(c) 2005 by
Roger Rene Kommer

Kindly hosted at:
SourceForge.net Logo

     
 

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

acdk::xml::libxmldom::LibXMLXPathResult Class Reference

#include <LibXMLXPathResult.h>

Inheritance diagram for acdk::xml::libxmldom::LibXMLXPathResult:

acdk::lang::Object org::w3c::dom::xpath::XPathResult acdk::lang::ObjectBase acdk::lang::dmi::StdDispatch List of all members.

Public Member Functions

 LibXMLXPathResult (xmlXPathObjectPtr xpathPtr, xmlNodePtr docNode)
 ~LibXMLXPathResult ()
virtual short getResultType ()
 A code representing the type of this result, as defined by the type constants.

virtual double getNumberValue () throw ( org::w3c::dom::xpath::RXPathException )
 The value of this number result.

virtual RString getStringValue () throw ( org::w3c::dom::xpath::RXPathException )
 The value of this string result.

virtual bool getBooleanValue () throw ( org::w3c::dom::xpath::RXPathException )
 The value of this boolean result.

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

virtual bool getInvalidIteratorState ()
 returns always false

virtual int getSnapshotLength () throw ( org::w3c::dom::xpath::RXPathException )
 The number of nodes in the result snapshot.

virtual org::w3c::dom::RNode iterateNext () throw ( org::w3c::dom::xpath::RXPathException , org::w3c::dom::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) throw ( org::w3c::dom::xpath::RXPathException )
 Returns the indexth item in the snapshot collection.

acdk::lang::Object getObjectValue () throw ( org::w3c::dom::xpath::RXPathException )

Protected Attributes

XmlNodePtrHolder _nodePtr
xmlXPathObjectPtr _xpathPtr
int _curIdx

Constructor & Destructor Documentation

acdk::xml::libxmldom::LibXMLXPathResult::LibXMLXPathResult (  xmlXPathObjectPtr  xpathPtr,
xmlNodePtr  docNode
)  [inline]
 

acdk::xml::libxmldom::LibXMLXPathResult::~LibXMLXPathResult (   ) 
 

Member Function Documentation

virtual bool acdk::xml::libxmldom::LibXMLXPathResult::getBooleanValue (   )  throw ( org::w3c::dom::xpath::RXPathException ) [virtual]
 

The value of this boolean result.

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

Implements org::w3c::dom::xpath::XPathResult.

virtual bool acdk::xml::libxmldom::LibXMLXPathResult::getInvalidIteratorState (   )  [virtual]
 

returns always false

Implements org::w3c::dom::xpath::XPathResult.

virtual double acdk::xml::libxmldom::LibXMLXPathResult::getNumberValue (   )  throw ( org::w3c::dom::xpath::RXPathException ) [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.

Implements org::w3c::dom::xpath::XPathResult.

acdk::lang::Object acdk::xml::libxmldom::LibXMLXPathResult::getObjectValue (   )  throw ( org::w3c::dom::xpath::RXPathException )
 

virtual short acdk::xml::libxmldom::LibXMLXPathResult::getResultType (   )  [virtual]
 

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

Implements org::w3c::dom::xpath::XPathResult.

virtual org::w3c::dom::RNode acdk::xml::libxmldom::LibXMLXPathResult::getSingleNodeValue (   )  throw ( org::w3c::dom::xpath::RXPathException ) [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.

Implements org::w3c::dom::xpath::XPathResult.

virtual int acdk::xml::libxmldom::LibXMLXPathResult::getSnapshotLength (   )  throw ( org::w3c::dom::xpath::RXPathException ) [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.

Implements org::w3c::dom::xpath::XPathResult.

virtual RString acdk::xml::libxmldom::LibXMLXPathResult::getStringValue (   )  throw ( org::w3c::dom::xpath::RXPathException ) [virtual]
 

The value of this string result.

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

Implements org::w3c::dom::xpath::XPathResult.

virtual org::w3c::dom::RNode acdk::xml::libxmldom::LibXMLXPathResult::iterateNext (   )  throw ( org::w3c::dom::xpath::RXPathException , org::w3c::dom::RDOMException ) [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.

Implements org::w3c::dom::xpath::XPathResult.

virtual org::w3c::dom::RNode acdk::xml::libxmldom::LibXMLXPathResult::snapshotItem (  int  index  )  throw ( org::w3c::dom::xpath::RXPathException ) [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.

Implements org::w3c::dom::xpath::XPathResult.

Member Data Documentation

int acdk::xml::libxmldom::LibXMLXPathResult::_curIdx [protected]
 

XmlNodePtrHolder acdk::xml::libxmldom::LibXMLXPathResult::_nodePtr [protected]
 

xmlXPathObjectPtr acdk::xml::libxmldom::LibXMLXPathResult::_xpathPtr [protected]