EntityResolver.hpp
上传用户:zhuqijet
上传日期:2013-06-25
资源大小:10074k
文件大小:9k
源码类别:

词法分析

开发平台:

Visual 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: EntityResolver.hpp,v $
  58.  * Revision 1.4  2003/03/07 18:10:06  tng
  59.  * Return a reference instead of void for operator=
  60.  *
  61.  * Revision 1.3  2002/11/04 14:56:25  tng
  62.  * C++ Namespace Support.
  63.  *
  64.  * Revision 1.2  2002/06/06 20:39:16  tng
  65.  * Document Fix: document that the returned object from resolveEntity is owned by the parser
  66.  *
  67.  * Revision 1.1.1.1  2002/02/01 22:22:08  peiyongz
  68.  * sane_include
  69.  *
  70.  * Revision 1.6  2000/03/02 19:54:34  roddey
  71.  * This checkin includes many changes done while waiting for the
  72.  * 1.1.0 code to be finished. I can't list them all here, but a list is
  73.  * available elsewhere.
  74.  *
  75.  * Revision 1.5  2000/02/24 20:12:55  abagchi
  76.  * Swat for removing Log from API docs
  77.  *
  78.  * Revision 1.4  2000/02/12 03:31:55  rahulj
  79.  * Removed duplicate CVS Log entries.
  80.  *
  81.  * Revision 1.3  2000/02/12 01:27:19  aruna1
  82.  * Documentation updated
  83.  *
  84.  * Revision 1.2  2000/02/06 07:47:57  rahulj
  85.  * Year 2K copyright swat.
  86.  *
  87.  * Revision 1.1.1.1  1999/11/09 01:07:44  twl
  88.  * Initial checkin
  89.  *
  90.  * Revision 1.3  1999/11/08 20:44:56  rahul
  91.  * Swat for adding in Product name and CVS comment log variable.
  92.  *
  93.  */
  94. #ifndef ENTITYRESOLVER_HPP
  95. #define ENTITYRESOLVER_HPP
  96. #include <xercesc/util/XercesDefs.hpp>
  97. XERCES_CPP_NAMESPACE_BEGIN
  98. class InputSource;
  99. /**
  100.   * Basic interface for resolving entities.
  101.   *
  102.   * <p>If a SAX application needs to implement customized handling
  103.   * for external entities, it must implement this interface and
  104.   * register an instance with the SAX parser using the parser's
  105.   * setEntityResolver method.</p>
  106.   *
  107.   * <p>The parser will then allow the application to intercept any
  108.   * external entities (including the external DTD subset and external
  109.   * parameter entities, if any) before including them.</p>
  110.   *
  111.   * <p>Many SAX applications will not need to implement this interface,
  112.   * but it will be especially useful for applications that build
  113.   * XML documents from databases or other specialised input sources,
  114.   * or for applications that use URI types other than URLs.</p>
  115.   *
  116.   * <p>The following resolver would provide the application
  117.   * with a special character stream for the entity with the system
  118.   * identifier "http://www.myhost.com/today":</p>
  119.   *
  120.   *<pre>
  121.   *#include <xercesc/sax/EntityResolver.hpp>
  122.   *#include <xercesc/sax/InputSource.hpp>
  123.   *
  124.   *class MyResolver : public EntityResolver {
  125.   *  public:
  126.   *    InputSource resolveEntity (const XMLCh* const publicId,
  127.   *                               const XMLCh* const systemId);
  128.   *   ...
  129.   *   };
  130.   *
  131.   *  MyResolver::resolveEntity {
  132.   *    if (XMLString::compareString(systemId, "http://www.myhost.com/today")) {
  133.   *      MyReader* reader = new MyReader();
  134.   *      return new InputSource(reader);
  135.   *    } else {
  136.   *      return null;
  137.   *    }
  138.   *  }
  139.   *
  140.   *</pre>
  141.   *
  142.   * <p>The application can also use this interface to redirect system
  143.   * identifiers to local URIs or to look up replacements in a catalog
  144.   * (possibly by using the public identifier).</p>
  145.   *
  146.   * <p>The HandlerBase class implements the default behaviour for
  147.   * this interface, which is simply always to return null (to request
  148.   * that the parser use the default system identifier).</p>
  149.   *
  150.   * @see Parser#setEntityResolver
  151.   * @see InputSource#InputSource
  152.   * @see HandlerBase#HandlerBase
  153.   */
  154. class SAX_EXPORT EntityResolver
  155. {
  156. public:
  157.     /** @name Constructors and Destructor */
  158.     //@{
  159.     /** Default Constructor */
  160.     EntityResolver()
  161.     {
  162.     }
  163.     /** Destructor */
  164.     virtual ~EntityResolver()
  165.     {
  166.     }
  167.     //@}
  168.     /** @name The EntityResolver interface */
  169.     //@{
  170.   /**
  171.     * Allow the application to resolve external entities.
  172.     *
  173.     * <p>The Parser will call this method before opening any external
  174.     * entity except the top-level document entity (including the
  175.     * external DTD subset, external entities referenced within the
  176.     * DTD, and external entities referenced within the document
  177.     * element): the application may request that the parser resolve
  178.     * the entity itself, that it use an alternative URI, or that it
  179.     * use an entirely different input source.</p>
  180.     *
  181.     * <p>Application writers can use this method to redirect external
  182.     * system identifiers to secure and/or local URIs, to look up
  183.     * public identifiers in a catalogue, or to read an entity from a
  184.     * database or other input source (including, for example, a dialog
  185.     * box).</p>
  186.     *
  187.     * <p>If the system identifier is a URL, the SAX parser must
  188.     * resolve it fully before reporting it to the application.</p>
  189.     *
  190.     * @param publicId The public identifier of the external entity
  191.     *        being referenced, or null if none was supplied.
  192.     * @param systemId The system identifier of the external entity
  193.     *        being referenced.
  194.     * @return An InputSource object describing the new input source,
  195.     *         or null to request that the parser open a regular
  196.     *         URI connection to the system identifier.
  197.     *         The returned InputSource is owned by the parser which is
  198.     *         responsible to clean up the memory.
  199.     * @exception SAXException Any SAX exception, possibly
  200.     *            wrapping another exception.
  201.     * @exception IOException An IO exception,
  202.     *            possibly the result of creating a new InputStream
  203.     *            or Reader for the InputSource.
  204.     * @see InputSource#InputSource
  205.     */
  206.     virtual InputSource* resolveEntity
  207.     (
  208.         const   XMLCh* const    publicId
  209.         , const XMLCh* const    systemId
  210.     ) = 0;
  211.     //@}
  212. private :
  213.     /* Unimplemented constructors and operators */
  214.     /* Copy constructor */
  215.     EntityResolver(const EntityResolver&);
  216.     /* Assignment operator */
  217.     EntityResolver& operator=(const EntityResolver&);
  218. };
  219. XERCES_CPP_NAMESPACE_END
  220. #endif