00001 /*---------------------------------------------------------------------* 00002 | Library QgarLib, graphics analysis and recognition | 00003 | Copyright (C) 2003 Qgar Project, LORIA | 00004 | | 00005 | This library is free software; you can redistribute it and/or | 00006 | modify it under the terms of the GNU Lesser General Public | 00007 | License version 2.1, as published by the Free Software Foundation. | 00008 | | 00009 | This library is distributed in the hope that it will be useful, | 00010 | but WITHOUT ANY WARRANTY; without even the implied warranty of | 00011 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | 00012 | See the GNU Lesser General Public License for more details. | 00013 | | 00014 | The GNU Lesser General Public License is included in the file | 00015 | LICENSE.LGPL, in the root directory of the Qgar packaging. See | 00016 | http://www.gnu.org/licenses/lgpl.html for the terms of the license. | 00017 | To receive a paper copy, write to the Free Software Foundation, | 00018 | Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. | 00019 | | 00020 | Contact Project Qgar for any information: | 00021 | LORIA - équipe Qgar | 00022 | B.P. 239, 54506 Vandoeuvre-lès-Nancy Cedex, France | 00023 | email: qgar-contact@loria.fr | 00024 | http://www.qgar.org/ | 00025 *---------------------------------------------------------------------*/ 00026 00027 00028 #ifndef __ENTITYRESOLVER_H_INCLUDED__ 00029 #define __ENTITYRESOLVER_H_INCLUDED__ 00030 00031 00032 /** 00033 * @file EntityResolver.H 00034 * @brief Header file of class qgxml::EntityResolver 00035 * 00036 * @author <a href="mailto:qgar-contact@loria.fr?subject=Qgar fwd Jan Rendek">Jan Rendek</a> 00037 * @date March 10, 2003 15:52 00038 * @since Qgar 2.1.1 00039 */ 00040 00041 00042 // For RCS/CVS use: Do not delete 00043 /* $Id: EntityResolver.H,v 1.6 2004/07/02 20:36:43 masini Exp $ */ 00044 00045 00046 #include <string> 00047 00048 namespace qgxml { 00049 00050 class InputSource; 00051 00052 /** 00053 * @class EntityResolver EntityResolver.H <qgarlib/sax/EntityResolver.H> 00054 * @ingroup XML 00055 * @brief Basic interface for resolving entities. 00056 * 00057 * <p> 00058 * If a SAX application needs to implement customized handling for 00059 * external entities, it must implement this interface and register an 00060 * instance with the SAX driver using the setEntityResolver method. 00061 * </p> 00062 * <p> 00063 * The XML reader will then allow the application to intercept any 00064 * external entities (including the external DTD subset and external 00065 * parameter entities, if any) before including them. 00066 * </p> 00067 * 00068 * <b> This class is an adaptation for C++ of the interface of the same 00069 * name implemented in the Java SAX API (http://www.saxproject.org). 00070 * </b> 00071 * 00072 * @author <a href="mailto:qgar-contact@loria.fr?subject=Qgar fwd Jan Rendek">Jan Rendek</a> (Adaptation). 00073 * @date March 10, 2003 15:52 00074 * @since Qgar 2.1.1 00075 */ 00076 class EntityResolver { 00077 00078 // ------------------------------------------------------------------- 00079 // P U B L I C M E M B E R S 00080 // ------------------------------------------------------------------- 00081 public: 00082 00083 00084 /** @name Destructors */ 00085 // =========== 00086 //@{ 00087 /** 00088 * @brief Destructor 00089 */ 00090 virtual ~EntityResolver() { } 00091 //@} 00092 00093 /** 00094 * @brief Allow the application to resolve external entities. 00095 * 00096 * @param publicId The public identifier of the external entity being 00097 * referenced. 00098 * @param systemId The system identifier of the external entity being 00099 * referenced. 00100 * 00101 * @return An InputSource object describing the new input source. 00102 */ 00103 virtual InputSource * resolveEntity(const std::string& publicId, 00104 const std::string& systemId) = 0; 00105 00106 00107 00108 // ------------------------------------------------------------------- 00109 00110 }; // class EntityResolver 00111 00112 } // namespace qgxml 00113 00114 00115 #endif /* __ENTITYRESOLVER_H_INCLUDED__ */