| API Docs for SAX and DOM |

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

# HandlerBase.hpp

Go to the documentation of this 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: HandlerBase.hpp,v $
    00059  * Revision 1.4  2002/07/16 18:15:00  tng
    00060  * [Bug 6070] warning unused variable in HandlerBase.hpp
    00061  *
    00062  * Revision 1.3  2002/06/06 20:39:16  tng
    00063  * Document Fix: document that the returned object from resolveEntity is owned by the parser
    00064  *
    00065  * Revision 1.2  2002/02/20 18:17:01  tng
    00066  * [Bug 5977] Warnings on generating apiDocs.
    00067  *
    00068  * Revision 1.1.1.1  2002/02/01 22:22:08  peiyongz
    00069  * sane_include
    00070  *
    00071  * Revision 1.6  2000/03/02 19:54:35  roddey
    00072  * This checkin includes many changes done while waiting for the
    00073  * 1.1.0 code to be finished. I can't list them all here, but a list is
    00074  * available elsewhere.
    00075  *
    00076  * Revision 1.5  2000/02/24 20:12:55  abagchi
    00077  * Swat for removing Log from API docs
    00078  *
    00079  * Revision 1.4  2000/02/12 03:31:55  rahulj
    00080  * Removed duplicate CVS Log entries.
    00081  *
    00082  * Revision 1.3  2000/02/12 01:27:19  aruna1
    00083  * Documentation updated
    00084  *
    00085  * Revision 1.2  2000/02/06 07:47:57  rahulj
    00086  * Year 2K copyright swat.
    00087  *
    00088  * Revision 1.1.1.1  1999/11/09 01:07:45  twl
    00089  * Initial checkin
    00090  *
    00091  * Revision 1.2  1999/11/08 20:45:00  rahul
    00092  * Swat for adding in Product name and CVS comment log variable.
    00093  *
    00094  */
    00095
    00096
    00097 #ifndef HANDLERBASE_HPP
    00098 #define HANDLERBASE_HPP
    00099
    00100 #include <xercesc/sax/DocumentHandler.hpp>
    00101 #include <xercesc/sax/DTDHandler.hpp>
    00102 #include <xercesc/sax/EntityResolver.hpp>
    00103 #include <xercesc/sax/ErrorHandler.hpp>
    00104 #include <xercesc/sax/SAXParseException.hpp>
    00105
    00106 class Locator;
    00107 class AttributeList;
    00108
    00128
    00129 class  HandlerBase :
    00130
    00131     public EntityResolver, public DTDHandler, public DocumentHandler
    00132     , public ErrorHandler
    00133 {
    00134 public:
    00137
    00152     virtual void characters
    00153     (
    00154         const   XMLCh* const    chars
    00155         , const unsigned int    length
    00156     );
    00157
    00170     virtual void endDocument();
    00171
    00185     virtual void endElement(const XMLCh* const name);
    00186
    00202     virtual void ignorableWhitespace
    00203     (
    00204         const   XMLCh* const    chars
    00205         , const unsigned int    length
    00206     );
    00207
    00223     virtual void processingInstruction
    00224     (
    00225         const   XMLCh* const    target
    00226         , const XMLCh* const    data
    00227     );
    00228
    00234     virtual void resetDocument();
    00236
    00238
    00240
    00251     virtual void setDocumentLocator(const Locator* const locator);
    00252
    00265     virtual void startDocument();
    00266
    00281     virtual void startElement
    00282     (
    00283         const   XMLCh* const    name
    00284         ,       AttributeList&  attributes
    00285     );
    00286
    00288
    00290
    00292
    00313     virtual InputSource* resolveEntity
    00314     (
    00315         const   XMLCh* const    publicId
    00316         , const XMLCh* const    systemId
    00317     );
    00318
    00320
    00323
    00337     virtual void error(const SAXParseException& exception);
    00338
    00356     virtual void fatalError(const SAXParseException& exception);
    00357
    00372     virtual void warning(const SAXParseException& exception);
    00373
    00379     virtual void resetErrors();
    00380
    00382
    00383
    00386
    00400     virtual void notationDecl
    00401     (
    00402         const   XMLCh* const    name
    00403         , const XMLCh* const    publicId
    00404         , const XMLCh* const    systemId
    00405     );
    00406
    00412     virtual void resetDocType();
    00413
    00428     virtual void unparsedEntityDecl
    00429     (
    00430         const   XMLCh* const    name
    00431         , const XMLCh* const    publicId
    00432         , const XMLCh* const    systemId
    00433         , const XMLCh* const    notationName
    00434     );
    00436 };
    00437
    00438
    00439 // ---------------------------------------------------------------------------
    00440 //  HandlerBase: Inline default implementations
    00441 // ---------------------------------------------------------------------------
    00442 inline void HandlerBase::characters(const   XMLCh* const
    00443                                     , const unsigned int)
    00444 {
    00445 }
    00446
    00447 inline void HandlerBase::endDocument()
    00448 {
    00449 }
    00450
    00451 inline void HandlerBase::endElement(const XMLCh* const)
    00452 {
    00453 }
    00454
    00455 inline void HandlerBase::error(const SAXParseException&)
    00456 {
    00457 }
    00458
    00459 inline void HandlerBase::fatalError(const SAXParseException& exception)
    00460 {
    00461     throw exception;
    00462 }
    00463
    00464 inline void
    00465 HandlerBase::ignorableWhitespace(   const   XMLCh* const
    00466                                     , const unsigned int)
    00467 {
    00468 }
    00469
    00470 inline void HandlerBase::notationDecl(  const   XMLCh* const
    00471                                         , const XMLCh* const
    00472                                         , const XMLCh* const)
    00473 {
    00474 }
    00475
    00476 inline void
    00477 HandlerBase::processingInstruction( const   XMLCh* const
    00478                                     , const XMLCh* const)
    00479 {
    00480 }
    00481
    00482 inline void HandlerBase::resetErrors()
    00483 {
    00484 }
    00485
    00486 inline void HandlerBase::resetDocument()
    00487 {
    00488 }
    00489
    00490 inline void HandlerBase::resetDocType()
    00491 {
    00492 }
    00493
    00494 inline InputSource*
    00495 HandlerBase::resolveEntity( const   XMLCh* const
    00496                             , const XMLCh* const)
    00497 {
    00498     return 0;
    00499 }
    00500
    00501 inline void
    00502 HandlerBase::unparsedEntityDecl(const   XMLCh* const
    00503                                 , const XMLCh* const
    00504                                 , const XMLCh* const
    00505                                 , const XMLCh* const)
    00506 {
    00507 }
    00508
    00509 inline void HandlerBase::setDocumentLocator(const Locator* const)
    00510 {
    00511 }
    00512
    00513 inline void HandlerBase::startDocument()
    00514 {
    00515 }
    00516
    00517 inline void
    00518 HandlerBase::startElement(  const   XMLCh* const
    00519                             ,       AttributeList&)
    00520 {
    00521 }
    00522
    00523 inline void HandlerBase::warning(const SAXParseException&)
    00524 {
    00525 }
    00526
    00527 #endif

Copyright © 2000 The Apache Software Foundation. All Rights Reserved.