SourceForge.net Logo
DocumentCache.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2001-2008
3  * DecisionSoft Limited. All rights reserved.
4  * Copyright (c) 2004-2008
5  * Oracle. All rights reserved.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  * $Id$
20  */
21 
22 #ifndef _DOCUMENTCACHE_HPP
23 #define _DOCUMENTCACHE_HPP
24 
25 #include <vector>
26 
28 #include <xqilla/items/Node.hpp>
29 
30 #include <xercesc/util/XercesDefs.hpp>
31 #include <xercesc/util/XMemory.hpp>
32 
33 class DynamicContext;
34 class StaticContext;
35 class QualifiedName;
36 class LocationInfo;
37 class QueryPathNode;
38 
39 typedef std::vector<const XMLCh*, XQillaAllocator<const XMLCh*> > VectorOfStrings;
40 
41 XERCES_CPP_NAMESPACE_BEGIN
42 class DOMDocument;
43 class DOMNode;
44 class DatatypeValidator;
45 class XMLEntityResolver;
46 class ComplexTypeInfo;
47 class SchemaElementDecl;
48 class SchemaAttDef;
49 class InputSource;
50 class GrammarResolver;
51 XERCES_CPP_NAMESPACE_END
52 
54 class XQILLA_API DocumentCache : public XERCES_CPP_NAMESPACE_QUALIFIER XMemory
55 {
56 public:
58  static const XMLCh g_szUntyped[];
59 
61  VALIDATION_STRICT = 0,
62  VALIDATION_LAX = 1,
63  VALIDATION_SKIP = 2
64  };
65 
67  virtual ~DocumentCache() {}
68 
70  virtual Node::Ptr loadDocument(const XMLCh* uri, DynamicContext *context, const QueryPathNode *projection = 0) = 0;
72  virtual Node::Ptr parseDocument(XERCES_CPP_NAMESPACE_QUALIFIER InputSource &srcToUse, DynamicContext *context, const QueryPathNode *projection = 0) = 0;
74  virtual void parseDocument(XERCES_CPP_NAMESPACE_QUALIFIER InputSource &srcToUse, EventHandler *handler, DynamicContext *context) = 0;
75 
81  virtual void setXMLEntityResolver(XERCES_CPP_NAMESPACE_QUALIFIER XMLEntityResolver* const handler) = 0;
82  virtual XERCES_CPP_NAMESPACE_QUALIFIER XMLEntityResolver* getXMLEntityResolver() const = 0;
83 
84  virtual bool getDoPSVI() const = 0;
85  virtual void setDoPSVI(bool value) = 0;
86 
87  /*
88  * returns true if the type represented by uri:typename is an instance of uriToCheck:typeNameToCheck
89  *
90  * ie: to check
91  * xs:integer instance of xs:decimal,
92  * call
93  * isTypeOrDerivedFromType("xs", "integer", "xs", "decimal")
94  * (except of course, call with URIs, not prefixes!)
95  */
96  virtual bool isTypeOrDerivedFromType(const XMLCh* const uri, const XMLCh* const typeName, const XMLCh* const uriToCheck, const XMLCh* const typeNameToCheck) const = 0;
97  virtual bool isTypeDefined(const XMLCh* const uri, const XMLCh* const typeName) const = 0;
98 
99  virtual void addSchemaLocation(const XMLCh* uri, VectorOfStrings* locations, StaticContext *context, const LocationInfo *location) = 0;
100 
102  virtual unsigned int getSchemaUriId(const XMLCh* uri) const = 0;
103  virtual const XMLCh* getSchemaUri(unsigned int id) const = 0;
104 
105  virtual XERCES_CPP_NAMESPACE_QUALIFIER GrammarResolver *getGrammarResolver() const = 0;
106 
107  virtual XERCES_CPP_NAMESPACE_QUALIFIER DatatypeValidator* getDatatypeValidator(const XMLCh* uri, const XMLCh* typeName) const = 0;
108 
109  virtual XERCES_CPP_NAMESPACE_QUALIFIER ComplexTypeInfo* getComplexTypeInfo(const XMLCh* uri, const XMLCh* typeName) const = 0;
110 
111  virtual XERCES_CPP_NAMESPACE_QUALIFIER SchemaElementDecl* getElementDecl(const XMLCh* elementUri, const XMLCh* elementName) const = 0;
112 
113  virtual XERCES_CPP_NAMESPACE_QUALIFIER SchemaAttDef* getAttributeDecl(const XMLCh* attributeUri, const XMLCh* attributeName) const = 0;
114 
115  virtual DocumentCache *createDerivedCache(XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager *memMgr) const = 0;
116 };
117 
118 #endif
119 
120 
121 
122 
123 
124 
125