XMLErrorReporter.hpp Source File

00001 /*
00002  * The Apache Software License, Version 1.1

00003  * 

00004  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights

00005  * reserved.

00006  * 

00007  * Redistribution and use in source and binary forms, with or without

00008  * modification, are permitted provided that the following conditions

00009  * are met:

00010  * 

00011  * 1. Redistributions of source code must retain the above copyright

00012  *    notice, this list of conditions and the following disclaimer. 

00013  * 

00014  * 2. Redistributions in binary form must reproduce the above copyright

00015  *    notice, this list of conditions and the following disclaimer in

00016  *    the documentation and/or other materials provided with the

00017  *    distribution.

00018  * 

00019  * 3. The end-user documentation included with the redistribution,

00020  *    if any, must include the following acknowledgment:  

00021  *       "This product includes software developed by the

00022  *        Apache Software Foundation (http://www.apache.org/)."

00023  *    Alternately, this acknowledgment may appear in the software itself,

00024  *    if and wherever such third-party acknowledgments normally appear.

00025  * 

00026  * 4. The names "Xerces" and "Apache Software Foundation" must

00027  *    not be used to endorse or promote products derived from this

00028  *    software without prior written permission. For written 

00029  *    permission, please contact apache\@apache.org.

00030  * 

00031  * 5. Products derived from this software may not be called "Apache",

00032  *    nor may "Apache" appear in their name, without prior written

00033  *    permission of the Apache Software Foundation.

00034  * 

00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED

00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES

00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR

00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT

00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

00046  * SUCH DAMAGE.

00047  * ====================================================================

00048  * 

00049  * This software consists of voluntary contributions made by many

00050  * individuals on behalf of the Apache Software Foundation, and was

00051  * originally based on software copyright (c) 1999, International

00052  * Business Machines, Inc., http://www.ibm.com .  For more information

00053  * on the Apache Software Foundation, please see

00054  * <http://www.apache.org/>.

00055  */
00056 
00057  /*
00058   * $Log: XMLErrorReporter.hpp,v $

00059   * Revision 1.9  2000/12/14 18:49:57  tng

00060   * Fix API document generation warning: "Warning: end of member group without matching begin"

00061   *
00062   * Revision 1.8  2000/03/02 19:54:25  roddey

00063   * This checkin includes many changes done while waiting for the

00064   * 1.1.0 code to be finished. I can't list them all here, but a list is

00065   * available elsewhere.

00066   *
00067   * Revision 1.7  2000/02/24 20:00:23  abagchi

00068   * Swat for removing Log from API docs

00069   *
00070   * Revision 1.6  2000/02/16 23:03:48  roddey

00071   * More documentation updates

00072   *
00073   * Revision 1.5  2000/02/16 21:42:58  aruna1

00074   * API Doc++ summary changes in

00075   *
00076   * Revision 1.4  2000/02/15 23:59:07  roddey

00077   * More updated documentation of Framework classes.

00078   *
00079   * Revision 1.3  2000/02/15 01:21:31  roddey

00080   * Some initial documentation improvements. More to come...

00081   *
00082   * Revision 1.2  2000/02/06 07:47:48  rahulj

00083   * Year 2K copyright swat.

00084   *
00085   * Revision 1.1.1.1  1999/11/09 01:08:34  twl

00086   * Initial checkin

00087   *
00088   * Revision 1.2  1999/11/08 20:44:39  rahul

00089   * Swat for adding in Product name and CVS comment log variable.

00090   *
00091   */
00092 
00093 
00094 #if !defined(XMLERRORREPORTER_HPP)
00095 #define XMLERRORREPORTER_HPP
00096 
00097 #include <util/XercesDefs.hpp>
00098 #include <util/XMLMsgLoader.hpp>
00099 
00100 
00113 class  XMLErrorReporter
00114 {
00115 public:
00116     // -----------------------------------------------------------------------
00117     //  The types of errors we can issue
00118     // -----------------------------------------------------------------------
00119     enum ErrTypes
00120     {
00121         ErrType_Warning
00122         , ErrType_Invalid
00123         , ErrType_Fatal
00124 
00125         , ErrTypes_Unknown
00126     };
00127 
00128 
00129     // -----------------------------------------------------------------------
00130     //  Constructors are hidden, only the virtual destructor is exposed
00131     // -----------------------------------------------------------------------
00132 
00135 
00139     virtual ~XMLErrorReporter()

00140     {
00141     }
00143 
00144 
00145     // -----------------------------------------------------------------------
00146     //  The error handler interface
00147     // -----------------------------------------------------------------------
00148 
00151 
00187     virtual void error
00188     (
00189         const   unsigned int        errCode
00190         , const XMLCh* const        errDomain
00191         , const ErrTypes            type
00192         , const XMLCh* const        errorText
00193         , const XMLCh* const        systemId
00194         , const XMLCh* const        publicId
00195         , const unsigned int        lineNum
00196         , const unsigned int        colNum
00197     ) = 0;
00198 
00205     virtual void resetErrors() = 0;
00206 
00208 
00209 
00210 protected :
00211         
00214 
00218     XMLErrorReporter()

00219     {
00220     }
00222 
00223 private:
00224     // -----------------------------------------------------------------------
00225     //  Unimplemented constructors and destructor
00226     // -----------------------------------------------------------------------
00227     XMLErrorReporter(const XMLErrorReporter&);
00228     void operator=(const XMLErrorReporter&);
00229 };
00230 
00231 #endif