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  

XMLEntityHandler.hpp

Go to the documentation of this file.
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.6  2003/03/07 18:08:10  tng
00060   * Return a reference instead of void for operator=
00061   *
00062   * Revision 1.5  2002/11/04 15:00:21  tng
00063   * C++ Namespace Support.
00064   *
00065   * Revision 1.4  2002/06/06 20:41:51  tng
00066   * Regression fix: should assign the returned InputSource from resolveEntity to srcToFill.
00067   *
00068   * Revision 1.3  2002/05/31 15:14:07  tng
00069   * Fix doxygen documentation.
00070   *
00071   * Revision 1.2  2002/05/29 21:47:08  knoaman
00072   * DOM L3 LS: DOMInputSource, DOMEntityResolver, DOMImplementationLS and DOMBuilder
00073   *
00074   * Revision 1.1.1.1  2002/02/01 22:21:51  peiyongz
00075   * sane_include
00076   *
00077   * Revision 1.7  2000/03/02 19:54:25  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.6  2000/02/24 20:00:23  abagchi
00083   * Swat for removing Log from API docs
00084   *
00085   * Revision 1.5  2000/02/16 21:42:58  aruna1
00086   * API Doc++ summary changes in
00087   *
00088   * Revision 1.4  2000/02/15 01:21:31  roddey
00089   * Some initial documentation improvements. More to come...
00090   *
00091   * Revision 1.3  2000/02/06 07:47:48  rahulj
00092   * Year 2K copyright swat.
00093   *
00094   * Revision 1.2  1999/12/15 19:46:28  roddey
00095   * Got rid of redundant 'const' on bool return value. Some compilers choke on this
00096   * and its not useful anyway.
00097   *
00098   * Revision 1.1.1.1  1999/11/09 01:08:33  twl
00099   * Initial checkin
00100   *
00101   * Revision 1.2  1999/11/08 20:44:38  rahul
00102   * Swat for adding in Product name and CVS comment log variable.
00103   *
00104   */
00105 
00106 
00107 #if !defined(XMLENTITYHANDLER_HPP)
00108 #define XMLENTITYHANDLER_HPP
00109 
00110 #include <xercesc/util/XercesDefs.hpp>
00111 
00112 XERCES_CPP_NAMESPACE_BEGIN
00113 
00114 class InputSource;
00115 class XMLBuffer;
00116 
00117 
00128 class  XMLEntityHandler
00129 {
00130 public:
00131     // -----------------------------------------------------------------------
00132     //  Constructors are hidden, only the virtual destructor is exposed
00133     // -----------------------------------------------------------------------
00134 
00137 
00141     virtual ~XMLEntityHandler()
00142     {
00143     }
00145 
00146 
00147     // -----------------------------------------------------------------------
00148     //  The virtual entity handler interface
00149     // -----------------------------------------------------------------------
00152 
00159     virtual void endInputSource(const InputSource& inputSource) = 0;
00160 
00172     virtual bool expandSystemId
00173     (
00174         const   XMLCh* const    systemId
00175         ,       XMLBuffer&      toFill
00176     ) = 0;
00177 
00183     virtual void resetEntities() = 0;
00184 
00202     virtual InputSource* resolveEntity
00203     (
00204         const   XMLCh* const    publicId
00205         , const XMLCh* const    systemId
00206         , const XMLCh* const    baseURI = 0
00207     ) = 0;
00208 
00215     virtual void startInputSource(const InputSource& inputSource) = 0;
00217 
00218 
00219 protected :
00220     // -----------------------------------------------------------------------
00221     //  Hidden Constructors
00222     // -----------------------------------------------------------------------
00225 
00229     XMLEntityHandler()
00230     {
00231     }
00233 
00234 
00235 
00236 private:
00237     // -----------------------------------------------------------------------
00238     //  Unimplemented constructors and destructor
00239     // -----------------------------------------------------------------------
00240     XMLEntityHandler(const XMLEntityHandler&);
00241     XMLEntityHandler& operator=(const XMLEntityHandler&);
00242 };
00243 
00244 XERCES_CPP_NAMESPACE_END
00245 
00246 #endif


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