XMLContentModel.hpp Source File

00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 1999-2001 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: XMLContentModel.hpp,v $
00059  * Revision 1.11  2001/05/28 20:53:35  tng
00060  * Schema: move static data gInvalidTrans, gEOCFakeId, gEpsilonFakeId to XMLContentModel for others to access
00061  *
00062  * Revision 1.10  2001/05/11 13:25:31  tng
00063  * Copyright update.
00064  *
00065  * Revision 1.9  2001/05/03 21:02:23  tng
00066  * Schema: Add SubstitutionGroupComparator and update exception messages.  By Pei Yong Zhang.
00067  *
00068  * Revision 1.8  2001/04/19 18:16:50  tng
00069  * Schema: SchemaValidator update, and use QName in Content Model
00070  *
00071  * Revision 1.7  2001/03/21 21:56:01  tng
00072  * Schema: Add Schema Grammar, Schema Validator, and split the DTDValidator into DTDValidator, DTDScanner, and DTDGrammar.
00073  *
00074  * Revision 1.6  2001/02/27 14:48:30  tng
00075  * Schema: Add CMAny and ContentLeafNameTypeVector, by Pei Yong Zhang
00076  *
00077  * Revision 1.5  2000/03/02 19:54:24  roddey
00078  * This checkin includes many changes done while waiting for the
00079  * 1.1.0 code to be finished. I can't list them all here, but a list is
00080  * available elsewhere.
00081  *
00082  * Revision 1.4  2000/02/24 20:00:23  abagchi
00083  * Swat for removing Log from API docs
00084  *
00085  * Revision 1.3  2000/02/15 01:21:30  roddey
00086  * Some initial documentation improvements. More to come...
00087  *
00088  * Revision 1.2  2000/02/06 07:47:48  rahulj
00089  * Year 2K copyright swat.
00090  *
00091  * Revision 1.1.1.1  1999/11/09 01:08:30  twl
00092  * Initial checkin
00093  *
00094  * Revision 1.2  1999/11/08 20:44:37  rahul
00095  * Swat for adding in Product name and CVS comment log variable.
00096  *
00097  */
00098 
00099 
00100 #if !defined(CONTENTMODEL_HPP)
00101 #define CONTENTMODEL_HPP
00102 
00103 #include <util/XercesDefs.hpp>
00104 #include <util/RefVectorOf.hpp>
00105 #include <util/QName.hpp>
00106 
00107 class ContentLeafNameTypeVector;
00108 class GrammarResolver;
00109 class XMLStringPool;
00110 
00120 class  XMLContentModel
00121 {
00122 public:
00123     // ---------------------------------------------------------------------------
00124     //  Public static data
00125     //
00126     //  gInvalidTrans
00127     //      This value represents an invalid transition in each line of the
00128     //      transition table.
00129     //
00130     //  gEOCFakeId
00131     //  gEpsilonFakeId
00132     //      We have to put in a couple of special CMLeaf nodes to represent
00133     //      special values, using fake element ids that we know won't conflict
00134     //      with real element ids.
00135     //
00136     //
00137     // ---------------------------------------------------------------------------
00138     static const unsigned int   gInvalidTrans;
00139     static const unsigned int   gEOCFakeId;
00140     static const unsigned int   gEpsilonFakeId;
00141 
00142     // -----------------------------------------------------------------------
00143     //  Constructors are hidden, only the virtual Destructor is exposed
00144     // -----------------------------------------------------------------------
00147     virtual ~XMLContentModel()
00148     {
00149     }
00151 
00152 
00153     // -----------------------------------------------------------------------
00154     //  The virtual content model interface provided by derived classes
00155     // -----------------------------------------------------------------------
00156     virtual int validateContent
00157     (
00158         QName** const         children
00159       , const unsigned int    childCount
00160       , const unsigned int    emptyNamespaceId
00161     ) const = 0;
00162 
00163     virtual int validateContentSpecial
00164     (
00165         QName** const           children
00166       , const unsigned int      childCount
00167       , const unsigned int      emptyNamespaceId
00168       , GrammarResolver*  const pGrammarResolver
00169       , XMLStringPool*    const pStringPool
00170     ) const =0;
00171 
00172     virtual ContentLeafNameTypeVector* getContentLeafNameTypeVector()
00173       const = 0;
00174 
00175 protected :
00176     // -----------------------------------------------------------------------
00177     //  Hidden Constructors
00178     // -----------------------------------------------------------------------
00179     XMLContentModel()
00180     {
00181     }
00182 
00183 
00184 private :
00185     // -----------------------------------------------------------------------
00186     //  Unimplemented constructors and operators
00187     // -----------------------------------------------------------------------
00188     XMLContentModel(const XMLContentModel&);
00189     void operator=(const XMLContentModel&);
00190 };
00191 
00192 #endif