http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Home

Readme
Release Info

Installation
Download
Build

FAQs
Samples
API Docs

DOM C++ Binding
Programming
Migration Guide

Feedback
Bug-Reporting
PDF Document

CVS Repository
Mail Archive

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.8  2003/12/01 23:23:26  neilg
00060  * fix for bug 25118; thanks to Jeroen Witmond
00061  *
00062  * Revision 1.7  2003/12/01 20:41:25  neilg
00063  * fix for infinite loop between XSComplexTypeDefinitions and XSElementDeclarations; from David Cargill
00064  *
00065  * Revision 1.6  2003/11/23 16:20:16  knoaman
00066  * PSVI: pass scope and enclosing type during construction.
00067  *
00068  * Revision 1.5  2003/11/21 17:29:53  knoaman
00069  * PSVI update
00070  *
00071  * Revision 1.4  2003/11/14 22:47:53  neilg
00072  * fix bogus log message from previous commit...
00073  *
00074  * Revision 1.3  2003/11/14 22:33:30  neilg
00075  * Second phase of schema component model implementation.  
00076  * Implement XSModel, XSNamespaceItem, and the plumbing necessary
00077  * to connect them to the other components.
00078  * Thanks to David Cargill.
00079  *
00080  * Revision 1.2  2003/11/06 15:30:04  neilg
00081  * 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.
00082  *
00083  * Revision 1.1  2003/09/16 14:33:36  neilg
00084  * PSVI/schema component model classes, with Makefile/configuration changes necessary to build them
00085  *
00086  */
00087 
00088 #if !defined(XSELEMENTDECLARATION_HPP)
00089 #define XSELEMENTDECLARATION_HPP
00090 
00091 #include <xercesc/framework/psvi/XSObject.hpp>
00092 #include <xercesc/framework/psvi/XSNamedMap.hpp>
00093 
00094 XERCES_CPP_NAMESPACE_BEGIN
00095 
00103 // forward declarations
00104 class XSAnnotation;
00105 class XSComplexTypeDefinition;
00106 class XSIDCDefinition;
00107 class XSTypeDefinition;
00108 class SchemaElementDecl;
00109 
00110 class  XSElementDeclaration : public XSObject
00111 {
00112 public:
00113 
00114     //  Constructors and Destructor
00115     // -----------------------------------------------------------------------
00118 
00132     XSElementDeclaration
00133     (
00134         SchemaElementDecl* const             schemaElementDecl
00135         , XSTypeDefinition* const            typeDefinition
00136         , XSElementDeclaration* const        substitutionGroupAffiliation
00137         , XSAnnotation* const                annot
00138         , XSNamedMap<XSIDCDefinition>* const identityConstraints
00139         , XSModel* const                     xsModel
00140         , XSConstants::SCOPE                 elemScope = XSConstants::SCOPE_ABSENT
00141         , XSComplexTypeDefinition* const     enclosingTypeDefinition = 0
00142         , MemoryManager* const               manager = XMLPlatformUtils::fgMemoryManager
00143     );
00144 
00146 
00149     ~XSElementDeclaration();
00151 
00152     //---------------------
00156 
00161     const XMLCh* getName();
00162 
00167     const XMLCh* getNamespace();
00168 
00174     XSNamespaceItem *getNamespaceItem();
00175 
00181     unsigned int getId() const;
00182 
00184 
00185     //---------------------
00189 
00194     XSTypeDefinition *getTypeDefinition() const;
00195 
00201     XSConstants::SCOPE getScope() const;
00202 
00207     XSComplexTypeDefinition *getEnclosingCTDefinition() const;
00208 
00212     XSConstants::VALUE_CONSTRAINT getConstraintType() const;
00213 
00218     const XMLCh *getConstraintValue();
00219 
00228     bool getNillable() const;
00229 
00233     XSNamedMap <XSIDCDefinition> *getIdentityConstraints();
00234 
00239     XSElementDeclaration *getSubstitutionGroupAffiliation() const;
00240 
00250     bool isSubstitutionGroupExclusion(XSConstants::DERIVATION_TYPE exclusion);
00251 
00258     short getSubstitutionGroupExclusions() const;
00259 
00270     bool isDisallowedSubstitution(XSConstants::DERIVATION_TYPE disallowed);
00271 
00279     short getDisallowedSubstitutions() const;
00280 
00284     bool getAbstract() const;
00285 
00289     XSAnnotation *getAnnotation() const;
00290 
00292 
00293     //----------------------------------
00300     void setId(unsigned int id);
00301 
00302     void setTypeDefinition(XSTypeDefinition* typeDefinition);
00303 
00305 private:
00306 
00307     // -----------------------------------------------------------------------
00308     //  Unimplemented constructors and operators
00309     // -----------------------------------------------------------------------
00310     XSElementDeclaration(const XSElementDeclaration&);
00311     XSElementDeclaration & operator=(const XSElementDeclaration &);
00312 
00313 protected:
00314 
00315     // -----------------------------------------------------------------------
00316     //  data members
00317     // -----------------------------------------------------------------------
00318     short                         fDisallowedSubstitutions;
00319     short                         fSubstitutionGroupExclusions;
00320     unsigned int                  fId;
00321     XSConstants::SCOPE            fScope;
00322     SchemaElementDecl*            fSchemaElementDecl;
00323     XSTypeDefinition*             fTypeDefinition;
00324     XSComplexTypeDefinition*      fEnclosingTypeDefinition;
00325     XSElementDeclaration*         fSubstitutionGroupAffiliation;
00326     XSAnnotation*                 fAnnotation;
00327     XSNamedMap<XSIDCDefinition>*  fIdentityConstraints;
00328 };
00329 
00330 inline XSTypeDefinition* XSElementDeclaration::getTypeDefinition() const
00331 {
00332     return fTypeDefinition;
00333 }
00334 
00335 inline XSNamedMap<XSIDCDefinition>* XSElementDeclaration::getIdentityConstraints()
00336 {
00337     return fIdentityConstraints;
00338 }
00339 
00340 inline XSElementDeclaration* XSElementDeclaration::getSubstitutionGroupAffiliation() const
00341 {
00342     return fSubstitutionGroupAffiliation;
00343 }
00344 
00345 inline short XSElementDeclaration::getSubstitutionGroupExclusions() const
00346 {
00347     return fSubstitutionGroupExclusions;
00348 }
00349 
00350 inline short XSElementDeclaration::getDisallowedSubstitutions() const
00351 {
00352     return fDisallowedSubstitutions;
00353 }
00354 
00355 inline XSAnnotation *XSElementDeclaration::getAnnotation() const
00356 {
00357     return fAnnotation;
00358 }
00359 
00360 inline void XSElementDeclaration::setId(unsigned int id)
00361 {
00362     fId = id;
00363 }
00364 
00365 inline XSConstants::SCOPE XSElementDeclaration::getScope() const
00366 {
00367     return fScope;
00368 }
00369 
00370 inline XSComplexTypeDefinition *XSElementDeclaration::getEnclosingCTDefinition() const
00371 {
00372     return fEnclosingTypeDefinition;
00373 }
00374 
00375 inline void XSElementDeclaration::setTypeDefinition(XSTypeDefinition* typeDefinition)
00376 {
00377     fTypeDefinition = typeDefinition;
00378 }
00379 
00380 XERCES_CPP_NAMESPACE_END
00381 
00382 #endif


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