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

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: ErrorHandler.hpp,v $
  58.  * Revision 1.6  2000/04/27 19:33:15  rahulj
  59.  * Included <util/XercesDefs.hpp> as suggested by David N Bertoni.
  60.  *
  61.  * Revision 1.5  2000/02/24 20:12:55  abagchi
  62.  * Swat for removing Log from API docs
  63.  *
  64.  * Revision 1.4  2000/02/12 03:31:55  rahulj
  65.  * Removed duplicate CVS Log entries.
  66.  *
  67.  * Revision 1.3  2000/02/12 01:27:19  aruna1
  68.  * Documentation updated
  69.  *
  70.  * Revision 1.2  2000/02/06 07:47:57  rahulj
  71.  * Year 2K copyright swat.
  72.  *
  73.  * Revision 1.1.1.1  1999/11/09 01:07:45  twl
  74.  * Initial checkin
  75.  *
  76.  * Revision 1.2  1999/11/08 20:45:00  rahul
  77.  * Swat for adding in Product name and CVS comment log variable.
  78.  *
  79.  */
  80. #ifndef ERRORHANDLER_HPP
  81. #define ERRORHANDLER_HPP
  82. #include <util/XercesDefs.hpp>
  83. class SAXParseException;
  84. /**
  85.   * Basic interface for SAX error handlers.
  86.   *
  87.   * <p>If a SAX application needs to implement customized error
  88.   * handling, it must implement this interface and then register an
  89.   * instance with the SAX parser using the parser's setErrorHandler
  90.   * method.  The parser will then report all errors and warnings
  91.   * through this interface.</p>
  92.   *
  93.   * <p> The parser shall use this interface instead of throwing an
  94.   * exception: it is up to the application whether to throw an
  95.   * exception for different types of errors and warnings.  Note,
  96.   * however, that there is no requirement that the parser continue to
  97.   * provide useful information after a call to fatalError (in other
  98.   * words, a SAX driver class could catch an exception and report a
  99.   * fatalError).</p>
  100.   *
  101.   * <p>The HandlerBase class provides a default implementation of this
  102.   * interface, ignoring warnings and recoverable errors and throwing a
  103.   * SAXParseException for fatal errors.  An application may extend
  104.   * that class rather than implementing the complete interface
  105.   * itself.</p>
  106.   *
  107.   * @see Parser#setErrorHandler
  108.   * @see SAXParseException#SAXParseException 
  109.   * @see HandlerBase#HandlerBase
  110.   */
  111. class SAX_EXPORT ErrorHandler
  112. {
  113. public:
  114.     /** @name Constructors and Destructor */
  115.     //@{
  116.     /** Default constructor */
  117.     ErrorHandler()
  118.     {
  119.     }
  120.     /** Desctructor */
  121.     virtual ~ErrorHandler()
  122.     {
  123.     }
  124.     //@}
  125.     /** @name The error handler interface */
  126.     //@{
  127.    /**
  128.     * Receive notification of a warning.
  129.     *
  130.     * <p>SAX parsers will use this method to report conditions that
  131.     * are not errors or fatal errors as defined by the XML 1.0
  132.     * recommendation.  The default behaviour is to take no action.</p>
  133.     *
  134.     * <p>The SAX parser must continue to provide normal parsing events
  135.     * after invoking this method: it should still be possible for the
  136.     * application to process the document through to the end.</p>
  137.     *
  138.     * @param exception The warning information encapsulated in a
  139.     *                  SAX parse exception.
  140.     * @exception SAXException Any SAX exception, possibly
  141.     *            wrapping another exception.
  142.     * @see SAXParseException#SAXParseException 
  143.     */
  144.     virtual void warning(const SAXParseException& exception) = 0;
  145.   /**
  146.     * Receive notification of a recoverable error.
  147.     *
  148.     * <p>This corresponds to the definition of "error" in section 1.2
  149.     * of the W3C XML 1.0 Recommendation.  For example, a validating
  150.     * parser would use this callback to report the violation of a
  151.     * validity constraint.  The default behaviour is to take no
  152.     * action.</p>
  153.     *
  154.     * <p>The SAX parser must continue to provide normal parsing events
  155.     * after invoking this method: it should still be possible for the
  156.     * application to process the document through to the end.  If the
  157.     * application cannot do so, then the parser should report a fatal
  158.     * error even if the XML 1.0 recommendation does not require it to
  159.     * do so.</p>
  160.     *
  161.     * @param exception The error information encapsulated in a
  162.     *                  SAX parse exception.
  163.     * @exception SAXException Any SAX exception, possibly
  164.     *            wrapping another exception.
  165.     * @see SAXParseException#SAXParseException 
  166.     */
  167.     virtual void error(const SAXParseException& exception) = 0;
  168.   /**
  169.     * Receive notification of a non-recoverable error.
  170.     *
  171.     * <p>This corresponds to the definition of "fatal error" in
  172.     * section 1.2 of the W3C XML 1.0 Recommendation.  For example, a
  173.     * parser would use this callback to report the violation of a
  174.     * well-formedness constraint.</p>
  175.     *
  176.     * <p>The application must assume that the document is unusable
  177.     * after the parser has invoked this method, and should continue
  178.     * (if at all) only for the sake of collecting addition error
  179.     * messages: in fact, SAX parsers are free to stop reporting any
  180.     * other events once this method has been invoked.</p>
  181.     *
  182.     * @param exception The error information encapsulated in a
  183.     *                  SAX parse exception.  
  184.     * @exception SAXException Any SAX exception, possibly
  185.     *            wrapping another exception.
  186.     * @see SAXParseException#SAXParseException
  187.     */
  188.     virtual void fatalError(const SAXParseException& exception) = 0;
  189.     
  190.     /**
  191.     * Reset the Error handler object on its reuse
  192.     *
  193.     * <p>This method helps in reseting the Error handler object
  194.     * implementational defaults each time the Error handler is begun.</p>
  195.     *
  196.     */
  197.     virtual void resetErrors() = 0;
  198.     //@}
  199. private :
  200.     /* Unimplemented constructors and operators */
  201.     
  202.     /* Copy constructor */
  203.     ErrorHandler(const ErrorHandler&);
  204.     /* Assignment operator */
  205.     void operator=(const ErrorHandler&);
  206.     
  207. };
  208. #endif