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

xml/soap/webservice

开发平台:

C/C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999-2001 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: XMLErrorReporter.hpp,v $
  58.   * Revision 1.11  2001/05/11 13:25:32  tng
  59.   * Copyright update.
  60.   *
  61.   * Revision 1.10  2001/05/03 19:08:56  knoaman
  62.   * Support Warning/Error/FatalError messaging.
  63.   * Validity constraints errors are treated as errors, with the ability by user to set
  64.   * validity constraints as fatal errors.
  65.   *
  66.   * Revision 1.9  2000/12/14 18:49:57  tng
  67.   * Fix API document generation warning: "Warning: end of member group without matching begin"
  68.   *
  69.   * Revision 1.8  2000/03/02 19:54:25  roddey
  70.   * This checkin includes many changes done while waiting for the
  71.   * 1.1.0 code to be finished. I can't list them all here, but a list is
  72.   * available elsewhere.
  73.   *
  74.   * Revision 1.7  2000/02/24 20:00:23  abagchi
  75.   * Swat for removing Log from API docs
  76.   *
  77.   * Revision 1.6  2000/02/16 23:03:48  roddey
  78.   * More documentation updates
  79.   *
  80.   * Revision 1.5  2000/02/16 21:42:58  aruna1
  81.   * API Doc++ summary changes in
  82.   *
  83.   * Revision 1.4  2000/02/15 23:59:07  roddey
  84.   * More updated documentation of Framework classes.
  85.   *
  86.   * Revision 1.3  2000/02/15 01:21:31  roddey
  87.   * Some initial documentation improvements. More to come...
  88.   *
  89.   * Revision 1.2  2000/02/06 07:47:48  rahulj
  90.   * Year 2K copyright swat.
  91.   *
  92.   * Revision 1.1.1.1  1999/11/09 01:08:34  twl
  93.   * Initial checkin
  94.   *
  95.   * Revision 1.2  1999/11/08 20:44:39  rahul
  96.   * Swat for adding in Product name and CVS comment log variable.
  97.   *
  98.   */
  99. #if !defined(XMLERRORREPORTER_HPP)
  100. #define XMLERRORREPORTER_HPP
  101. #include <util/XercesDefs.hpp>
  102. #include <util/XMLMsgLoader.hpp>
  103. /**
  104.  *  This abstract class defines a callback mechanism for the scanner. By
  105.  *  creating a class that implements this interface and plugging an instance
  106.  *  of that class into the scanner, the scanner will call back on the object's
  107.  *  virtual methods to report error events. This class is also used with the
  108.  *  validator, to allow it to report errors.
  109.  *
  110.  *  This class is primarily for use by those writing their own parser classes.
  111.  *  If you use the standard parser classes, DOMParser and SAXParser, you won't
  112.  *  use this API. You will instead use a similar mechanism defined by the SAX
  113.  *  API, called ErrorHandler.
  114.  */
  115. class XMLPARSER_EXPORT XMLErrorReporter
  116. {
  117. public:
  118.     // -----------------------------------------------------------------------
  119.     //  The types of errors we can issue
  120.     // -----------------------------------------------------------------------
  121.     enum ErrTypes
  122.     {
  123.         ErrType_Warning
  124.         , ErrType_Error
  125.         , ErrType_Fatal
  126.         , ErrTypes_Unknown
  127.     };
  128.     // -----------------------------------------------------------------------
  129.     //  Constructors are hidden, only the virtual destructor is exposed
  130.     // -----------------------------------------------------------------------
  131.     /** @name Destructor */
  132.     //@{
  133.     /**
  134.       *   Default destructor
  135.       */
  136.     virtual ~XMLErrorReporter()
  137.     {
  138.     }
  139.     //@}
  140.     // -----------------------------------------------------------------------
  141.     //  The error handler interface
  142.     // -----------------------------------------------------------------------
  143.     /** @name Error Handler interface */
  144.     //@{
  145.     /** Called to report errors from the scanner or validator
  146.       *
  147.       * This method is called back on by the scanner or validator (or any other
  148.       * internal parser component which might need to report an error in the
  149.       * future.) It contains all the information that the client code might
  150.       * need to report or log the error.
  151.       *
  152.       * @param  errCode     The error code of the error being reported. What
  153.       *                     this means is dependent on the domain it is from.
  154.       *
  155.       * @param  errDomain   The domain from which the error occured. The domain
  156.       *                     is a means of providing a hierarchical layering to
  157.       *                     the error system, so that a single set of error id
  158.       *                     numbers don't have to be split up.
  159.       *
  160.       * @param  type        The error type, which is defined mostly by XML which
  161.       *                     categorizes errors into warning, errors and validity
  162.       *                     constraints.
  163.       *
  164.       * @param  errorText   The actual text of the error. This is translatable,
  165.       *                     so can possibly be in the local language if a
  166.       *                     translation has been provided.
  167.       *
  168.       * @param  sysetmId    The system id of the entity where the error occured,
  169.       *                     fully qualified.
  170.       *
  171.       * @param  publicId    The optional public id of the entity were the error
  172.       *                     occured. It can be an empty string if non was provided.
  173.       *
  174.       * @param  lineNum     The line number within the source XML of the error.
  175.       *
  176.       * @param  colNum      The column number within the source XML of the error.
  177.       *                     Because of the parsing style, this is usually just
  178.       *                     after the actual offending text.
  179.       */
  180.     virtual void error
  181.     (
  182.         const   unsigned int        errCode
  183.         , const XMLCh* const        errDomain
  184.         , const ErrTypes            type
  185.         , const XMLCh* const        errorText
  186.         , const XMLCh* const        systemId
  187.         , const XMLCh* const        publicId
  188.         , const unsigned int        lineNum
  189.         , const unsigned int        colNum
  190.     ) = 0;
  191.     /** Called before a new parse event to allow the handler to reset
  192.       *
  193.       * This method is called by the scanner before a new parse event is
  194.       * about to start. It gives the error handler a chance to reset its
  195.       * internal state.
  196.       */
  197.     virtual void resetErrors() = 0;
  198.     //@}
  199. protected :
  200.     /** @name Constructor */
  201.     //@{
  202.     /**
  203.       *   Default constructor
  204.       */
  205.     XMLErrorReporter()
  206.     {
  207.     }
  208.     //@}
  209. private:
  210.     // -----------------------------------------------------------------------
  211.     //  Unimplemented constructors and destructor
  212.     // -----------------------------------------------------------------------
  213.     XMLErrorReporter(const XMLErrorReporter&);
  214.     void operator=(const XMLErrorReporter&);
  215. };
  216. #endif