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.9 2000/03/02 19:54:35 roddey
00060 * This checkin includes many changes done while waiting for the
00061 * 1.1.0 code to be finished. I can't list them all here, but a list is
00062 * available elsewhere.
00063 *
00064 * Revision 1.8 2000/02/24 20:12:55 abagchi
00065 * Swat for removing Log from API docs
00066 *
00067 * Revision 1.7 2000/02/12 03:42:21 rahulj
00068 * Fixed DOC++ documentation formatting errors.
00069 *
00070 * Revision 1.6 2000/02/12 03:31:55 rahulj
00071 * Removed duplicate CVS Log entries.
00072 *
00073 * Revision 1.5 2000/02/12 01:27:19 aruna1
00074 * Documentation updated
00075 *
00076 * Revision 1.4 2000/02/09 02:15:28 abagchi
00077 * Documented destructor
00078 *
00079 * Revision 1.3 2000/02/06 07:47:58 rahulj
00080 * Year 2K copyright swat.
00081 *
00082 * Revision 1.2 2000/01/12 00:15:39 roddey
00083 * Changes to deal with multiply nested, relative pathed, entities and to deal
00084 * with the new URL class changes.
00085 *
00086 * Revision 1.1.1.1 1999/11/09 01:07:46 twl
00087 * Initial checkin
00088 *
00089 * Revision 1.2 1999/11/08 20:45:01 rahul
00090 * Swat for adding in Product name and CVS comment log variable.
00091 *
00092 */
00093
00094
00095 #ifndef INPUTSOURCE_HPP
00096 #define INPUTSOURCE_HPP
00097
00098 #include <util/XercesDefs.hpp>
00099
00100 class BinInputStream;
00101
00102
00133 class InputSource
00134 {
00135 public:
00136 // -----------------------------------------------------------------------
00137 // All constructors are hidden, just the destructor is available
00138 // -----------------------------------------------------------------------
00140 //@{
00145 virtual ~InputSource();
00146 //@}
00147
00148
00149 // -----------------------------------------------------------------------
00151 //@{
00162 virtual BinInputStream* makeStream() const = 0;
00163
00164 //@}
00165
00166
00167 // -----------------------------------------------------------------------
00169 //@{
00179 const XMLCh* getEncoding() const;
00180
00181
00188 const XMLCh* getPublicId() const;
00189
00190
00199 const XMLCh* getSystemId() const;
00200
00201 //@}
00202
00203
00204 // -----------------------------------------------------------------------
00206 //@{
00207
00219 void setEncoding(const XMLCh* const encodingStr);
00220
00221
00233 void setPublicId(const XMLCh* const publicId);
00234
00251 void setSystemId(const XMLCh* const systemId);
00252
00253 //@}
00254
00255
00256 protected :
00257 // -----------------------------------------------------------------------
00258 // Hidden constructors
00259 // -----------------------------------------------------------------------
00261 //@{
00263 InputSource();
00264
00268 InputSource(const XMLCh* const systemId);
00269
00274 InputSource
00275 (
00276 const XMLCh* const systemId
00277 , const XMLCh* const publicId
00278 );
00279
00283 InputSource(const char* const systemId);
00284
00289 InputSource
00290 (
00291 const char* const systemId
00292 , const char* const publicId
00293 );
00294
00295 //@}
00296
00297
00298
00299
00300
00301 private:
00302 // -----------------------------------------------------------------------
00303 // Unimplemented constructors and operators
00304 // -----------------------------------------------------------------------
00305 InputSource(const InputSource&);
00306 void operator=(const InputSource&);
00307
00308
00309 // -----------------------------------------------------------------------
00310 // Private data members
00311 //
00312 // fEncoding
00313 // This is the encoding to use. Usually this is null, which means
00314 // to use the information found in the file itself. But, if set,
00315 // this encoding will be used without question.
00316 //
00317 // fPublicId
00318 // This is the optional public id for the input source. It can be
00319 // null if none is desired.
00320 //
00321 // fSystemId
00322 // This is the system id for the input source. This is what is
00323 // actually used to open the source.
00324 // -----------------------------------------------------------------------
00325 XMLCh* fEncoding;
00326 XMLCh* fPublicId;
00327 XMLCh* fSystemId;
00328 };
00329
00330
00331 // ---------------------------------------------------------------------------
00332 // InputSource: Getter methods
00333 // ---------------------------------------------------------------------------
00334 inline const XMLCh* InputSource::getEncoding() const
00335 {
00336 return fEncoding;
00337 }
00338
00339 inline const XMLCh* InputSource::getPublicId() const
00340 {
00341 return fPublicId;
00342 }
00343
00344 inline const XMLCh* InputSource::getSystemId() const
00345 {
00346 return fSystemId;
00347 }
00348
00349 #endif