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  

InputSource.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: InputSource.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.10  2001/11/21 16:14:32  tng
00066  * Schema: New method InputSource::get/setIssueFatalErrorIfNotFound to tell the parser whether to issue fatal error or not if cannot find it (the InputSource).  This is required for schema processing as it shouldn't be a fatal error if the schema is not found.
00067  *
00068  * Revision 1.9  2000/03/02 19:54:35  roddey
00069  * This checkin includes many changes done while waiting for the
00070  * 1.1.0 code to be finished. I can't list them all here, but a list is
00071  * available elsewhere.
00072  *
00073  * Revision 1.8  2000/02/24 20:12:55  abagchi
00074  * Swat for removing Log from API docs
00075  *
00076  * Revision 1.7  2000/02/12 03:42:21  rahulj
00077  * Fixed DOC++ documentation formatting errors.
00078  *
00079  * Revision 1.6  2000/02/12 03:31:55  rahulj
00080  * Removed duplicate CVS Log entries.
00081  *
00082  * Revision 1.5  2000/02/12 01:27:19  aruna1
00083  * Documentation updated
00084  *
00085  * Revision 1.4  2000/02/09 02:15:28  abagchi
00086  * Documented destructor
00087  *
00088  * Revision 1.3  2000/02/06 07:47:58  rahulj
00089  * Year 2K copyright swat.
00090  *
00091  * Revision 1.2  2000/01/12 00:15:39  roddey
00092  * Changes to deal with multiply nested, relative pathed, entities and to deal
00093  * with the new URL class changes.
00094  *
00095  * Revision 1.1.1.1  1999/11/09 01:07:46  twl
00096  * Initial checkin
00097  *
00098  * Revision 1.2  1999/11/08 20:45:01  rahul
00099  * Swat for adding in Product name and CVS comment log variable.
00100  *
00101  */
00102 
00103 
00104 #ifndef INPUTSOURCE_HPP
00105 #define INPUTSOURCE_HPP
00106 
00107 #include <xercesc/util/XercesDefs.hpp>
00108 
00109 class BinInputStream;
00110 
00111 
00142 class  InputSource
00143 {
00144 public:
00145     // -----------------------------------------------------------------------
00146     //  All constructors are hidden, just the destructor is available
00147     // -----------------------------------------------------------------------
00150 
00154     virtual ~InputSource();
00156 
00157 
00158     // -----------------------------------------------------------------------
00161 
00171     virtual BinInputStream* makeStream() const = 0;
00172 
00174 
00175 
00176     // -----------------------------------------------------------------------
00179 
00188     const XMLCh* getEncoding() const;
00189 
00190 
00197     const XMLCh* getPublicId() const;
00198 
00199 
00208     const XMLCh* getSystemId() const;
00209 
00218     const bool getIssueFatalErrorIfNotFound() const;
00219 
00221 
00222 
00223     // -----------------------------------------------------------------------
00226 
00238     void setEncoding(const XMLCh* const encodingStr);
00239 
00240 
00252     void setPublicId(const XMLCh* const publicId);
00253 
00270     void setSystemId(const XMLCh* const systemId);
00271 
00281     void setIssueFatalErrorIfNotFound(const bool flag);
00282 
00284 
00285 
00286 protected :
00287     // -----------------------------------------------------------------------
00288     //  Hidden constructors
00289     // -----------------------------------------------------------------------
00292     /** Default constructor */
00293     InputSource();
00294 
00298     InputSource(const XMLCh* const systemId);
00299 
00304     InputSource
00305     (
00306         const   XMLCh* const    systemId
00307         , const XMLCh* const    publicId
00308     );
00309 
00313     InputSource(const char* const systemId);
00314 
00319     InputSource
00320     (
00321         const   char* const systemId
00322         , const char* const publicId
00323     );
00324 
00326 
00327 
00328 
00329 
00330 
00331 private:
00332     // -----------------------------------------------------------------------
00333     //  Unimplemented constructors and operators
00334     // -----------------------------------------------------------------------
00335     InputSource(const InputSource&);
00336     void operator=(const InputSource&);
00337 
00338 
00339     // -----------------------------------------------------------------------
00340     //  Private data members
00341     //
00342     //  fEncoding
00343     //      This is the encoding to use. Usually this is null, which means
00344     //      to use the information found in the file itself. But, if set,
00345     //      this encoding will be used without question.
00346     //
00347     //  fPublicId
00348     //      This is the optional public id for the input source. It can be
00349     //      null if none is desired.
00350     //
00351     //  fSystemId
00352     //      This is the system id for the input source. This is what is
00353     //      actually used to open the source.
00354     //
00355     //  fFatalErrorIfNotFound
00356     // -----------------------------------------------------------------------
00357     XMLCh*  fEncoding;
00358     XMLCh*  fPublicId;
00359     XMLCh*  fSystemId;
00360     bool    fFatalErrorIfNotFound;
00361 };
00362 
00363 
00364 // ---------------------------------------------------------------------------
00365 //  InputSource: Getter methods
00366 // ---------------------------------------------------------------------------
00367 inline const XMLCh* InputSource::getEncoding() const
00368 {
00369     return fEncoding;
00370 }
00371 
00372 inline const XMLCh* InputSource::getPublicId() const
00373 {
00374     return fPublicId;
00375 }
00376 
00377 inline const XMLCh* InputSource::getSystemId() const
00378 {
00379     return fSystemId;
00380 }
00381 
00382 inline const bool InputSource::getIssueFatalErrorIfNotFound() const
00383 {
00384     return fFatalErrorIfNotFound;
00385 }
00386 
00387 // ---------------------------------------------------------------------------
00388 //  InputSource: Setter methods
00389 // ---------------------------------------------------------------------------
00390 inline void InputSource::setIssueFatalErrorIfNotFound(const bool flag)
00391 {
00392     fFatalErrorIfNotFound = flag;
00393 }
00394 
00395 #endif


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