| 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.4  2002/11/04 14:56:26  tng
    00060  * C++ Namespace Support.
    00061  *
    00062  * Revision 1.3  2002/09/30 18:26:18  tng
    00063  * Since the derived class Wrapper4DOMInputSource has overwritten the set/getEncoding, SystemId, PublicId ... etc., these functions has to be virtual for them to work.
    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.10  2001/11/21 16:14:32  tng
    00072  * 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.
    00073  *
    00074  * Revision 1.9  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.8  2000/02/24 20:12:55  abagchi
    00080  * Swat for removing Log from API docs
    00081  *
    00082  * Revision 1.7  2000/02/12 03:42:21  rahulj
    00083  * Fixed DOC++ documentation formatting errors.
    00084  *
    00085  * Revision 1.6  2000/02/12 03:31:55  rahulj
    00086  * Removed duplicate CVS Log entries.
    00087  *
    00088  * Revision 1.5  2000/02/12 01:27:19  aruna1
    00089  * Documentation updated
    00090  *
    00091  * Revision 1.4  2000/02/09 02:15:28  abagchi
    00092  * Documented destructor
    00093  *
    00094  * Revision 1.3  2000/02/06 07:47:58  rahulj
    00095  * Year 2K copyright swat.
    00096  *
    00097  * Revision 1.2  2000/01/12 00:15:39  roddey
    00098  * Changes to deal with multiply nested, relative pathed, entities and to deal
    00099  * with the new URL class changes.
    00100  *
    00101  * Revision 1.1.1.1  1999/11/09 01:07:46  twl
    00102  * Initial checkin
    00103  *
    00104  * Revision 1.2  1999/11/08 20:45:01  rahul
    00105  * Swat for adding in Product name and CVS comment log variable.
    00106  *
    00107  */
    00108
    00109
    00110 #ifndef INPUTSOURCE_HPP
    00111 #define INPUTSOURCE_HPP
    00112
    00113 #include <xercesc/util/XercesDefs.hpp>
    00114
    00115 XERCES_CPP_NAMESPACE_BEGIN
    00116
    00117 class BinInputStream;
    00118
    00119
    00150 class  InputSource
    00151 {
    00152 public:
    00153     // -----------------------------------------------------------------------
    00154     //  All constructors are hidden, just the destructor is available
    00155     // -----------------------------------------------------------------------
    00162     virtual ~InputSource();
    00164
    00165
    00166     // -----------------------------------------------------------------------
    00179     virtual BinInputStream* makeStream() const = 0;
    00180
    00182
    00183
    00184     // -----------------------------------------------------------------------
    00196     virtual const XMLCh* getEncoding() const;
    00197
    00198
    00205     virtual const XMLCh* getPublicId() const;
    00206
    00207
    00216     virtual const XMLCh* getSystemId() const;
    00217
    00226     virtual const bool getIssueFatalErrorIfNotFound() const;
    00227
    00229
    00230
    00231     // -----------------------------------------------------------------------
    00234
    00246     virtual void setEncoding(const XMLCh* const encodingStr);
    00247
    00248
    00260     virtual void setPublicId(const XMLCh* const publicId);
    00261
    00278     virtual void setSystemId(const XMLCh* const systemId);
    00279
    00289     virtual void setIssueFatalErrorIfNotFound(const bool flag);
    00290
    00292
    00293
    00294 protected :
    00295     // -----------------------------------------------------------------------
    00296     //  Hidden constructors
    00297     // -----------------------------------------------------------------------
    00301     InputSource();
    00302
    00306     InputSource(const XMLCh* const systemId);
    00307
    00312     InputSource
    00313     (
    00314         const   XMLCh* const    systemId
    00315         , const XMLCh* const    publicId
    00316     );
    00317
    00321     InputSource(const char* const systemId);
    00322
    00327     InputSource
    00328     (
    00329         const   char* const systemId
    00330         , const char* const publicId
    00331     );
    00332
    00334
    00335
    00336
    00337
    00338
    00339 private:
    00340     // -----------------------------------------------------------------------
    00341     //  Unimplemented constructors and operators
    00342     // -----------------------------------------------------------------------
    00343     InputSource(const InputSource&);
    00344     void operator=(const InputSource&);
    00345
    00346
    00347     // -----------------------------------------------------------------------
    00348     //  Private data members
    00349     //
    00350     //  fEncoding
    00351     //      This is the encoding to use. Usually this is null, which means
    00352     //      to use the information found in the file itself. But, if set,
    00353     //      this encoding will be used without question.
    00354     //
    00355     //  fPublicId
    00356     //      This is the optional public id for the input source. It can be
    00357     //      null if none is desired.
    00358     //
    00359     //  fSystemId
    00360     //      This is the system id for the input source. This is what is
    00361     //      actually used to open the source.
    00362     //
    00363     //  fFatalErrorIfNotFound
    00364     // -----------------------------------------------------------------------
    00365     XMLCh*  fEncoding;
    00366     XMLCh*  fPublicId;
    00367     XMLCh*  fSystemId;
    00368     bool    fFatalErrorIfNotFound;
    00369 };
    00370
    00371
    00372 // ---------------------------------------------------------------------------
    00373 //  InputSource: Getter methods
    00374 // ---------------------------------------------------------------------------
    00375 inline const XMLCh* InputSource::getEncoding() const
    00376 {
    00377     return fEncoding;
    00378 }
    00379
    00380 inline const XMLCh* InputSource::getPublicId() const
    00381 {
    00382     return fPublicId;
    00383 }
    00384
    00385 inline const XMLCh* InputSource::getSystemId() const
    00386 {
    00387     return fSystemId;
    00388 }
    00389
    00390 inline const bool InputSource::getIssueFatalErrorIfNotFound() const
    00391 {
    00392     return fFatalErrorIfNotFound;
    00393 }
    00394
    00395 // ---------------------------------------------------------------------------
    00396 //  InputSource: Setter methods
    00397 // ---------------------------------------------------------------------------
    00398 inline void InputSource::setIssueFatalErrorIfNotFound(const bool flag)
    00399 {
    00400     fFatalErrorIfNotFound = flag;
    00401 }
    00402
    00403 XERCES_CPP_NAMESPACE_END
    00404
    00405 #endif

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