112 lines
4.7 KiB
C++
112 lines
4.7 KiB
C++
/*
|
|
* Copyright (c) 2001-2006
|
|
* DecisionSoft Limited. All rights reserved.
|
|
* Copyright (c) 2004-2006
|
|
* Progress Software Corporation. All rights reserved.
|
|
* Copyright (c) 2004-2006
|
|
* Oracle. All rights reserved.
|
|
*
|
|
* See the file LICENSE for redistribution information.
|
|
*
|
|
* $Id: XQillaExpression.hpp,v 1.6 2006/11/01 16:37:12 jpcs Exp $
|
|
*/
|
|
|
|
#ifndef __XQILLAEXPRESSION_HPP
|
|
#define __XQILLAEXPRESSION_HPP
|
|
|
|
#include <xqilla/framework/XQillaExport.hpp>
|
|
|
|
#include <xqilla/dom-api/XPath2Result.hpp>
|
|
#include <xqilla/runtime/Sequence.hpp>
|
|
#include <xercesc/dom/DOMException.hpp>
|
|
#include <xercesc/dom/DOMNode.hpp>
|
|
#include <xercesc/dom/DOMXPathExpression.hpp>
|
|
#include <xercesc/dom/DOMXPathException.hpp>
|
|
|
|
|
|
class DynamicContext;
|
|
|
|
/**
|
|
* The <code>XQillaExpression</code> interface extends the <code>DOMXPathExpression</code> interface,
|
|
* providing the ability to release the object. The evaluate method will always return an object of type
|
|
* <code>XPath2Result</code>
|
|
* @since DOM Level 3
|
|
*/
|
|
class XQILLA_API XQillaExpression: public XERCES_CPP_NAMESPACE_QUALIFIER DOMXPathExpression
|
|
{
|
|
public:
|
|
// -----------------------------------------------------------------------
|
|
// All constructors are hidden, just the destructor is available
|
|
// -----------------------------------------------------------------------
|
|
/** @name Destructor */
|
|
//@{
|
|
/**
|
|
* Destructor
|
|
*
|
|
*/
|
|
virtual ~XQillaExpression() {}
|
|
//@}
|
|
|
|
// -----------------------------------------------------------------------
|
|
// Virtual XQillaExpression interface
|
|
// -----------------------------------------------------------------------
|
|
/**
|
|
* Evaluates this XPath expression and returns a result.
|
|
* @param contextNode of type <code>DOMNode</code> The context is context
|
|
* node for the evaluation of this XPath expression.
|
|
* If the XPathEvaluator was obtained by casting the Document then this must
|
|
* be owned by the same document and must be a <code>DOMDocument</code>, <code>DOMElement</code>,
|
|
* <code>DOMAttribute</code>, <code>DOMText</code>, <code>DOMCDATASection</code>,
|
|
* <code>DOMComment</code>, <code>DOMProcessingInstruction</code>, or
|
|
* <code>XPathNamespace</code>. If the context node is a <code>DOMText</code> or a
|
|
* <code>DOMCDATASection</code>, then the context is interpreted as the whole logical
|
|
* text node as seen by XPath, unless the node is empty in which case it may not
|
|
* serve as the XPath context.
|
|
* @param type of type unsigned short If a specific type is specified, then the result
|
|
* will be coerced to return the specified type relying on XPath conversions and fail
|
|
* if the desired coercion is not possible. This must be one of the type codes of <code>XPathResult</code>.
|
|
* @param result of type void* The result specifies a specific result object which
|
|
* may be reused and returned by this method. If this is specified as nullor the
|
|
* implementation does not reuse the specified result, a new result object will be constructed
|
|
* and returned.
|
|
* For XPath 1.0 results, this object will be of type <code>XPathResult</code>.
|
|
* For XPath 2.0 results, this object will be of type <code>XPath2Result</code>.
|
|
* @return void* The result of the evaluation of the XPath expression.
|
|
* For XPath 1.0 results, this object will be of type <code>XPathResult</code>.
|
|
* For XPath 2.0 results, this object will be of type <code>XPath2Result</code>.
|
|
* @exception XPathException
|
|
* TYPE_ERR: Raised if the result cannot be converted to return the specified type.
|
|
* @exception DOMException
|
|
* WRONG_DOCUMENT_ERR: The <code>DOMNode</code> is from a document that is not supported by
|
|
* the <code>XPathEvaluator</code> that created this <code>DOMXPathExpression</code>.
|
|
* NOT_SUPPORTED_ERR: The Node is not a type permitted as an XPath context node or the
|
|
* request type is not permitted by this <code>DOMXPathExpression</code>.
|
|
*/
|
|
virtual void* evaluate(XERCES_CPP_NAMESPACE_QUALIFIER DOMNode* contextNode,
|
|
unsigned short type,
|
|
void* reuseableResult) const = 0;
|
|
|
|
//@}
|
|
/** @name Non-standard Extension */
|
|
//@{
|
|
/**
|
|
* Called to indicate that this object (and its associated children) is no longer in use
|
|
* and that the implementation may relinquish any resources associated with it and
|
|
* its associated children.
|
|
*
|
|
* Access to a released object will lead to unexpected result.
|
|
*/
|
|
virtual void release() = 0;
|
|
//@}
|
|
protected:
|
|
// -----------------------------------------------------------------------
|
|
// Hidden constructors
|
|
// -----------------------------------------------------------------------
|
|
/** @name Hidden constructors */
|
|
//@{
|
|
XQillaExpression() {};
|
|
//@}
|
|
};//XQillaExpression
|
|
|
|
#endif //__XQILLAEXPRESSION_HPP
|
|
|