LexicalHandler.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: LexicalHandler.hpp,v $
  58.  * Revision 1.1  2000/12/22 15:17:04  tng
  59.  * SAX2-ext's LexicalHandler support added by David Bertoni.
  60.  *
  61.  *
  62.  */
  63. #ifndef LEXICALHANDLER_HPP
  64. #define LEXICALHANDLER_HPP
  65. #include <util/XercesDefs.hpp>
  66. /**
  67.   * Receive notification of lexical events.
  68.   *
  69.   * <p>This is an extension handler for that provides lexical information
  70.   * about an XML document.  It does not provide information about document
  71.   * content.  For those events, an application must register an instance of
  72.   * a ContentHandler.</p>
  73.   *
  74.   * <p>The order of events in this interface is very important, and
  75.   * mirrors the order of information in the document itself.  For
  76.   * example, startDTD() and endDTD() events will occur before the
  77.   * first element in the document.</p>
  78.   *
  79.   * @see SAX2XMLReader#setLexicalHandler
  80.   * @see SAX2XMLReader#setContentHandler
  81.   */
  82. class SAX2_EXPORT LexicalHandler
  83. {
  84. public:
  85.     /** @name Constructors and Destructor */
  86.     //@{
  87.     /** Default constructor */
  88.     LexicalHandler()
  89.     {
  90.     }
  91.     /** Destructor */
  92.     virtual ~LexicalHandler()
  93.     {
  94.     }
  95.     //@}
  96.     /** @name The virtual document handler interface */
  97.     
  98.     //@{
  99.    /**
  100.     * Receive notification of comments.
  101.     *
  102.     * <p>The Parser will call this method to report each occurence of
  103.     * a comment in the XML document.</p>
  104.     *
  105.     * <p>The application must not attempt to read from the array
  106.     * outside of the specified range.</p>
  107.     *
  108.     * @param chars The characters from the XML document.
  109.     * @param length The number of characters to read from the array.
  110.     * @exception SAXException Any SAX exception, possibly
  111.     *            wrapping another exception.
  112.     */
  113.     virtual void comment
  114.     (
  115.         const   XMLCh* const    chars
  116.         , const unsigned int    length
  117.     ) = 0;
  118.   /**
  119.     * Receive notification of the end of a CDATA section.
  120.     *
  121.     * <p>The SAX parser will invoke this method at the end of
  122.     * each CDATA parsed.</p>
  123.     *
  124.     * @exception SAXException Any SAX exception, possibly
  125.     *            wrapping another exception.
  126.     */
  127.     virtual void endCDATA () = 0;
  128.   /**
  129.     * Receive notification of the end of the DTD declarations.
  130.     *
  131.     * <p>The SAX parser will invoke this method at the end of the
  132.     * DTD</p>
  133.     *
  134.     * @exception SAXException Any SAX exception, possibly
  135.     *            wrapping another exception.
  136.     */
  137.     virtual void endDTD () = 0;
  138.   /**
  139.     * Receive notification of the end of an entity.
  140.     *
  141.     * <p>The SAX parser will invoke this method at the end of an
  142.     * entity</p>
  143.     *
  144.     * @param name The name of the entity that is ending.
  145.     * @exception SAXException Any SAX exception, possibly
  146.     *            wrapping another exception.
  147.     */
  148.     virtual void endEntity (const XMLCh* const name) = 0;
  149.   /**
  150.     * Receive notification of the start of a CDATA section.
  151.     *
  152.     * <p>The SAX parser will invoke this method at the start of
  153.     * each CDATA parsed.</p>
  154.     *
  155.     * @exception SAXException Any SAX exception, possibly
  156.     *            wrapping another exception.
  157.     */
  158.     virtual void startCDATA () = 0;
  159.   /**
  160.     * Receive notification of the start of the DTD declarations.
  161.     *
  162.     * <p>The SAX parser will invoke this method at the start of the
  163.     * DTD</p>
  164.     *
  165.     * @param name The document type name.
  166.     * @param publicId The declared public identifier for the external DTD subset, or null if none was declared.
  167.     * @param systemId The declared system identifier for the external DTD subset, or null if none was declared.
  168.     * @exception SAXException Any SAX exception, possibly
  169.     *            wrapping another exception.
  170.     */
  171.     virtual void startDTD
  172.     (
  173.         const   XMLCh* const    name
  174.         , const   XMLCh* const    publicId
  175.         , const   XMLCh* const    systemId
  176.     ) = 0;
  177.   /**
  178.     * Receive notification of the start of an entity.
  179.     *
  180.     * <p>The SAX parser will invoke this method at the start of an
  181.     * entity</p>
  182.     *
  183.     * @param name The name of the entity that is starting.
  184.     * @exception SAXException Any SAX exception, possibly
  185.     *            wrapping another exception.
  186.     */
  187.     virtual void startEntity (const XMLCh* const name) = 0;
  188.     //@}
  189. private :
  190.     /* Unimplemented Constructors and operators */
  191.     /* Copy constructor */
  192.     LexicalHandler(const LexicalHandler&);
  193.     /** Assignment operator */
  194.     void operator=(const LexicalHandler&);
  195. };
  196. #endif