XQilla Simple API Documentation

00001 /*
00002  * Copyright (c) 2001-2006
00003  *     DecisionSoft Limited. All rights reserved.
00004  * Copyright (c) 2004-2006
00005  *     Progress Software Corporation. All rights reserved.
00006  * Copyright (c) 2004-2006
00007  *     Oracle. All rights reserved.
00008  *
00009  * See the file LICENSE for redistribution information.
00010  *
00011  * $Id: URIResolver.hpp,v 1.8 2007/02/07 12:12:56 jpcs Exp $
00012  */
00013 
00014 #ifndef _URIRESOLVER_HPP
00015 #define _URIRESOLVER_HPP
00016 
00017 #include <xqilla/framework/XQillaExport.hpp>
00018 
00019 #include <xercesc/util/XercesDefs.hpp>
00020 #include <xercesc/util/XMemory.hpp>
00021 
00022 class DynamicContext;
00023 class Sequence;
00024 
00025 XERCES_CPP_NAMESPACE_BEGIN
00026 class DOMDocument;
00027 class DOMNodeList;
00028 XERCES_CPP_NAMESPACE_END
00029 
00033 class XQILLA_API URIResolver : public XERCES_CPP_NAMESPACE_QUALIFIER XMemory
00034 {
00035   public:
00036     /* virtual destructor, does nothing */
00037     virtual ~URIResolver() {};      
00038 
00039     /* Resolve the given uri (and baseUri) to a Sequence (reference parameter). If the uri
00040        is relative, the base uri can be obtained from the context. If the uri is not handled
00041        by this URIResolver, returns false, otherwise returns true. */
00042     virtual bool resolveDocument(Sequence &result, const XMLCh* uri, DynamicContext* context) = 0;
00043 
00044     /* Resolve the given uri (and baseUri) to a Sequence (reference parameter). If the uri
00045        is relative, the base uri can be obtained from the context. If the uri is not handled
00046        by this URIResolver, returns false, otherwise returns true. */
00047     virtual bool resolveCollection(Sequence &result, const XMLCh* uri, DynamicContext* context) = 0;
00048 
00049     /* Resolve the default collection. If it is not defined, returns false, otherwise returns true. */
00050     virtual bool resolveDefaultCollection(Sequence &result, DynamicContext* context) = 0;
00051 };
00052 #endif // _URIRESOLVER_HPP