http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Home

Readme
Download
Installation
Build

API Docs
Samples
Schema

FAQs
Programming
Migration

Releases
Bug-Reporting
Feedback

Y2K Compliance
PDF Document

CVS Repository
Mail Archive

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.2  2002/02/20 18:17:01  tng
00060  * [Bug 5977] Warnings on generating apiDocs.
00061  *
00062  * Revision 1.1.1.1  2002/02/01 22:22:08  peiyongz
00063  * sane_include
00064  *
00065  * Revision 1.6  2000/03/02 19:54:35  roddey
00066  * This checkin includes many changes done while waiting for the
00067  * 1.1.0 code to be finished. I can't list them all here, but a list is
00068  * available elsewhere.
00069  *
00070  * Revision 1.5  2000/02/24 20:12:55  abagchi
00071  * Swat for removing Log from API docs
00072  *
00073  * Revision 1.4  2000/02/12 03:31:55  rahulj
00074  * Removed duplicate CVS Log entries.
00075  *
00076  * Revision 1.3  2000/02/12 01:27:19  aruna1
00077  * Documentation updated
00078  *
00079  * Revision 1.2  2000/02/06 07:47:57  rahulj
00080  * Year 2K copyright swat.
00081  *
00082  * Revision 1.1.1.1  1999/11/09 01:07:45  twl
00083  * Initial checkin
00084  *
00085  * Revision 1.2  1999/11/08 20:45:00  rahul
00086  * Swat for adding in Product name and CVS comment log variable.
00087  *
00088  */
00089 
00090 
00091 #ifndef HANDLERBASE_HPP
00092 #define HANDLERBASE_HPP
00093 
00094 #include <xercesc/sax/DocumentHandler.hpp>
00095 #include <xercesc/sax/DTDHandler.hpp>
00096 #include <xercesc/sax/EntityResolver.hpp>
00097 #include <xercesc/sax/ErrorHandler.hpp>
00098 #include <xercesc/sax/SAXParseException.hpp>
00099 
00100 class Locator;
00101 class AttributeList;
00102 
00122 
00123 class  HandlerBase :
00124 
00125     public EntityResolver, public DTDHandler, public DocumentHandler
00126     , public ErrorHandler
00127 {
00128 public:
00131 
00146     virtual void characters
00147     (
00148         const   XMLCh* const    chars
00149         , const unsigned int    length
00150     );
00151 
00164     virtual void endDocument();
00165 
00179     virtual void endElement(const XMLCh* const name);
00180 
00196     virtual void ignorableWhitespace
00197     (
00198         const   XMLCh* const    chars
00199         , const unsigned int    length
00200     );
00201 
00217     virtual void processingInstruction
00218     (
00219         const   XMLCh* const    target
00220         , const XMLCh* const    data
00221     );
00222 
00228     virtual void resetDocument();
00230 
00232 
00234 
00245     virtual void setDocumentLocator(const Locator* const locator);
00246 
00259     virtual void startDocument();
00260 
00275     virtual void startElement
00276     (
00277         const   XMLCh* const    name
00278         ,       AttributeList&  attributes
00279     );
00280 
00282 
00284 
00286 
00305     virtual InputSource* resolveEntity
00306     (
00307         const   XMLCh* const    publicId
00308         , const XMLCh* const    systemId
00309     );
00310 
00312 
00315 
00329     virtual void error(const SAXParseException& exception);
00330 
00348     virtual void fatalError(const SAXParseException& exception);
00349 
00364     virtual void warning(const SAXParseException& exception);
00365 
00371     virtual void resetErrors();
00372 
00374 
00375 
00378 
00392     virtual void notationDecl
00393     (
00394         const   XMLCh* const    name
00395         , const XMLCh* const    publicId
00396         , const XMLCh* const    systemId
00397     );
00398 
00404     virtual void resetDocType();
00405 
00420     virtual void unparsedEntityDecl
00421     (
00422         const   XMLCh* const    name
00423         , const XMLCh* const    publicId
00424         , const XMLCh* const    systemId
00425         , const XMLCh* const    notationName
00426     );
00428 };
00429 
00430 
00431 // ---------------------------------------------------------------------------
00432 //  HandlerBase: Inline default implementations
00433 // ---------------------------------------------------------------------------
00434 inline void HandlerBase::characters(const   XMLCh* const    chars
00435                                     , const unsigned int    length)
00436 {
00437 }
00438 
00439 inline void HandlerBase::endDocument()
00440 {
00441 }
00442 
00443 inline void HandlerBase::endElement(const XMLCh* const name)
00444 {
00445 }
00446 
00447 inline void HandlerBase::error(const SAXParseException& exception)
00448 {
00449 }
00450 
00451 inline void HandlerBase::fatalError(const SAXParseException& exception)
00452 {
00453     throw exception;
00454 }
00455 
00456 inline void
00457 HandlerBase::ignorableWhitespace(   const   XMLCh* const chars
00458                                     , const unsigned int length)
00459 {
00460 }
00461 
00462 inline void HandlerBase::notationDecl(  const   XMLCh* const name
00463                                         , const XMLCh* const publicId
00464                                         , const XMLCh* const systemId)
00465 {
00466 }
00467 
00468 inline void
00469 HandlerBase::processingInstruction( const   XMLCh* const target
00470                                     , const XMLCh* const data)
00471 {
00472 }
00473 
00474 inline void HandlerBase::resetErrors()
00475 {
00476 }
00477 
00478 inline void HandlerBase::resetDocument()
00479 {
00480 }
00481 
00482 inline void HandlerBase::resetDocType()
00483 {
00484 }
00485 
00486 inline InputSource*
00487 HandlerBase::resolveEntity( const   XMLCh* const publicId
00488                             , const XMLCh* const systemId)
00489 {
00490     return 0;
00491 }
00492 
00493 inline void
00494 HandlerBase::unparsedEntityDecl(const   XMLCh* const name
00495                                 , const XMLCh* const publicId
00496                                 , const XMLCh* const systemId
00497                                 , const XMLCh* const notationName)
00498 {
00499 }
00500 
00501 inline void HandlerBase::setDocumentLocator(const Locator* const locator)
00502 {
00503 }
00504 
00505 inline void HandlerBase::startDocument()
00506 {
00507 }
00508 
00509 inline void
00510 HandlerBase::startElement(  const   XMLCh* const    name
00511                             ,       AttributeList&  attributes)
00512 {
00513 }
00514 
00515 inline void HandlerBase::warning(const SAXParseException& exception)
00516 {
00517 }
00518 
00519 #endif


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