XMLGrammarDescription.hpp Source File

00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 1999-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: XMLGrammarDescription.hpp,v $
00059  * Revision 1.2  2003/10/14 15:17:47  peiyongz
00060  * Implementation of Serialization/Deserialization
00061  *
00062  * Revision 1.1  2003/06/20 18:37:39  peiyongz
00063  * Stateless Grammar Pool :: Part I
00064  *
00065  * $Id: XMLGrammarDescription.hpp,v 1.2 2003/10/14 15:17:47 peiyongz Exp $
00066  *
00067  */
00068 
00069 #if !defined(XMLGRAMMARDESCRIPTION_HPP)
00070 #define XMLGRAMMARDESCRIPTION_HPP
00071 
00072 #include <xercesc/util/XMemory.hpp>
00073 #include <xercesc/validators/common/Grammar.hpp>
00074 
00075 #include <xercesc/internal/XSerializable.hpp>
00076 
00077 XERCES_CPP_NAMESPACE_BEGIN
00078 
00079 class  XMLGrammarDescription : public XSerializable, public XMemory
00080 {
00081 public :
00082     // -----------------------------------------------------------------------
00084     // -----------------------------------------------------------------------
00086 
00090     virtual ~XMLGrammarDescription();
00092 
00093     // -----------------------------------------------------------------------
00095     // -----------------------------------------------------------------------
00097 
00101     virtual Grammar::GrammarType   getGrammarType() const = 0;
00102     
00107     virtual const XMLCh*           getGrammarKey() const = 0;    
00109     
00110     inline MemoryManager*          getMemoryManager() const;
00111 
00112     /***
00113      * Support for Serialization/De-serialization
00114      ***/
00115     DECL_XSERIALIZABLE(XMLGrammarDescription)
00116 
00117 protected :
00118     // -----------------------------------------------------------------------
00120     // -----------------------------------------------------------------------
00122     XMLGrammarDescription(MemoryManager* const memMgr = XMLPlatformUtils::fgMemoryManager);
00124 
00125 private :
00126     // -----------------------------------------------------------------------
00128     // -----------------------------------------------------------------------
00130     XMLGrammarDescription(const XMLGrammarDescription& );
00131     XMLGrammarDescription& operator=(const XMLGrammarDescription& );
00133 
00134     // -----------------------------------------------------------------------
00135     //
00136     // fMemMgr: plugged-in (or defaulted-in) memory manager, 
00137     //          not owned 
00138     //          no reset after initialization
00139     //          allow derivatives to access directly
00140     //
00141     // -----------------------------------------------------------------------    
00142     MemoryManager* const  fMemMgr;     
00143 };
00144 
00145 inline MemoryManager* XMLGrammarDescription::getMemoryManager() const
00146 {
00147     return fMemMgr;
00148 }
00149 
00150 XERCES_CPP_NAMESPACE_END
00151 
00152 #endif