XQuilla/include/xqilla/dom-api/XQillaNSResolver.hpp
2020-02-17 22:12:51 +01:00

104 lines
3.5 KiB
C++

/*
* Copyright (c) 2001-2007
* DecisionSoft Limited. All rights reserved.
* Copyright (c) 2004-2007
* Oracle. All rights reserved.
*
* Licensed 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: XQillaNSResolver.hpp,v 1.6 2007/11/28 13:13:21 jpcs Exp $
*/
#ifndef __XQILLANSRESOLVER_HPP
#define __XQILLANSRESOLVER_HPP
#include <xqilla/framework/XQillaExport.hpp>
#include <xercesc/dom/DOMXPathNSResolver.hpp>
XERCES_CPP_NAMESPACE_BEGIN
class XercesDefs;
class DOMNode;
XERCES_CPP_NAMESPACE_END
class XPath2MemoryManager;
/**
* The <code>XQillaNSResolver</code> interface extends the <code>DOMXPathNSResolver</code>
* providing the ability to add additional namespace bindings.
* @since DOM Level 3
*/
class XQILLA_API XQillaNSResolver : public XERCES_CPP_NAMESPACE_QUALIFIER DOMXPathNSResolver
{
public:
// -----------------------------------------------------------------------
// Non-standard extension
// -----------------------------------------------------------------------
/** @name Non-standard extension */
//@{
/**
* Non-standard extension
*
* XQilla requires additional bindings of namespaces. This method will bind
* the given prefix to the associated namespace.
* @param prefix of type XMLCh - The prefix to bind.
* @param URI of type XMLCh - The associated namespace.
*/
virtual void addNamespaceBinding(const XMLCh* prefix, const XMLCh* uri) = 0;
/** Look up the namespace URI associated to the given namespace prefix.
* The XPath evaluator must never call this with a null or empty argument,
* because the result of doing this is undefined.
* @param prefix of type XMLCh - The prefix to look for.
* @return the associated namespace URI or null if none is found.
*/
virtual const XMLCh* lookupNamespaceURI(const XMLCh* prefix) const = 0;
/**
* Non-standard extension
*
* XPath2 implementations require a reverse lookup in the static context.
* Look up the prefix associated with the namespace URI
* The XPath evaluator must never call this with a null or empty argument,
* because the result of doing this is undefined.
* @param URI of type XMLCh - The namespace to look for.
* @return the associated prefix or null if none is found.
*/
virtual const XMLCh* lookupPrefix(const XMLCh* uri) 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 */
//@{
XQillaNSResolver() {};
//@}
};//XQillaNSResolver
#endif //__XQILLANSRESOLVER_HPP