source: NonGTP/Xerces/xercesc/framework/psvi/XSModelGroup.hpp @ 188

Revision 188, 6.7 KB checked in by mattausch, 19 years ago (diff)

added xercesc to support

Line 
1/*
2 * The Apache Software License, Version 1.1
3 *
4 * Copyright (c) 2003 The Apache Software Foundation.  All rights
5 * reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 *
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in
16 *    the documentation and/or other materials provided with the
17 *    distribution.
18 *
19 * 3. The end-user documentation included with the redistribution,
20 *    if any, must include the following acknowledgment:
21 *       "This product includes software developed by the
22 *        Apache Software Foundation (http://www.apache.org/)."
23 *    Alternately, this acknowledgment may appear in the software itself,
24 *    if and wherever such third-party acknowledgments normally appear.
25 *
26 * 4. The names "Xerces" and "Apache Software Foundation" must
27 *    not be used to endorse or promote products derived from this
28 *    software without prior written permission. For written
29 *    permission, please contact apache\@apache.org.
30 *
31 * 5. Products derived from this software may not be called "Apache",
32 *    nor may "Apache" appear in their name, without prior written
33 *    permission of the Apache Software Foundation.
34 *
35 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46 * SUCH DAMAGE.
47 * ====================================================================
48 *
49 * This software consists of voluntary contributions made by many
50 * individuals on behalf of the Apache Software Foundation, and was
51 * originally based on software copyright (c) 1999, International
52 * Business Machines, Inc., http://www.ibm.com .  For more information
53 * on the Apache Software Foundation, please see
54 * <http://www.apache.org/>.
55 */
56
57/*
58 * $Log: XSModelGroup.hpp,v $
59 * Revision 1.5  2003/12/01 23:23:26  neilg
60 * fix for bug 25118; thanks to Jeroen Witmond
61 *
62 * Revision 1.4  2003/11/21 17:29:53  knoaman
63 * PSVI update
64 *
65 * Revision 1.3  2003/11/14 22:47:53  neilg
66 * fix bogus log message from previous commit...
67 *
68 * Revision 1.2  2003/11/14 22:33:30  neilg
69 * Second phase of schema component model implementation. 
70 * Implement XSModel, XSNamespaceItem, and the plumbing necessary
71 * to connect them to the other components.
72 * Thanks to David Cargill.
73 *
74 * Revision 1.1  2003/09/16 14:33:36  neilg
75 * PSVI/schema component model classes, with Makefile/configuration changes necessary to build them
76 *
77 */
78
79#if !defined(XSMODELGROUP_HPP)
80#define XSMODELGROUP_HPP
81
82#include <xercesc/framework/psvi/XSObject.hpp>
83
84XERCES_CPP_NAMESPACE_BEGIN
85
86/**
87 * This class describes all properties of a Schema Model Group
88 * component.
89 * This is *always* owned by the validator /parser object from which
90 * it is obtained. 
91 */
92
93// forward declarations
94class XSAnnotation;
95class XSParticle;
96
97class XMLPARSER_EXPORT XSModelGroup : public XSObject
98{
99public:
100
101    // Content model compositors
102    enum COMPOSITOR_TYPE {
103            /**
104             * This constant value signifies a sequence operator.
105             */
106            COMPOSITOR_SEQUENCE       = 1,
107            /**
108             * This constant value signifies a choice operator.
109             */
110            COMPOSITOR_CHOICE         = 2,
111            /**
112             * This content model represents a simplified version of the SGML
113             * &amp;-Connector and is limited to the top-level of any content model.
114             * No element in the all content model may appear more than once.
115             */
116            COMPOSITOR_ALL            = 3
117    };
118       
119    //  Constructors and Destructor
120    // -----------------------------------------------------------------------
121    /** @name Constructors */
122    //@{
123
124    /**
125      * The default constructor
126      *
127      * @param  compositorType
128      * @param  particleList
129      * @param  annot
130      * @param  xsModel
131      * @param  manager     The configurable memory manager
132      */
133    XSModelGroup
134    (
135        COMPOSITOR_TYPE compositorType
136        , XSParticleList* const particleList
137        , XSAnnotation* const annot
138        , XSModel* const xsModel
139        , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
140    );
141
142    //@};
143
144    /** @name Destructor */
145    //@{
146    ~XSModelGroup();
147    //@}
148
149    //---------------------
150    /** @name XSModelGroup methods */
151    //@{
152
153    /**
154     * [compositor]: one of all, choice or sequence. The valid constants
155     * values are:
156     * <code>COMPOSITOR_SEQUENCE, COMPOSITOR_CHOICE, COMPOSITOR_ALL</code>.
157     */
158    COMPOSITOR_TYPE getCompositor() const;
159
160    /**
161     *  A list of [particles].
162     */
163    XSParticleList *getParticles() const;
164
165    /**
166     * Optional. An [annotation].
167     */
168    XSAnnotation *getAnnotation() const;
169
170    //@}
171
172    //----------------------------------
173    /** methods needed by implementation */
174
175    //@{
176
177    //@}
178private:
179
180    // -----------------------------------------------------------------------
181    //  Unimplemented constructors and operators
182    // -----------------------------------------------------------------------
183    XSModelGroup(const XSModelGroup&);
184    XSModelGroup & operator=(const XSModelGroup &);
185
186protected:
187
188    // -----------------------------------------------------------------------
189    //  data members
190    // -----------------------------------------------------------------------
191    COMPOSITOR_TYPE fCompositorType;
192    XSParticleList* fParticleList;
193    XSAnnotation*   fAnnotation;
194};
195
196inline XSModelGroup::COMPOSITOR_TYPE XSModelGroup::getCompositor() const
197{
198    return fCompositorType;
199}
200
201inline XSParticleList* XSModelGroup::getParticles() const
202{
203    return fParticleList;
204}
205
206inline XSAnnotation* XSModelGroup::getAnnotation() const
207{
208    return fAnnotation;
209}
210
211XERCES_CPP_NAMESPACE_END
212
213#endif
Note: See TracBrowser for help on using the repository browser.