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: XSParticle.hpp,v $
00059 * Revision 1.5 2003/12/01 23:23:26 neilg
00060 * fix for bug 25118; thanks to Jeroen Witmond
00061 *
00062 * Revision 1.4 2003/11/21 17:34:04 knoaman
00063 * PSVI update
00064 *
00065 * Revision 1.3 2003/11/14 22:47:53 neilg
00066 * fix bogus log message from previous commit...
00067 *
00068 * Revision 1.2 2003/11/14 22:33:30 neilg
00069 * Second phase of schema component model implementation.
00070 * Implement XSModel, XSNamespaceItem, and the plumbing necessary
00071 * to connect them to the other components.
00072 * Thanks to David Cargill.
00073 *
00074 * Revision 1.1 2003/09/16 14:33:36 neilg
00075 * PSVI/schema component model classes, with Makefile/configuration changes necessary to build them
00076 *
00077 */
00078
00079 #if !defined(XSPARTICLE_HPP)
00080 #define XSPARTICLE_HPP
00081
00082 #include <xercesc/framework/psvi/XSObject.hpp>
00083
00084 XERCES_CPP_NAMESPACE_BEGIN
00085
00093 // forward declarations
00094 class XSElementDeclaration;
00095 class XSModelGroup;
00096 class XSWildcard;
00097
00098 class XSParticle : public XSObject
00099 {
00100 public:
00101
00102 // possible terms of this particle
00103 enum TERM_TYPE {
00104 /*
00105 * an empty particle
00106 */
00107 TERM_EMPTY = 0,
00108 /*
00109 * the particle has element content
00110 */
00111 TERM_ELEMENT = XSConstants::ELEMENT_DECLARATION,
00112 /*
00113 * the particle's content is a model group
00114 */
00115 TERM_MODELGROUP = XSConstants::MODEL_GROUP_DEFINITION,
00116 /*
00117 * the particle's content is a wildcard
00118 */
00119 TERM_WILDCARD = XSConstants::WILDCARD
00120 };
00121
00122 // Constructors and Destructor
00123 // -----------------------------------------------------------------------
00126
00137 XSParticle
00138 (
00139 TERM_TYPE termType
00140 , XSModel* const xsModel
00141 , XSObject* const particleTerm
00142 , int minOccurs
00143 , int maxOccurs
00144 , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
00145 );
00146
00148
00151 ~XSParticle();
00153
00154 //---------------------
00157
00161 int getMinOccurs() const;
00162
00167 int getMaxOccurs() const;
00168
00172 bool getMaxOccursUnbounded() const;
00173
00178 TERM_TYPE getTermType() const;
00179
00186 XSElementDeclaration *getElementTerm();
00187
00194 XSModelGroup *getModelGroupTerm();
00195
00202 XSWildcard *getWildcardTerm();
00203
00205
00206 //----------------------------------
00209
00211 private:
00212
00213 // -----------------------------------------------------------------------
00214 // Unimplemented constructors and operators
00215 // -----------------------------------------------------------------------
00216 XSParticle(const XSParticle&);
00217 XSParticle & operator=(const XSParticle &);
00218
00219 protected:
00220
00221 // -----------------------------------------------------------------------
00222 // data members
00223 // -----------------------------------------------------------------------
00224 TERM_TYPE fTermType;
00225 int fMinOccurs;
00226 int fMaxOccurs;
00227XSObject* fTerm;
00228 };
00229
00230 inline int XSParticle::getMinOccurs() const
00231 {
00232 return fMinOccurs;
00233 }
00234
00235 inline int XSParticle::getMaxOccurs() const
00236 {
00237 return fMaxOccurs;
00238 }
00239
00240 inline bool XSParticle::getMaxOccursUnbounded() const
00241 {
00242 return (fMaxOccurs == -1);
00243 }
00244
00245 inline XSParticle::TERM_TYPEXSParticle::getTermType() const
00246 {
00247 return fTermType;
00248 }
00249
00250 XERCES_CPP_NAMESPACE_END
00251
00252 #endif