XMLEntityHandler.hpp
上传用户:huihehuasu
上传日期:2007-01-10
资源大小:6948k
文件大小:7k
源码类别:

xml/soap/webservice

开发平台:

C/C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  * 
  4.  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  * 
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  * 
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer. 
  13.  * 
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  * 
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:  
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  * 
  26.  * 4. The names "Xerces" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written 
  29.  *    permission, please contact apache@apache.org.
  30.  * 
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  * 
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  * 
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation, and was
  51.  * originally based on software copyright (c) 1999, International
  52.  * Business Machines, Inc., http://www.ibm.com .  For more information
  53.  * on the Apache Software Foundation, please see
  54.  * <http://www.apache.org/>.
  55.  */
  56.  /*
  57.   * $Log: XMLEntityHandler.hpp,v $
  58.   * Revision 1.7  2000/03/02 19:54:25  roddey
  59.   * This checkin includes many changes done while waiting for the
  60.   * 1.1.0 code to be finished. I can't list them all here, but a list is
  61.   * available elsewhere.
  62.   *
  63.   * Revision 1.6  2000/02/24 20:00:23  abagchi
  64.   * Swat for removing Log from API docs
  65.   *
  66.   * Revision 1.5  2000/02/16 21:42:58  aruna1
  67.   * API Doc++ summary changes in
  68.   *
  69.   * Revision 1.4  2000/02/15 01:21:31  roddey
  70.   * Some initial documentation improvements. More to come...
  71.   *
  72.   * Revision 1.3  2000/02/06 07:47:48  rahulj
  73.   * Year 2K copyright swat.
  74.   *
  75.   * Revision 1.2  1999/12/15 19:46:28  roddey
  76.   * Got rid of redundant 'const' on bool return value. Some compilers choke on this
  77.   * and its not useful anyway.
  78.   *
  79.   * Revision 1.1.1.1  1999/11/09 01:08:33  twl
  80.   * Initial checkin
  81.   *
  82.   * Revision 1.2  1999/11/08 20:44:38  rahul
  83.   * Swat for adding in Product name and CVS comment log variable.
  84.   *
  85.   */
  86. #if !defined(XMLENTITYHANDLER_HPP)
  87. #define XMLENTITYHANDLER_HPP
  88. #include <util/XercesDefs.hpp>
  89. class InputSource;
  90. class XMLBuffer;
  91. /**
  92.  *  This abstract class is a callback mechanism for the scanner. By creating
  93.  *  a derivative of this class and plugging into the scanner, the scanner
  94.  *  will call back on the object's methods to entity events.
  95.  *
  96.  *  This class is primarily for use by those writing their own parser classes.
  97.  *  If you use the standard parser classes, DOMParser and SAXParser, you won't
  98.  *  use this API. You will instead use a similar mechanism defined by the SAX
  99.  *  API, called EntityResolver.
  100.  */
  101. class XMLPARSER_EXPORT XMLEntityHandler
  102. {
  103. public:
  104.     // -----------------------------------------------------------------------
  105.     //  Constructors are hidden, only the virtual destructor is exposed
  106.     // -----------------------------------------------------------------------
  107.     /** @name Destructor */
  108.     //@{
  109.     
  110.     /**
  111.       * Default destructor
  112.       */
  113.     virtual ~XMLEntityHandler()
  114.     {
  115.     }
  116.     //@}
  117.     // -----------------------------------------------------------------------
  118.     //  The virtual entity handler interface
  119.     // -----------------------------------------------------------------------
  120.     /** @name The pure virtual methods in this interface. */
  121.     //@{
  122.     /**
  123.       * This method get called after the scanner has finished reading from
  124.       * the given input source while processing external entity references.
  125.       *
  126.       * @param inputSource The input source for the entity
  127.       */
  128.     virtual void endInputSource(const InputSource& inputSource) = 0;
  129.     /**
  130.       * This method allows the passes the scanned systemId to the entity
  131.       * handler, thereby giving it a chance to provide any customized
  132.       * handling like resolving relative path names. The scanner first
  133.       * calls this method before calling <code>resolveEntity</code>.
  134.       *
  135.       * @param systemId The system id extracted by the scanner from the
  136.       *                 input source.
  137.       * @param toFill The buffer in which the fully expanded system id needs
  138.       *               to be stored.
  139.       */
  140.     virtual bool expandSystemId
  141.     (
  142.         const   XMLCh* const    systemId
  143.         ,       XMLBuffer&      toFill
  144.     ) = 0;
  145.     /**
  146.       * This method allows the entity handler to reset itself, so that
  147.       * it can be used again. It is called prior to a new document parse
  148.       * operation.
  149.       */
  150.     virtual void resetEntities() = 0;
  151.     /**
  152.       * This method allows the entity handler to provide customized
  153.       * application specific entity resolution. This method is defined
  154.       * by SAX 1.0 API.
  155.       *
  156.       * @param systemId The system id of the external entity reference. 
  157.       * @param publicId The public id of the external entity reference.
  158.       */
  159.     virtual InputSource* resolveEntity
  160.     (
  161.         const   XMLCh* const    publicId
  162.         , const XMLCh* const    systemId
  163.     ) = 0;
  164.     /**
  165.       * This method will be called before the scanner starts reading
  166.       * from an input source while processing external entity references.
  167.       *
  168.       * @param inputSource The external input source.
  169.       */
  170.     virtual void startInputSource(const InputSource& inputSource) = 0;
  171.     //@}
  172. protected :
  173.     // -----------------------------------------------------------------------
  174.     //  Hidden Constructors
  175.     // -----------------------------------------------------------------------
  176.     /** @name Constructor */
  177.     //@{
  178.     
  179.     /**
  180.       * Protected default constructor
  181.       */
  182.     XMLEntityHandler()
  183.     {
  184.     }
  185.     //@}
  186. private:
  187.     // -----------------------------------------------------------------------
  188.     //  Unimplemented constructors and destructor
  189.     // -----------------------------------------------------------------------
  190.     XMLEntityHandler(const XMLEntityHandler&);
  191.     void operator=(const XMLEntityHandler&);
  192. };
  193. #endif