DTDHandler.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: DTDHandler.hpp,v $
  58.  * Revision 1.5  2000/02/24 20:12:54  abagchi
  59.  * Swat for removing Log from API docs
  60.  *
  61.  * Revision 1.4  2000/02/12 03:31:55  rahulj
  62.  * Removed duplicate CVS Log entries.
  63.  *
  64.  * Revision 1.3  2000/02/12 01:27:19  aruna1
  65.  * Documentation updated
  66.  *
  67.  * Revision 1.2  2000/02/06 07:47:57  rahulj
  68.  * Year 2K copyright swat.
  69.  *
  70.  * Revision 1.1.1.1  1999/11/09 01:07:44  twl
  71.  * Initial checkin
  72.  *
  73.  * Revision 1.2  1999/11/08 20:44:54  rahul
  74.  * Swat for adding in Product name and CVS comment log variable.
  75.  *
  76.  */
  77. #ifndef DTDHANDLER_HPP
  78. #define DTDHANDLER_HPP
  79. /**
  80.   * Receive notification of basic DTD-related events.
  81.   *
  82.   * <p>If a SAX application needs information about notations and
  83.   * unparsed entities, then the application implements this 
  84.   * interface and registers an instance with the SAX parser using 
  85.   * the parser's setDTDHandler method.  The parser uses the 
  86.   * instance to report notation and unparsed entity declarations to 
  87.   * the application.</p>
  88.   *
  89.   * <p>The SAX parser may report these events in any order, regardless
  90.   * of the order in which the notations and unparsed entities were
  91.   * declared; however, all DTD events must be reported after the
  92.   * document handler's startDocument event, and before the first
  93.   * startElement event.</p>
  94.   *
  95.   * <p>It is up to the application to store the information for 
  96.   * future use (perhaps in a hash table or object tree).
  97.   * If the application encounters attributes of type "NOTATION",
  98.   * "ENTITY", or "ENTITIES", it can use the information that it
  99.   * obtained through this interface to find the entity and/or
  100.   * notation corresponding with the attribute value.</p>
  101.   *
  102.   * <p>The HandlerBase class provides a default implementation
  103.   * of this interface, which simply ignores the events.</p>
  104.   *
  105.   * @see Parser#setDTDHandler
  106.   * @see HandlerBase#HandlerBase
  107.   */
  108. class SAX_EXPORT DTDHandler
  109. {
  110. public:
  111.     /** @name Constructors and Destructor */
  112.     //@{
  113.     /** Default Constructor */
  114.     DTDHandler()
  115.     {
  116.     }
  117.     
  118.     /** Destructor */
  119.     virtual ~DTDHandler()
  120.     {
  121.     }
  122.     //@}
  123.     /** @name The DTD handler interface */
  124.     //@{
  125.   /**
  126.     * Receive notification of a notation declaration event.
  127.     *
  128.     * <p>It is up to the application to record the notation for later
  129.     * reference, if necessary.</p>
  130.     *
  131.     * <p>If a system identifier is present, and it is a URL, the SAX
  132.     * parser must resolve it fully before passing it to the
  133.     * application.</p>
  134.     *
  135.     * @param name The notation name.
  136.     * @param publicId The notation's public identifier, or null if
  137.     *        none was given.
  138.     * @param systemId The notation's system identifier, or null if
  139.     *        none was given.
  140.     * @exception SAXException Any SAX exception, possibly
  141.     *            wrapping another exception.
  142.     * @see #unparsedEntityDecl
  143.     * @see AttributeList#AttributeList
  144.     */
  145. virtual void notationDecl
  146.     (
  147.         const   XMLCh* const    name
  148.         , const XMLCh* const    publicId
  149.         , const XMLCh* const    systemId
  150.     ) = 0;
  151.   /**
  152.     * Receive notification of an unparsed entity declaration event.
  153.     *
  154.     * <p>Note that the notation name corresponds to a notation
  155.     * reported by the notationDecl() event.  It is up to the
  156.     * application to record the entity for later reference, if
  157.     * necessary.</p>
  158.     *
  159.     * <p>If the system identifier is a URL, the parser must resolve it
  160.     * fully before passing it to the application.</p>
  161.     *
  162.     * @exception SAXException Any SAX exception, possibly
  163.     *            wrapping another exception.
  164.     * @param name The unparsed entity's name.
  165.     * @param publicId The entity's public identifier, or null if none
  166.     *        was given.
  167.     * @param systemId The entity's system identifier (it must always
  168.     *        have one).
  169.     * @param notation name The name of the associated notation.
  170.     * @see #notationDecl
  171.     * @see AttributeList#AttributeList
  172.     */
  173.     virtual void unparsedEntityDecl
  174.     (
  175.         const   XMLCh* const    name
  176.         , const XMLCh* const    publicId
  177.         , const XMLCh* const    systemId
  178.         , const XMLCh* const    notationName
  179.     ) = 0;
  180.     /**
  181.     * Reset the DocType object on its reuse
  182.     *
  183.     * <p>This method helps in reseting the DTD object implementational
  184.     * defaults each time the DTD is begun.</p>
  185.     *
  186.     */
  187.     virtual void resetDocType() = 0;
  188.     //@}
  189. private :
  190.     /* Unimplemented constructors and operators */
  191.     
  192.     /* Copy constructor */
  193.     DTDHandler(const DTDHandler&);
  194.     /* Assignment operator */
  195.     void operator=(const DTDHandler&);
  196.     
  197. };
  198. #endif