DOMXPathResult.hpp
Go to the documentation of this file.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* $Id$
*/
#if !defined(XERCESC_INCLUDE_GUARD_DOMXPATHRESULT_HPP)
#define XERCESC_INCLUDE_GUARD_DOMXPATHRESULT_HPP
#include <xercesc/util/XercesDefs.hpp>
XERCES_CPP_NAMESPACE_BEGIN
class DOMXPathNSResolver;
class DOMXPathExpression;
class DOMTypeInfo;
class DOMNode;
class CDOM_EXPORT DOMXPathResult
{
protected:
// -----------------------------------------------------------------------
// Hidden constructors
// -----------------------------------------------------------------------
DOMXPathResult() {};
private:
// -----------------------------------------------------------------------
// Unimplemented constructors and operators
// -----------------------------------------------------------------------
DOMXPathResult(const DOMXPathResult &);
DOMXPathResult& operator = (const DOMXPathResult&);
public:
// -----------------------------------------------------------------------
// All constructors are hidden, just the destructor is available
// -----------------------------------------------------------------------
virtual ~DOMXPathResult() {};
// -----------------------------------------------------------------------
// Class Types
// -----------------------------------------------------------------------
enum ResultType {
/* XPath 1.0 */
ANY_TYPE = 0,
NUMBER_TYPE = 1,
STRING_TYPE = 2,
BOOLEAN_TYPE = 3,
UNORDERED_NODE_ITERATOR_TYPE = 4,
ORDERED_NODE_ITERATOR_TYPE = 5,
UNORDERED_NODE_SNAPSHOT_TYPE = 6,
ORDERED_NODE_SNAPSHOT_TYPE = 7,
ANY_UNORDERED_NODE_TYPE = 8,
FIRST_ORDERED_NODE_TYPE = 9,
/* XPath 2.0 */
FIRST_RESULT_TYPE = 100,
ITERATOR_RESULT_TYPE = 101,
SNAPSHOT_RESULT_TYPE = 102
};
// -----------------------------------------------------------------------
// Virtual DOMXPathResult interface
// -----------------------------------------------------------------------
virtual ResultType getResultType() const = 0;
virtual const DOMTypeInfo *getTypeInfo() const = 0;
virtual bool isNode() const = 0;
virtual bool getBooleanValue() const = 0;
virtual int getIntegerValue() const = 0;
virtual double getNumberValue() const = 0;
virtual const XMLCh* getStringValue() const = 0;
virtual DOMNode* getNodeValue() const = 0;
virtual bool iterateNext() = 0;
virtual bool getInvalidIteratorState() const = 0;
virtual bool snapshotItem(XMLSize_t index) = 0;
virtual XMLSize_t getSnapshotLength() const = 0;
// -----------------------------------------------------------------------
// Non-standard Extension
// -----------------------------------------------------------------------
virtual void release() = 0;
};
XERCES_CPP_NAMESPACE_END
#endif
XercesDefs.hpp
CDOM_EXPORT
#define CDOM_EXPORT
Definition XercesDefs.hpp:166
XERCES_CPP_NAMESPACE_BEGIN
#define XERCES_CPP_NAMESPACE_BEGIN
Definition XercesDefs.hpp:112
XERCES_CPP_NAMESPACE_END
#define XERCES_CPP_NAMESPACE_END
Definition XercesDefs.hpp:113
XMLSize_t
size_t XMLSize_t
Definition Xerces_autoconf_config.hpp:112
XMLCh
char16_t XMLCh
Definition Xerces_autoconf_config.hpp:120
DOMNode
The DOMNode interface is the primary datatype for the entire Document Object Model.
Definition DOMNode.hpp:139
DOMTypeInfo
The DOMTypeInfo interface represent a type used by DOMElement or DOMAttr nodes, specified in the sche...
Definition DOMTypeInfo.hpp:36
DOMXPathExpression
The DOMXPathExpression interface represents a parsed and resolved XPath expression.
Definition DOMXPathExpression.hpp:37
DOMXPathNSResolver
The DOMXPathNSResolver interface permit prefix strings in the expression to be properly bound to name...
Definition DOMXPathNSResolver.hpp:37
DOMXPathResult
The DOMXPathResult interface represents the result of the evaluation of an XPath 1....
Definition DOMXPathResult.hpp:47
DOMXPathResult::getTypeInfo
virtual const DOMTypeInfo * getTypeInfo() const =0
Returns the DOM type info of the current result node or value (XPath 2 only).
DOMXPathResult::getNumberValue
virtual double getNumberValue() const =0
Returns the number value of this result.
DOMXPathResult::getSnapshotLength
virtual XMLSize_t getSnapshotLength() const =0
The number of items in the result snapshot.
DOMXPathResult::getStringValue
virtual const XMLCh * getStringValue() const =0
Returns the string value of this result.
DOMXPathResult::release
virtual void release()=0
Called to indicate that this DOMXPathResult is no longer in use and that the implementation may relin...
DOMXPathResult::getInvalidIteratorState
virtual bool getInvalidIteratorState() const =0
Signifies that the iterator has become invalid.
DOMXPathResult::iterateNext
virtual bool iterateNext()=0
Iterates and returns true if the current result is the next item from the sequence or false if there ...
DOMXPathResult::getResultType
virtual ResultType getResultType() const =0
Returns the result type of this result.
DOMXPathResult::getNodeValue
virtual DOMNode * getNodeValue() const =0
Returns the node value of this result.
DOMXPathResult::DOMXPathResult
DOMXPathResult()
Definition DOMXPathResult.hpp:55
DOMXPathResult::ResultType
ResultType
Definition DOMXPathResult.hpp:163
DOMXPathResult::isNode
virtual bool isNode() const =0
Returns true if the result has a current result and the value is a node (XPath 2 only).
DOMXPathResult::getBooleanValue
virtual bool getBooleanValue() const =0
Returns the boolean value of this result.
DOMXPathResult::~DOMXPathResult
virtual ~DOMXPathResult()
Destructor.
Definition DOMXPathResult.hpp:78
DOMXPathResult::snapshotItem
virtual bool snapshotItem(XMLSize_t index)=0
Sets the current result to the indexth item in the snapshot collection.
DOMXPathResult::getIntegerValue
virtual int getIntegerValue() const =0
Returns the integer value of this result (XPath 2 only).