00001 /*
00002 * The Apache Software License, Version 1.1
00003 *
00004 * Copyright (c) 1999-2000 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: XMLEntityHandler.hpp,v $
00059 * Revision 1.7 2000/03/02 19:54:25 roddey
00060 * This checkin includes many changes done while waiting for the
00061 * 1.1.0 code to be finished. I can't list them all here, but a list is
00062 * available elsewhere.
00063 *
00064 * Revision 1.6 2000/02/24 20:00:23 abagchi
00065 * Swat for removing Log from API docs
00066 *
00067 * Revision 1.5 2000/02/16 21:42:58 aruna1
00068 * API Doc++ summary changes in
00069 *
00070 * Revision 1.4 2000/02/15 01:21:31 roddey
00071 * Some initial documentation improvements. More to come...
00072 *
00073 * Revision 1.3 2000/02/06 07:47:48 rahulj
00074 * Year 2K copyright swat.
00075 *
00076 * Revision 1.2 1999/12/15 19:46:28 roddey
00077 * Got rid of redundant 'const' on bool return value. Some compilers choke on this
00078 * and its not useful anyway.
00079 *
00080 * Revision 1.1.1.1 1999/11/09 01:08:33 twl
00081 * Initial checkin
00082 *
00083 * Revision 1.2 1999/11/08 20:44:38 rahul
00084 * Swat for adding in Product name and CVS comment log variable.
00085 *
00086 */
00087
00088
00089 #if !defined(XMLENTITYHANDLER_HPP)
00090 #define XMLENTITYHANDLER_HPP
00091
00092 #include <util/XercesDefs.hpp>
00093
00094 class InputSource;
00095 class XMLBuffer;
00096
00097
00108 class XMLEntityHandler
00109 {
00110 public:
00111 // -----------------------------------------------------------------------
00112 // Constructors are hidden, only the virtual destructor is exposed
00113 // -----------------------------------------------------------------------
00114
00116 //@{
00117
00121 virtual ~XMLEntityHandler()
00122 {
00123 }
00124 //@}
00125
00126
00127 // -----------------------------------------------------------------------
00128 // The virtual entity handler interface
00129 // -----------------------------------------------------------------------
00131 //@{
00132
00139 virtual void endInputSource(const InputSource& inputSource) = 0;
00140
00152 virtual bool expandSystemId
00153 (
00154 const XMLCh* const systemId
00155 , XMLBuffer& toFill
00156 ) = 0;
00157
00163 virtual void resetEntities() = 0;
00164
00173 virtual InputSource* resolveEntity
00174 (
00175 const XMLCh* const publicId
00176 , const XMLCh* const systemId
00177 ) = 0;
00178
00185 virtual void startInputSource(const InputSource& inputSource) = 0;
00186 //@}
00187
00188
00189 protected :
00190 // -----------------------------------------------------------------------
00191 // Hidden Constructors
00192 // -----------------------------------------------------------------------
00194 //@{
00195
00199 XMLEntityHandler()
00200 {
00201 }
00202 //@}
00203
00204
00205
00206 private:
00207 // -----------------------------------------------------------------------
00208 // Unimplemented constructors and destructor
00209 // -----------------------------------------------------------------------
00210 XMLEntityHandler(const XMLEntityHandler&);
00211 void operator=(const XMLEntityHandler&);
00212 };
00213
00214 #endif