| API Docs for SAX and DOM |

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

# XSAttributeDeclaration.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: XSAttributeDeclaration.hpp,v $
    00059  * Revision 1.8  2003/12/24 17:42:02  knoaman
    00060  * Misc. PSVI updates
    00061  *
    00062  * Revision 1.7  2003/12/01 23:23:26  neilg
    00063  * fix for bug 25118; thanks to Jeroen Witmond
    00064  *
    00065  * Revision 1.6  2003/11/21 22:34:45  neilg
    00066  * More schema component model implementation, thanks to David Cargill.
    00067  * In particular, this cleans up and completes the XSModel, XSNamespaceItem,
    00068  * XSAttributeDeclaration and XSAttributeGroup implementations.
    00069  *
    00070  * Revision 1.5  2003/11/21 17:19:30  knoaman
    00071  * PSVI update.
    00072  *
    00073  * Revision 1.4  2003/11/14 22:47:53  neilg
    00074  * fix bogus log message from previous commit...
    00075  *
    00076  * Revision 1.3  2003/11/14 22:33:30  neilg
    00077  * Second phase of schema component model implementation.
    00078  * Implement XSModel, XSNamespaceItem, and the plumbing necessary
    00079  * to connect them to the other components.
    00080  * Thanks to David Cargill.
    00081  *
    00082  * Revision 1.2  2003/11/06 15:30:04  neilg
    00083  * 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.
    00084  *
    00085  * Revision 1.1  2003/09/16 14:33:36  neilg
    00086  * PSVI/schema component model classes, with Makefile/configuration changes necessary to build them
    00087  *
    00088  */
    00089
    00090 #if !defined(XSATTRIBUTEDECLARATION_HPP)
    00091 #define XSATTRIBUTEDECLARATION_HPP
    00092
    00093 #include <xercesc/framework/psvi/XSObject.hpp>
    00094
    00095 XERCES_CPP_NAMESPACE_BEGIN
    00096
    00104 // forward declarations
    00105 class XSAnnotation;
    00106 class XSComplexTypeDefinition;
    00107 class XSSimpleTypeDefinition;
    00108 class SchemaAttDef;
    00109
    00110 class  XSAttributeDeclaration : public XSObject
    00111 {
    00112 public:
    00113
    00114     //  Constructors and Destructor
    00115     // -----------------------------------------------------------------------
    00118
    00130     XSAttributeDeclaration
    00131     (
    00132         SchemaAttDef* const             attDef
    00133         , XSSimpleTypeDefinition* const typeDef
    00134         , XSAnnotation* const           annot
    00135         , XSModel* const                xsModel
    00136         , XSConstants::SCOPE            scope
    00137         , XSComplexTypeDefinition*      enclosingCTDefinition
    00138         , MemoryManager* const          manager = XMLPlatformUtils::fgMemoryManager
    00139     );
    00140
    00142
    00145     ~XSAttributeDeclaration();
    00147
    00148     //---------------------
    00152
    00157     const XMLCh* getName();
    00158
    00163     const XMLCh* getNamespace();
    00164
    00170     XSNamespaceItem* getNamespaceItem();
    00171
    00177     unsigned int getId() const;
    00178
    00180
    00184
    00188     XSSimpleTypeDefinition *getTypeDefinition() const;
    00189
    00195     XSConstants::SCOPE getScope() const;
    00196
    00201     XSComplexTypeDefinition *getEnclosingCTDefinition();
    00202
    00206     XSConstants::VALUE_CONSTRAINT getConstraintType() const;
    00207
    00212     const XMLCh *getConstraintValue();
    00213
    00217     XSAnnotation *getAnnotation() const;
    00218
    00220
    00221     //----------------------------------
    00228     void setId(unsigned int id);
    00229
    00230     bool getRequired() const;
    00232
    00233 private:
    00234
    00235     void setEnclosingCTDefinition(XSComplexTypeDefinition* const toSet);
    00236     friend class XSObjectFactory;
    00237
    00238     // -----------------------------------------------------------------------
    00239     //  Unimplemented constructors and operators
    00240     // -----------------------------------------------------------------------
    00241     XSAttributeDeclaration(const XSAttributeDeclaration&);
    00242     XSAttributeDeclaration & operator=(const XSAttributeDeclaration &);
    00243
    00244 protected:
    00245
    00246     // -----------------------------------------------------------------------
    00247     //  data members
    00248     // -----------------------------------------------------------------------
    00249     SchemaAttDef*               fAttDef;
    00250     XSSimpleTypeDefinition*     fTypeDefinition;
    00251     XSAnnotation*               fAnnotation;
    00252     unsigned int                fId;
    00253     XSConstants::SCOPE          fScope;
    00254     XSComplexTypeDefinition*    fEnclosingCTDefinition;
    00255 };
    00256
    00257 // ---------------------------------------------------------------------------
    00258 //  XSAttributeDeclaration: inline methods
    00259 // ---------------------------------------------------------------------------
    00260 inline XSSimpleTypeDefinition* XSAttributeDeclaration::getTypeDefinition() const
    00261 {
    00262     return fTypeDefinition;
    00263 }
    00264
    00265 inline void XSAttributeDeclaration::setId(unsigned int id)
    00266 {
    00267     fId = id;
    00268 }
    00269
    00270 inline XSAnnotation *XSAttributeDeclaration::getAnnotation() const
    00271 {
    00272     return fAnnotation;
    00273 }
    00274
    00275 inline XSConstants::SCOPE XSAttributeDeclaration::getScope() const
    00276 {
    00277     return fScope;
    00278 }
    00279
    00280 inline XSComplexTypeDefinition *XSAttributeDeclaration::getEnclosingCTDefinition()
    00281 {
    00282     return fEnclosingCTDefinition;
    00283 }
    00284
    00285 inline void XSAttributeDeclaration::setEnclosingCTDefinition
    00286 (
    00287     XSComplexTypeDefinition* const toSet
    00288 )
    00289 {
    00290     fEnclosingCTDefinition = toSet;
    00291 }
    00292
    00293 XERCES_CPP_NAMESPACE_END
    00294
    00295 #endif

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