| API Docs for SAX and DOM |

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

# XSElementDeclaration.hpp

Go to the documentation of this file.

    00001 /*
    00002  * The Apache Software License, Version 1.1
    00003  *
    00004  * Copyright (c) 2003 The Apache Software Foundation.  All rights
    00005  * reserved.
    00006  *
    00007  * Redistribution and use in source and binary forms, with or without
    00008  * modification, are permitted provided that the following conditions
    00009  * are met:
    00010  *
    00011  * 1. Redistributions of source code must retain the above copyright
    00012  *    notice, this list of conditions and the following disclaimer.
    00013  *
    00014  * 2. Redistributions in binary form must reproduce the above copyright
    00015  *    notice, this list of conditions and the following disclaimer in
    00016  *    the documentation and/or other materials provided with the
    00017  *    distribution.
    00018  *
    00019  * 3. The end-user documentation included with the redistribution,
    00020  *    if any, must include the following acknowledgment:
    00021  *       "This product includes software developed by the
    00022  *        Apache Software Foundation (http://www.apache.org/)."
    00023  *    Alternately, this acknowledgment may appear in the software itself,
    00024  *    if and wherever such third-party acknowledgments normally appear.
    00025  *
    00026  * 4. The names "Xerces" and "Apache Software Foundation" must
    00027  *    not be used to endorse or promote products derived from this
    00028  *    software without prior written permission. For written
    00029  *    permission, please contact apache\@apache.org.
    00030  *
    00031  * 5. Products derived from this software may not be called "Apache",
    00032  *    nor may "Apache" appear in their name, without prior written
    00033  *    permission of the Apache Software Foundation.
    00034  *
    00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
    00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
    00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
    00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
    00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
    00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    00046  * SUCH DAMAGE.
    00047  * ====================================================================
    00048  *
    00049  * This software consists of voluntary contributions made by many
    00050  * individuals on behalf of the Apache Software Foundation, and was
    00051  * originally based on software copyright (c) 1999, International
    00052  * Business Machines, Inc., http://www.ibm.com .  For more information
    00053  * on the Apache Software Foundation, please see
    00054  * <http://www.apache.org/>.
    00055  */
    00056
    00057 /*
    00058  * $Log: XSElementDeclaration.hpp,v $
    00059  * Revision 1.9  2003/12/24 17:42:02  knoaman
    00060  * Misc. PSVI updates
    00061  *
    00062  * Revision 1.8  2003/12/01 23:23:26  neilg
    00063  * fix for bug 25118; thanks to Jeroen Witmond
    00064  *
    00065  * Revision 1.7  2003/12/01 20:41:25  neilg
    00066  * fix for infinite loop between XSComplexTypeDefinitions and XSElementDeclarations; from David Cargill
    00067  *
    00068  * Revision 1.6  2003/11/23 16:20:16  knoaman
    00069  * PSVI: pass scope and enclosing type during construction.
    00070  *
    00071  * Revision 1.5  2003/11/21 17:29:53  knoaman
    00072  * PSVI update
    00073  *
    00074  * Revision 1.4  2003/11/14 22:47:53  neilg
    00075  * fix bogus log message from previous commit...
    00076  *
    00077  * Revision 1.3  2003/11/14 22:33:30  neilg
    00078  * Second phase of schema component model implementation.
    00079  * Implement XSModel, XSNamespaceItem, and the plumbing necessary
    00080  * to connect them to the other components.
    00081  * Thanks to David Cargill.
    00082  *
    00083  * Revision 1.2  2003/11/06 15:30:04  neilg
    00084  * first part of PSVI/schema component model implementation, thanks to David Cargill.  This covers setting the PSVIHandler on parser objects, as well as implementing XSNotation, XSSimpleTypeDefinition, XSIDCDefinition, and most of XSWildcard, XSComplexTypeDefinition, XSElementDeclaration, XSAttributeDeclaration and XSAttributeUse.
    00085  *
    00086  * Revision 1.1  2003/09/16 14:33:36  neilg
    00087  * PSVI/schema component model classes, with Makefile/configuration changes necessary to build them
    00088  *
    00089  */
    00090
    00091 #if !defined(XSELEMENTDECLARATION_HPP)
    00092 #define XSELEMENTDECLARATION_HPP
    00093
    00094 #include <xercesc/framework/psvi/XSObject.hpp>
    00095 #include <xercesc/framework/psvi/XSNamedMap.hpp>
    00096
    00097 XERCES_CPP_NAMESPACE_BEGIN
    00098
    00106 // forward declarations
    00107 class XSAnnotation;
    00108 class XSComplexTypeDefinition;
    00109 class XSIDCDefinition;
    00110 class XSTypeDefinition;
    00111 class SchemaElementDecl;
    00112
    00113 class  XSElementDeclaration : public XSObject
    00114 {
    00115 public:
    00116
    00117     //  Constructors and Destructor
    00118     // -----------------------------------------------------------------------
    00121
    00135     XSElementDeclaration
    00136     (
    00137         SchemaElementDecl* const             schemaElementDecl
    00138         , XSTypeDefinition* const            typeDefinition
    00139         , XSElementDeclaration* const        substitutionGroupAffiliation
    00140         , XSAnnotation* const                annot
    00141         , XSNamedMap<XSIDCDefinition>* const identityConstraints
    00142         , XSModel* const                     xsModel
    00143         , XSConstants::SCOPE                 elemScope = XSConstants::SCOPE_ABSENT
    00144         , XSComplexTypeDefinition* const     enclosingTypeDefinition = 0
    00145         , MemoryManager* const               manager = XMLPlatformUtils::fgMemoryManager
    00146     );
    00147
    00149
    00152     ~XSElementDeclaration();
    00154
    00155     //---------------------
    00159
    00164     const XMLCh* getName();
    00165
    00170     const XMLCh* getNamespace();
    00171
    00177     XSNamespaceItem *getNamespaceItem();
    00178
    00184     unsigned int getId() const;
    00185
    00187
    00188     //---------------------
    00192
    00197     XSTypeDefinition *getTypeDefinition() const;
    00198
    00204     XSConstants::SCOPE getScope() const;
    00205
    00210     XSComplexTypeDefinition *getEnclosingCTDefinition() const;
    00211
    00215     XSConstants::VALUE_CONSTRAINT getConstraintType() const;
    00216
    00221     const XMLCh *getConstraintValue();
    00222
    00231     bool getNillable() const;
    00232
    00236     XSNamedMap <XSIDCDefinition> *getIdentityConstraints();
    00237
    00242     XSElementDeclaration *getSubstitutionGroupAffiliation() const;
    00243
    00253     bool isSubstitutionGroupExclusion(XSConstants::DERIVATION_TYPE exclusion);
    00254
    00261     short getSubstitutionGroupExclusions() const;
    00262
    00273     bool isDisallowedSubstitution(XSConstants::DERIVATION_TYPE disallowed);
    00274
    00282     short getDisallowedSubstitutions() const;
    00283
    00287     bool getAbstract() const;
    00288
    00292     XSAnnotation *getAnnotation() const;
    00293
    00295
    00296     //----------------------------------
    00303     void setId(unsigned int id);
    00304
    00305     void setTypeDefinition(XSTypeDefinition* typeDefinition);
    00306
    00308 private:
    00309
    00310     void setEnclosingCTDefinition(XSComplexTypeDefinition* const toSet);
    00311     friend class XSObjectFactory;
    00312
    00313     // -----------------------------------------------------------------------
    00314     //  Unimplemented constructors and operators
    00315     // -----------------------------------------------------------------------
    00316     XSElementDeclaration(const XSElementDeclaration&);
    00317     XSElementDeclaration & operator=(const XSElementDeclaration &);
    00318
    00319 protected:
    00320
    00321     // -----------------------------------------------------------------------
    00322     //  data members
    00323     // -----------------------------------------------------------------------
    00324     short                         fDisallowedSubstitutions;
    00325     short                         fSubstitutionGroupExclusions;
    00326     unsigned int                  fId;
    00327     XSConstants::SCOPE            fScope;
    00328     SchemaElementDecl*            fSchemaElementDecl;
    00329     XSTypeDefinition*             fTypeDefinition;
    00330     XSComplexTypeDefinition*      fEnclosingTypeDefinition;
    00331     XSElementDeclaration*         fSubstitutionGroupAffiliation;
    00332     XSAnnotation*                 fAnnotation;
    00333     XSNamedMap<XSIDCDefinition>*  fIdentityConstraints;
    00334 };
    00335
    00336 inline XSTypeDefinition* XSElementDeclaration::getTypeDefinition() const
    00337 {
    00338     return fTypeDefinition;
    00339 }
    00340
    00341 inline XSNamedMap<XSIDCDefinition>* XSElementDeclaration::getIdentityConstraints()
    00342 {
    00343     return fIdentityConstraints;
    00344 }
    00345
    00346 inline XSElementDeclaration* XSElementDeclaration::getSubstitutionGroupAffiliation() const
    00347 {
    00348     return fSubstitutionGroupAffiliation;
    00349 }
    00350
    00351 inline short XSElementDeclaration::getSubstitutionGroupExclusions() const
    00352 {
    00353     return fSubstitutionGroupExclusions;
    00354 }
    00355
    00356 inline short XSElementDeclaration::getDisallowedSubstitutions() const
    00357 {
    00358     return fDisallowedSubstitutions;
    00359 }
    00360
    00361 inline XSAnnotation *XSElementDeclaration::getAnnotation() const
    00362 {
    00363     return fAnnotation;
    00364 }
    00365
    00366 inline void XSElementDeclaration::setId(unsigned int id)
    00367 {
    00368     fId = id;
    00369 }
    00370
    00371 inline XSConstants::SCOPE XSElementDeclaration::getScope() const
    00372 {
    00373     return fScope;
    00374 }
    00375
    00376 inline XSComplexTypeDefinition *XSElementDeclaration::getEnclosingCTDefinition() const
    00377 {
    00378     return fEnclosingTypeDefinition;
    00379 }
    00380
    00381 inline void XSElementDeclaration::setTypeDefinition(XSTypeDefinition* typeDefinition)
    00382 {
    00383     fTypeDefinition = typeDefinition;
    00384 }
    00385
    00386 inline void XSElementDeclaration::setEnclosingCTDefinition(XSComplexTypeDefinition* const toSet)
    00387 {
    00388     fEnclosingTypeDefinition = toSet;
    00389 }
    00390
    00391 XERCES_CPP_NAMESPACE_END
    00392
    00393 #endif

Copyright © 2004 The Apache Software Foundation. All Rights Reserved.