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.10  2001/11/21 16:14:32  tng
00060  * 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.
00061  *
00062  * Revision 1.9  2000/03/02 19:54:35  roddey
00063  * This checkin includes many changes done while waiting for the
00064  * 1.1.0 code to be finished. I can't list them all here, but a list is
00065  * available elsewhere.
00066  *
00067  * Revision 1.8  2000/02/24 20:12:55  abagchi
00068  * Swat for removing Log from API docs
00069  *
00070  * Revision 1.7  2000/02/12 03:42:21  rahulj
00071  * Fixed DOC++ documentation formatting errors.
00072  *
00073  * Revision 1.6  2000/02/12 03:31:55  rahulj
00074  * Removed duplicate CVS Log entries.
00075  *
00076  * Revision 1.5  2000/02/12 01:27:19  aruna1
00077  * Documentation updated
00078  *
00079  * Revision 1.4  2000/02/09 02:15:28  abagchi
00080  * Documented destructor
00081  *
00082  * Revision 1.3  2000/02/06 07:47:58  rahulj
00083  * Year 2K copyright swat.
00084  *
00085  * Revision 1.2  2000/01/12 00:15:39  roddey
00086  * Changes to deal with multiply nested, relative pathed, entities and to deal
00087  * with the new URL class changes.
00088  *
00089  * Revision 1.1.1.1  1999/11/09 01:07:46  twl
00090  * Initial checkin
00091  *
00092  * Revision 1.2  1999/11/08 20:45:01  rahul
00093  * Swat for adding in Product name and CVS comment log variable.
00094  *
00095  */
00096 
00097 
00098 #ifndef INPUTSOURCE_HPP
00099 #define INPUTSOURCE_HPP
00100 
00101 #include <util/XercesDefs.hpp>
00102 
00103 class BinInputStream;
00104 
00105 
00136 class  InputSource
00137 {
00138 public:
00139     // -----------------------------------------------------------------------
00140     //  All constructors are hidden, just the destructor is available
00141     // -----------------------------------------------------------------------
00144 
00148     virtual ~InputSource();
00150 
00151 
00152     // -----------------------------------------------------------------------
00155 
00165     virtual BinInputStream* makeStream() const = 0;
00166 
00168 
00169 
00170     // -----------------------------------------------------------------------
00173 
00182     const XMLCh* getEncoding() const;
00183 
00184 
00191     const XMLCh* getPublicId() const;
00192 
00193 
00202     const XMLCh* getSystemId() const;
00203 
00212     const bool getIssueFatalErrorIfNotFound() const;
00213 
00215 
00216 
00217     // -----------------------------------------------------------------------
00220 
00232     void setEncoding(const XMLCh* const encodingStr);
00233 
00234 
00246     void setPublicId(const XMLCh* const publicId);
00247 
00264     void setSystemId(const XMLCh* const systemId);
00265 
00275     void setIssueFatalErrorIfNotFound(const bool flag);
00276 
00278 
00279 
00280 protected :
00281     // -----------------------------------------------------------------------
00282     //  Hidden constructors
00283     // -----------------------------------------------------------------------
00286     /** Default constructor */
00287     InputSource();
00288 
00292     InputSource(const XMLCh* const systemId);
00293 
00298     InputSource
00299     (
00300         const   XMLCh* const    systemId
00301         , const XMLCh* const    publicId
00302     );
00303 
00307     InputSource(const char* const systemId);
00308 
00313     InputSource
00314     (
00315         const   char* const systemId
00316         , const char* const publicId
00317     );
00318 
00320 
00321 
00322 
00323 
00324 
00325 private:
00326     // -----------------------------------------------------------------------
00327     //  Unimplemented constructors and operators
00328     // -----------------------------------------------------------------------
00329     InputSource(const InputSource&);
00330     void operator=(const InputSource&);
00331 
00332 
00333     // -----------------------------------------------------------------------
00334     //  Private data members
00335     //
00336     //  fEncoding
00337     //      This is the encoding to use. Usually this is null, which means
00338     //      to use the information found in the file itself. But, if set,
00339     //      this encoding will be used without question.
00340     //
00341     //  fPublicId
00342     //      This is the optional public id for the input source. It can be
00343     //      null if none is desired.
00344     //
00345     //  fSystemId
00346     //      This is the system id for the input source. This is what is
00347     //      actually used to open the source.
00348     //
00349     //  fFatalErrorIfNotFound
00350     // -----------------------------------------------------------------------
00351     XMLCh*  fEncoding;
00352     XMLCh*  fPublicId;
00353     XMLCh*  fSystemId;
00354     bool    fFatalErrorIfNotFound;
00355 };
00356 
00357 
00358 // ---------------------------------------------------------------------------
00359 //  InputSource: Getter methods
00360 // ---------------------------------------------------------------------------
00361 inline const XMLCh* InputSource::getEncoding() const
00362 {
00363     return fEncoding;
00364 }
00365 
00366 inline const XMLCh* InputSource::getPublicId() const
00367 {
00368     return fPublicId;
00369 }
00370 
00371 inline const XMLCh* InputSource::getSystemId() const
00372 {
00373     return fSystemId;
00374 }
00375 
00376 inline const bool InputSource::getIssueFatalErrorIfNotFound() const
00377 {
00378     return fFatalErrorIfNotFound;
00379 }
00380 
00381 // ---------------------------------------------------------------------------
00382 //  InputSource: Setter methods
00383 // ---------------------------------------------------------------------------
00384 inline void InputSource::setIssueFatalErrorIfNotFound(const bool flag)
00385 {
00386     fFatalErrorIfNotFound = flag;
00387 }
00388 
00389 #endif


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