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, 2015 Oracle and/or its affiliates. All rights reserved.
5 *
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
20#ifndef _DOCUMENTCACHE_HPP
21#define _DOCUMENTCACHE_HPP
22
23#include <vector>
24
26#include <xqilla/items/Node.hpp>
27
28#include <xercesc/util/XercesDefs.hpp>
30
31class DynamicContext;
32class StaticContext;
33class QualifiedName;
34class LocationInfo;
35class QueryPathNode;
36
37typedef std::vector<const XMLCh*, XQillaAllocator<const XMLCh*> > VectorOfStrings;
38
39XERCES_CPP_NAMESPACE_BEGIN
40class DOMDocument;
41class DOMNode;
42class DatatypeValidator;
43class XMLEntityResolver;
44class ComplexTypeInfo;
45class SchemaElementDecl;
46class SchemaAttDef;
47class InputSource;
48class GrammarResolver;
49XERCES_CPP_NAMESPACE_END
50
52class XQILLA_API DocumentCache : public XERCES_CPP_NAMESPACE_QUALIFIER XMemory
53{
54public:
56 static const XMLCh g_szUntyped[];
57
59 VALIDATION_STRICT = 0,
60 VALIDATION_LAX = 1,
61 VALIDATION_SKIP = 2
62 };
63
65 virtual ~DocumentCache() {}
66
68 virtual Node::Ptr loadDocument(const XMLCh* uri, DynamicContext *context, const QueryPathNode *projection = 0) = 0;
70 virtual Node::Ptr parseDocument(XERCES_CPP_NAMESPACE_QUALIFIER InputSource &srcToUse, DynamicContext *context, const QueryPathNode *projection = 0) = 0;
72 virtual void parseDocument(XERCES_CPP_NAMESPACE_QUALIFIER InputSource &srcToUse, EventHandler *handler, DynamicContext *context) = 0;
73
79 virtual void setXMLEntityResolver(XERCES_CPP_NAMESPACE_QUALIFIER XMLEntityResolver* const handler) = 0;
80 virtual XERCES_CPP_NAMESPACE_QUALIFIER XMLEntityResolver* getXMLEntityResolver() const = 0;
81
82 virtual bool getDoPSVI() const = 0;
83 virtual void setDoPSVI(bool value) = 0;
84
85 /*
86 * returns true if the type represented by uri:typename is an instance of uriToCheck:typeNameToCheck
87 *
88 * ie: to check
89 * xs:integer instance of xs:decimal,
90 * call
91 * isTypeOrDerivedFromType("xs", "integer", "xs", "decimal")
92 * (except of course, call with URIs, not prefixes!)
93 */
94 virtual bool isTypeOrDerivedFromType(const XMLCh* const uri, const XMLCh* const typeName, const XMLCh* const uriToCheck, const XMLCh* const typeNameToCheck) const = 0;
95 virtual bool isTypeDefined(const XMLCh* const uri, const XMLCh* const typeName) const = 0;
96
97 virtual void addSchemaLocation(const XMLCh* uri, VectorOfStrings* locations, StaticContext *context, const LocationInfo *location) = 0;
98
100 virtual unsigned int getSchemaUriId(const XMLCh* uri) const = 0;
101 virtual const XMLCh* getSchemaUri(unsigned int id) const = 0;
102
103 virtual XERCES_CPP_NAMESPACE_QUALIFIER GrammarResolver *getGrammarResolver() const = 0;
104
105 virtual XERCES_CPP_NAMESPACE_QUALIFIER DatatypeValidator* getDatatypeValidator(const XMLCh* uri, const XMLCh* typeName) const = 0;
106
107 virtual XERCES_CPP_NAMESPACE_QUALIFIER ComplexTypeInfo* getComplexTypeInfo(const XMLCh* uri, const XMLCh* typeName) const = 0;
108
109 virtual XERCES_CPP_NAMESPACE_QUALIFIER SchemaElementDecl* getElementDecl(const XMLCh* elementUri, const XMLCh* elementName) const = 0;
110
111 virtual XERCES_CPP_NAMESPACE_QUALIFIER SchemaAttDef* getAttributeDecl(const XMLCh* attributeUri, const XMLCh* attributeName) const = 0;
112
113 virtual DocumentCache *createDerivedCache(XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager *memMgr) const = 0;
114};
115
116#endif
117
118
119
120
121
122
123
std::vector< const XMLCh *, XQillaAllocator< const XMLCh * > > VectorOfStrings
Definition: DocumentCache.hpp:37
Expression Context is a storage for contexts.
Definition: DocumentCache.hpp:53
ValidationMode
Definition: DocumentCache.hpp:58
virtual unsigned int getSchemaUriId(const XMLCh *uri) const =0
helper functions used to map namespace ids found in the SchemaGrammar
virtual xercesc::XMLEntityResolver * getXMLEntityResolver() const =0
virtual ~DocumentCache()
virtual destructor
Definition: DocumentCache.hpp:65
virtual bool isTypeDefined(const XMLCh *const uri, const XMLCh *const typeName) const =0
virtual xercesc::SchemaElementDecl * getElementDecl(const XMLCh *elementUri, const XMLCh *elementName) const =0
virtual void addSchemaLocation(const XMLCh *uri, VectorOfStrings *locations, StaticContext *context, const LocationInfo *location)=0
virtual xercesc::DatatypeValidator * getDatatypeValidator(const XMLCh *uri, const XMLCh *typeName) const =0
virtual xercesc::GrammarResolver * getGrammarResolver() const =0
virtual bool getDoPSVI() const =0
virtual Node::Ptr parseDocument(xercesc::InputSource &srcToUse, DynamicContext *context, const QueryPathNode *projection=0)=0
parse the document from the InputSource provided
virtual DocumentCache * createDerivedCache(xercesc::MemoryManager *memMgr) const =0
virtual const XMLCh * getSchemaUri(unsigned int id) const =0
virtual void setXMLEntityResolver(xercesc::XMLEntityResolver *const handler)=0
Sets the XMLEntityResolver that is used by Xerces when it is used to parse documents.
virtual void setDoPSVI(bool value)=0
virtual bool isTypeOrDerivedFromType(const XMLCh *const uri, const XMLCh *const typeName, const XMLCh *const uriToCheck, const XMLCh *const typeNameToCheck) const =0
virtual void parseDocument(xercesc::InputSource &srcToUse, EventHandler *handler, DynamicContext *context)=0
parse the document from the InputSource provided, outputing it to the EventHandler provided
virtual xercesc::SchemaAttDef * getAttributeDecl(const XMLCh *attributeUri, const XMLCh *attributeName) const =0
virtual xercesc::ComplexTypeInfo * getComplexTypeInfo(const XMLCh *uri, const XMLCh *typeName) const =0
virtual Node::Ptr loadDocument(const XMLCh *uri, DynamicContext *context, const QueryPathNode *projection=0)=0
load the document from the requested URI
The execution time dynamic context interface.
Definition: DynamicContext.hpp:39
Definition: EventHandler.hpp:30
A class that gives records a location in the query.
Definition: LocationInfo.hpp:30
Super class of all the reference counted wrappers for Items.
Definition: ReferenceCounted.hpp:62
The parse time static context interface.
Definition: StaticContext.hpp:58