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  

XMLSchemaDescription.hpp

Go to the documentation of this 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: XMLSchemaDescription.hpp,v $
00059  * Revision 1.3  2003/10/14 15:17:47  peiyongz
00060  * Implementation of Serialization/Deserialization
00061  *
00062  * Revision 1.2  2003/07/31 17:03:19  peiyongz
00063  * locationHint incrementally added
00064  *
00065  * Revision 1.1  2003/06/20 18:37:39  peiyongz
00066  * Stateless Grammar Pool :: Part I
00067  *
00068  * $Id: XMLSchemaDescription.hpp,v 1.3 2003/10/14 15:17:47 peiyongz Exp $
00069  *
00070  */
00071 
00072 #if !defined(XMLSCHEMADESCRIPTION_HPP)
00073 #define XMLSCHEMADESCRIPTION_HPP
00074 
00075 #include <xercesc/framework/XMLGrammarDescription.hpp>
00076 #include <xercesc/util/RefArrayVectorOf.hpp>
00077 
00078 XERCES_CPP_NAMESPACE_BEGIN
00079 
00080 typedef const XMLCh* const LocationHint;
00081 
00082 class  XMLSchemaDescription : public XMLGrammarDescription
00083 {
00084 public :
00085     // -----------------------------------------------------------------------
00087     // -----------------------------------------------------------------------
00089 
00093     virtual ~XMLSchemaDescription();
00095 
00096     // -----------------------------------------------------------------------
00098     // -----------------------------------------------------------------------
00100 
00104     virtual Grammar::GrammarType   getGrammarType() const
00105     {
00106         return Grammar::SchemaGrammarType;
00107     }
00109 
00110     // -----------------------------------------------------------------------
00112     // -----------------------------------------------------------------------
00114 
00115     enum ContextType 
00116          {
00117             CONTEXT_INCLUDE,
00118             CONTEXT_REDEFINE,
00119             CONTEXT_IMPORT,
00120             CONTEXT_PREPARSE,
00121             CONTEXT_INSTANCE,
00122             CONTEXT_ELEMENT,
00123             CONTEXT_ATTRIBUTE,
00124             CONTEXT_XSITYPE,
00125             CONTEXT_UNKNOWN
00126          };
00127 
00132     virtual ContextType                getContextType() const = 0;
00133 
00138     virtual const XMLCh*               getTargetNamespace() const = 0;
00139 
00144     virtual RefArrayVectorOf<XMLCh>*   getLocationHints() const = 0;
00145 
00150     virtual const QName*               getTriggeringComponent() const = 0;
00151 
00156     virtual const QName*               getEnclosingElementName() const = 0;
00157 
00162     virtual const XMLAttDef*           getAttributes() const = 0;
00163 
00168     virtual void                       setContextType(ContextType) = 0;
00169 
00174     virtual void                       setTargetNamespace(const XMLCh* const) = 0;
00175 
00180     virtual void                       setLocationHints(const XMLCh* const) = 0;
00181 
00186     virtual void                       setTriggeringComponent(QName* const) = 0;
00187 
00192     virtual void                       setEnclosingElementName(QName* const) = 0;
00193 
00198     virtual void                       setAttributes(XMLAttDef* const) = 0;
00200               
00201     /***
00202      * Support for Serialization/De-serialization
00203      ***/
00204     DECL_XSERIALIZABLE(XMLSchemaDescription)
00205 
00206 protected :
00207     // -----------------------------------------------------------------------
00209     // -----------------------------------------------------------------------
00211     XMLSchemaDescription(MemoryManager* const memMgr = XMLPlatformUtils::fgMemoryManager);
00213 
00214 private :
00215     // -----------------------------------------------------------------------
00217     // -----------------------------------------------------------------------
00219     XMLSchemaDescription(const XMLSchemaDescription& );
00220     XMLSchemaDescription& operator=(const XMLSchemaDescription& );
00222 
00223 };
00224 
00225 
00226 XERCES_CPP_NAMESPACE_END
00227 
00228 #endif


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