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  

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.7  2003/12/01 23:23:26  neilg
00060  * fix for bug 25118; thanks to Jeroen Witmond
00061  *
00062  * Revision 1.6  2003/11/21 22:34:45  neilg
00063  * More schema component model implementation, thanks to David Cargill.
00064  * In particular, this cleans up and completes the XSModel, XSNamespaceItem,
00065  * XSAttributeDeclaration and XSAttributeGroup implementations.
00066  *
00067  * Revision 1.5  2003/11/21 17:19:30  knoaman
00068  * PSVI update.
00069  *
00070  * Revision 1.4  2003/11/14 22:47:53  neilg
00071  * fix bogus log message from previous commit...
00072  *
00073  * Revision 1.3  2003/11/14 22:33:30  neilg
00074  * Second phase of schema component model implementation.  
00075  * Implement XSModel, XSNamespaceItem, and the plumbing necessary
00076  * to connect them to the other components.
00077  * Thanks to David Cargill.
00078  *
00079  * Revision 1.2  2003/11/06 15:30:04  neilg
00080  * 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.
00081  *
00082  * Revision 1.1  2003/09/16 14:33:36  neilg
00083  * PSVI/schema component model classes, with Makefile/configuration changes necessary to build them
00084  *
00085  */
00086 
00087 #if !defined(XSATTRIBUTEDECLARATION_HPP)
00088 #define XSATTRIBUTEDECLARATION_HPP
00089 
00090 #include <xercesc/framework/psvi/XSObject.hpp>
00091 
00092 XERCES_CPP_NAMESPACE_BEGIN
00093 
00101 // forward declarations
00102 class XSAnnotation;
00103 class XSComplexTypeDefinition;
00104 class XSSimpleTypeDefinition;
00105 class SchemaAttDef;
00106 
00107 class  XSAttributeDeclaration : public XSObject
00108 {
00109 public:
00110 
00111     //  Constructors and Destructor
00112     // -----------------------------------------------------------------------
00115 
00127     XSAttributeDeclaration
00128     (
00129         SchemaAttDef* const             attDef
00130         , XSSimpleTypeDefinition* const typeDef
00131         , XSAnnotation* const           annot
00132         , XSModel* const                xsModel
00133         , XSConstants::SCOPE            scope
00134         , XSComplexTypeDefinition*      enclosingCTDefinition
00135         , MemoryManager* const          manager = XMLPlatformUtils::fgMemoryManager
00136     );
00137 
00139 
00142     ~XSAttributeDeclaration();
00144 
00145     //---------------------
00149 
00154     const XMLCh* getName();
00155 
00160     const XMLCh* getNamespace();
00161 
00167     XSNamespaceItem* getNamespaceItem();
00168 
00174     unsigned int getId() const;
00175 
00177 
00181 
00185     XSSimpleTypeDefinition *getTypeDefinition() const;
00186 
00192     XSConstants::SCOPE getScope() const;
00193 
00198     XSComplexTypeDefinition *getEnclosingCTDefinition();
00199 
00203     XSConstants::VALUE_CONSTRAINT getConstraintType() const;
00204 
00209     const XMLCh *getConstraintValue();
00210 
00214     XSAnnotation *getAnnotation() const;
00215 
00217 
00218     //----------------------------------
00225     void setId(unsigned int id);
00226 
00227     bool getRequired() const;
00229 
00230 private:
00231 
00232     // -----------------------------------------------------------------------
00233     //  Unimplemented constructors and operators
00234     // -----------------------------------------------------------------------
00235     XSAttributeDeclaration(const XSAttributeDeclaration&);
00236     XSAttributeDeclaration & operator=(const XSAttributeDeclaration &);
00237 
00238 protected:
00239 
00240     // -----------------------------------------------------------------------
00241     //  data members
00242     // -----------------------------------------------------------------------
00243     SchemaAttDef*               fAttDef;
00244     XSSimpleTypeDefinition*     fTypeDefinition;
00245     XSAnnotation*               fAnnotation;
00246     unsigned int                fId;
00247     XSConstants::SCOPE          fScope;
00248     XSComplexTypeDefinition*    fEnclosingCTDefinition;
00249 };
00250 
00251 // ---------------------------------------------------------------------------
00252 //  XSAttributeDeclaration: inline methods
00253 // ---------------------------------------------------------------------------
00254 inline XSSimpleTypeDefinition* XSAttributeDeclaration::getTypeDefinition() const
00255 {
00256     return fTypeDefinition;
00257 }
00258 
00259 inline void XSAttributeDeclaration::setId(unsigned int id)
00260 {
00261     fId = id;
00262 }
00263 
00264 inline XSAnnotation *XSAttributeDeclaration::getAnnotation() const
00265 {
00266     return fAnnotation;
00267 }
00268 
00269 inline XSConstants::SCOPE XSAttributeDeclaration::getScope() const
00270 {   
00271     return fScope;
00272 }
00273 
00274 inline XSComplexTypeDefinition *XSAttributeDeclaration::getEnclosingCTDefinition()
00275 {
00276     return fEnclosingCTDefinition;
00277 }
00278 
00279 XERCES_CPP_NAMESPACE_END
00280 
00281 #endif


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