HandlerBase.hpp Source File

| 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.5  2002/11/04 14:56:25  tng
    00060  * C++ Namespace Support.
    00061  *
    00062  * Revision 1.4  2002/07/16 18:15:00  tng
    00063  * [Bug 6070] warning unused variable in HandlerBase.hpp
    00064  *
    00065  * Revision 1.3  2002/06/06 20:39:16  tng
    00066  * Document Fix: document that the returned object from resolveEntity is owned by the parser
    00067  *
    00068  * Revision 1.2  2002/02/20 18:17:01  tng
    00069  * [Bug 5977] Warnings on generating apiDocs.
    00070  *
    00071  * Revision 1.1.1.1  2002/02/01 22:22:08  peiyongz
    00072  * sane_include
    00073  *
    00074  * Revision 1.6  2000/03/02 19:54:35  roddey
    00075  * This checkin includes many changes done while waiting for the
    00076  * 1.1.0 code to be finished. I can't list them all here, but a list is
    00077  * available elsewhere.
    00078  *
    00079  * Revision 1.5  2000/02/24 20:12:55  abagchi
    00080  * Swat for removing Log from API docs
    00081  *
    00082  * Revision 1.4  2000/02/12 03:31:55  rahulj
    00083  * Removed duplicate CVS Log entries.
    00084  *
    00085  * Revision 1.3  2000/02/12 01:27:19  aruna1
    00086  * Documentation updated
    00087  *
    00088  * Revision 1.2  2000/02/06 07:47:57  rahulj
    00089  * Year 2K copyright swat.
    00090  *
    00091  * Revision 1.1.1.1  1999/11/09 01:07:45  twl
    00092  * Initial checkin
    00093  *
    00094  * Revision 1.2  1999/11/08 20:45:00  rahul
    00095  * Swat for adding in Product name and CVS comment log variable.
    00096  *
    00097  */
    00098
    00099
    00100 #ifndef HANDLERBASE_HPP
    00101 #define HANDLERBASE_HPP
    00102
    00103 #include <xercesc/sax/DocumentHandler.hpp>
    00104 #include <xercesc/sax/DTDHandler.hpp>
    00105 #include <xercesc/sax/EntityResolver.hpp>
    00106 #include <xercesc/sax/ErrorHandler.hpp>
    00107 #include <xercesc/sax/SAXParseException.hpp>
    00108
    00109 XERCES_CPP_NAMESPACE_BEGIN
    00110
    00111 class Locator;
    00112 class AttributeList;
    00113
    00134 class  HandlerBase :
    00135
    00136     public EntityResolver, public DTDHandler, public DocumentHandler
    00137     , public ErrorHandler
    00138 {
    00139 public:
    00157     virtual void characters
    00158     (
    00159         const   XMLCh* const    chars
    00160         , const unsigned int    length
    00161     );
    00162
    00175     virtual void endDocument();
    00176
    00190     virtual void endElement(const XMLCh* const name);
    00191
    00207     virtual void ignorableWhitespace
    00208     (
    00209         const   XMLCh* const    chars
    00210         , const unsigned int    length
    00211     );
    00212
    00228     virtual void processingInstruction
    00229     (
    00230         const   XMLCh* const    target
    00231         , const XMLCh* const    data
    00232     );
    00233
    00239     virtual void resetDocument();
    00241
    00256     virtual void setDocumentLocator(const Locator* const locator);
    00257
    00270     virtual void startDocument();
    00271
    00286     virtual void startElement
    00287     (
    00288         const   XMLCh* const    name
    00289         ,       AttributeList&  attributes
    00290     );
    00291
    00293
    00318     virtual InputSource* resolveEntity
    00319     (
    00320         const   XMLCh* const    publicId
    00321         , const XMLCh* const    systemId
    00322     );
    00323
    00325
    00342     virtual void error(const SAXParseException& exception);
    00343
    00361     virtual void fatalError(const SAXParseException& exception);
    00362
    00377     virtual void warning(const SAXParseException& exception);
    00378
    00384     virtual void resetErrors();
    00385
    00387
    00388
    00391
    00405     virtual void notationDecl
    00406     (
    00407         const   XMLCh* const    name
    00408         , const XMLCh* const    publicId
    00409         , const XMLCh* const    systemId
    00410     );
    00411
    00417     virtual void resetDocType();
    00418
    00433     virtual void unparsedEntityDecl
    00434     (
    00435         const   XMLCh* const    name
    00436         , const XMLCh* const    publicId
    00437         , const XMLCh* const    systemId
    00438         , const XMLCh* const    notationName
    00439     );
    00441 };
    00442
    00443
    00444 // ---------------------------------------------------------------------------
    00445 //  HandlerBase: Inline default implementations
    00446 // ---------------------------------------------------------------------------
    00447 inline void HandlerBase::characters(const   XMLCh* const
    00448                                     , const unsigned int)
    00449 {
    00450 }
    00451
    00452 inline void HandlerBase::endDocument()
    00453 {
    00454 }
    00455
    00456 inline void HandlerBase::endElement(const XMLCh* const)
    00457 {
    00458 }
    00459
    00460 inline void HandlerBase::error(const SAXParseException&)
    00461 {
    00462 }
    00463
    00464 inline void HandlerBase::fatalError(const SAXParseException& exception)
    00465 {
    00466     throw exception;
    00467 }
    00468
    00469 inline void
    00470 HandlerBase::ignorableWhitespace(   const   XMLCh* const
    00471                                     , const unsigned int)
    00472 {
    00473 }
    00474
    00475 inline void HandlerBase::notationDecl(  const   XMLCh* const
    00476                                         , const XMLCh* const
    00477                                         , const XMLCh* const)
    00478 {
    00479 }
    00480
    00481 inline void
    00482 HandlerBase::processingInstruction( const   XMLCh* const
    00483                                     , const XMLCh* const)
    00484 {
    00485 }
    00486
    00487 inline void HandlerBase::resetErrors()
    00488 {
    00489 }
    00490
    00491 inline void HandlerBase::resetDocument()
    00492 {
    00493 }
    00494
    00495 inline void HandlerBase::resetDocType()
    00496 {
    00497 }
    00498
    00499 inline InputSource*
    00500 HandlerBase::resolveEntity( const   XMLCh* const
    00501                             , const XMLCh* const)
    00502 {
    00503     return 0;
    00504 }
    00505
    00506 inline void
    00507 HandlerBase::unparsedEntityDecl(const   XMLCh* const
    00508                                 , const XMLCh* const
    00509                                 , const XMLCh* const
    00510                                 , const XMLCh* const)
    00511 {
    00512 }
    00513
    00514 inline void HandlerBase::setDocumentLocator(const Locator* const)
    00515 {
    00516 }
    00517
    00518 inline void HandlerBase::startDocument()
    00519 {
    00520 }
    00521
    00522 inline void
    00523 HandlerBase::startElement(  const   XMLCh* const
    00524                             ,       AttributeList&)
    00525 {
    00526 }
    00527
    00528 inline void HandlerBase::warning(const SAXParseException&)
    00529 {
    00530 }
    00531
    00532 XERCES_CPP_NAMESPACE_END
    00533
    00534 #endif

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