Xerces-C++ 3.2.4

XSIDCDefinition.hpp
Go to the documentation of this file.
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18/*
19 * $Id$
20 */
21
22#if !defined(XERCESC_INCLUDE_GUARD_XSIDCDEFINITION_HPP)
23#define XERCESC_INCLUDE_GUARD_XSIDCDEFINITION_HPP
24
25#include <xercesc/framework/psvi/XSObject.hpp>
26
27 XERCES_CPP_NAMESPACE_BEGIN
28
36// forward declarations
37 class XSAnnotation;
38 class IdentityConstraint;
39
40 class XMLPARSER_EXPORT XSIDCDefinition : public XSObject
41{
42 public:
43
44 // Identity Constraints
45 enum IC_CATEGORY {
49 IC_KEY = 1,
53 IC_KEYREF = 2,
57 IC_UNIQUE = 3
58 };
59
60 // Constructors and Destructor
61 // -----------------------------------------------------------------------
64
75 XSIDCDefinition
76 (
77 IdentityConstraint* const identityConstraint
78 , XSIDCDefinition* const keyIC
79 , XSAnnotation* const headAnnot
80 , StringList* const stringList
81 , XSModel* const xsModel
82 , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
83 );
84
86
89 ~XSIDCDefinition();
91
92 //---------------------
96
101 const XMLCh* getName() const;
102
107 const XMLCh* getNamespace() const;
108
114 XSNamespaceItem *getNamespaceItem();
115
117
118 //---------------------
122
126 IC_CATEGORY getCategory() const;
127
131 const XMLCh *getSelectorStr();
132
136 StringList *getFieldStrs();
137
143 XSIDCDefinition *getRefKey() const;
144
148 XSAnnotationList *getAnnotations();
149
151
152 //----------------------------------
156
158 private:
159
160 // -----------------------------------------------------------------------
161 // Unimplemented constructors and operators
162 // -----------------------------------------------------------------------
163 XSIDCDefinition(const XSIDCDefinition&);
164 XSIDCDefinition & operator=(const XSIDCDefinition &);
165
166 protected:
167
168 // -----------------------------------------------------------------------
169 // data members
170 // -----------------------------------------------------------------------
171 IdentityConstraint* fIdentityConstraint;
172 XSIDCDefinition* fKey;
173 StringList* fStringList;
174 XSAnnotationList* fXSAnnotationList;
175};
176
177
178 inline StringList* XSIDCDefinition::getFieldStrs()
179{
180 return fStringList;
181}
182
183 inline XSIDCDefinition* XSIDCDefinition::getRefKey() const
184{
185 return fKey;
186}
187
188 XERCES_CPP_NAMESPACE_END
189
190#endif
XSAnnotationList
RefVectorOf< XSAnnotation > XSAnnotationList
Definition: XSConstants.hpp:41
StringList
RefArrayVectorOf< XMLCh > StringList
Definition: XSConstants.hpp:54
XSObject.hpp
XMLPARSER_EXPORT
#define XMLPARSER_EXPORT
Definition: XercesDefs.hpp:163
XERCES_CPP_NAMESPACE_BEGIN
#define XERCES_CPP_NAMESPACE_BEGIN
Definition: XercesDefs.hpp:112
XERCES_CPP_NAMESPACE_END
#define XERCES_CPP_NAMESPACE_END
Definition: XercesDefs.hpp:113
XMLCh
uint16_t XMLCh
Definition: Xerces_autoconf_config.hpp:120
MemoryManager
Configurable memory manager.
Definition: MemoryManager.hpp:40
XMLPlatformUtils::fgMemoryManager
static MemoryManager * fgMemoryManager
The configurable memory manager.
Definition: PlatformUtils.hpp:121
XSAnnotation
Definition: XSAnnotation.hpp:42
XSIDCDefinition
Definition: XSIDCDefinition.hpp:41
XSIDCDefinition::getSelectorStr
const XMLCh * getSelectorStr()
[selector]: a restricted XPath expression.
XSIDCDefinition::getCategory
IC_CATEGORY getCategory() const
[identity-constraint category]: one of IC_KEY, IC_KEYREF or IC_UNIQUE.
XSIDCDefinition::fStringList
StringList * fStringList
Definition: XSIDCDefinition.hpp:173
XSIDCDefinition::getAnnotations
XSAnnotationList * getAnnotations()
A set of [annotations].
XSIDCDefinition::fKey
XSIDCDefinition * fKey
Definition: XSIDCDefinition.hpp:172
XSIDCDefinition::getFieldStrs
StringList * getFieldStrs()
[fields]: a non-empty list of restricted XPath ([XPath]) expressions.
Definition: XSIDCDefinition.hpp:178
XSIDCDefinition::~XSIDCDefinition
~XSIDCDefinition()
XSIDCDefinition::getNamespaceItem
XSNamespaceItem * getNamespaceItem()
A namespace schema information item corresponding to the target namespace of the component,...
XSIDCDefinition::XSIDCDefinition
XSIDCDefinition(IdentityConstraint *const identityConstraint, XSIDCDefinition *const keyIC, XSAnnotation *const headAnnot, StringList *const stringList, XSModel *const xsModel, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)
The default constructor.
XSIDCDefinition::getNamespace
const XMLCh * getNamespace() const
The [target namespace] of this object, or null if it is unspecified.
XSIDCDefinition::getName
const XMLCh * getName() const
The name of type NCName of this declaration as defined in XML Namespaces.
XSIDCDefinition::fIdentityConstraint
IdentityConstraint * fIdentityConstraint
Definition: XSIDCDefinition.hpp:171
XSIDCDefinition::IC_CATEGORY
IC_CATEGORY
Definition: XSIDCDefinition.hpp:45
XSIDCDefinition::getRefKey
XSIDCDefinition * getRefKey() const
[referenced key]: required if [identity-constraint category] is IC_KEYREF, forbidden otherwise (when ...
Definition: XSIDCDefinition.hpp:183
XSIDCDefinition::fXSAnnotationList
XSAnnotationList * fXSAnnotationList
Definition: XSIDCDefinition.hpp:174
XSModel
Definition: XSModel.hpp:60
XSNamespaceItem
Definition: XSNamespaceItem.hpp:54
XSObject
Definition: XSObject.hpp:43