LocalFileInputSource.hpp
上传用户:huihehuasu
上传日期:2007-01-10
资源大小:6948k
文件大小:8k
源码类别:

xml/soap/webservice

开发平台:

C/C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  * 
  4.  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  * 
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  * 
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer. 
  13.  * 
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  * 
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:  
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  * 
  26.  * 4. The names "Xerces" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written 
  29.  *    permission, please contact apache@apache.org.
  30.  * 
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  * 
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  * 
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation, and was
  51.  * originally based on software copyright (c) 1999, International
  52.  * Business Machines, Inc., http://www.ibm.com .  For more information
  53.  * on the Apache Software Foundation, please see
  54.  * <http://www.apache.org/>.
  55.  */
  56. /*
  57.  * $Log: LocalFileInputSource.hpp,v $
  58.  * Revision 1.7  2001/10/13 04:21:53  jasons
  59.  * This patch resolves bug #2409: undocumented XMLException in LocalFileInputSource::new()
  60.  *
  61.  * Revision 1.6  2000/12/14 18:49:53  tng
  62.  * Fix API document generation warning: "Warning: end of member group without matching begin"
  63.  *
  64.  * Revision 1.5  2000/02/24 20:00:22  abagchi
  65.  * Swat for removing Log from API docs
  66.  *
  67.  * Revision 1.4  2000/02/15 23:59:06  roddey
  68.  * More updated documentation of Framework classes.
  69.  *
  70.  * Revision 1.3  2000/02/15 01:21:30  roddey
  71.  * Some initial documentation improvements. More to come...
  72.  *
  73.  * Revision 1.2  2000/02/06 07:47:46  rahulj
  74.  * Year 2K copyright swat.
  75.  *
  76.  * Revision 1.1  2000/01/12 18:58:06  roddey
  77.  * Putting this back with the correct lower case extension.
  78.  *
  79.  * Revision 1.1  2000/01/12 00:13:26  roddey
  80.  * These were moved from internal/ to framework/, which was something that should have
  81.  * happened long ago. They are really framework type of classes.
  82.  *
  83.  * Revision 1.1.1.1  1999/11/09 01:08:10  twl
  84.  * Initial checkin
  85.  *
  86.  * Revision 1.2  1999/11/08 20:44:43  rahul
  87.  * Swat for adding in Product name and CVS comment log variable.
  88.  *
  89.  */
  90. #if !defined(LOCALFILEINPUTSOURCE_HPP)
  91. #define LOCALFILEINPUTSOURCE_HPP
  92. #include <sax/InputSource.hpp>
  93. class BinInputStream;
  94. /**
  95.  *  This class is a derivative of the standard InputSource class. It provides
  96.  *  for the parser access to data which is referenced via a local file path,
  97.  *  as apposed to remote file or URL. This is the most efficacious mechanism
  98.  *  by which local files can be parsed, since the parse knows that it refers
  99.  *  to a local file and will make no other attempts to interpret the passed
  100.  *  path.
  101.  *
  102.  *  The path provided can either be a fully qualified path or a relative path.
  103.  *  If relative, it will be completed either relative to a passed base path
  104.  *  or relative to the current working directory of the process.
  105.  *
  106.  *  As with all InputSource derivatives. The primary objective of an input
  107.  *  source is to create an input stream via which the parser can spool in
  108.  *  data from the referenced source.
  109.  */
  110. class XMLPARSER_EXPORT LocalFileInputSource : public InputSource
  111. {
  112. public :
  113.     // -----------------------------------------------------------------------
  114.     //  Constructors and Destructor
  115.     // -----------------------------------------------------------------------
  116.     /** @name Constructors */
  117.     //@{
  118.     /**
  119.       * A local file input source requires a path to the file to load. This
  120.       * can be provided either as a fully qualified path, a path relative to
  121.       * the current working directly, or a path relative to a provided base
  122.       * path.
  123.       *
  124.       * The completed path will become the system id of this input source.
  125.       * The constructors don't take any public id for local files, but you
  126.       * still set them via the parent class' setPublicId() method of course.
  127.       *
  128.       * This constructor takes an explicit base path and a possibly relative
  129.       * path. If the relative path is seen to be fully qualified, it is used
  130.       * as is. Otherwise, it is made relative to the passed base path.
  131.       *
  132.       * @param  basePath    The base path from which the passed relative path
  133.       *                     will be based, if the relative part is indeed
  134.       *                     relative.
  135.       *
  136.       * @param  relativePath    The relative part of the path. It can actually
  137.       *                         be fully qualified, in which case it is taken
  138.       *                         as is.
  139.       * @exception XMLException If the path is relative and doesn't properly
  140.       *            resolve to a file.
  141.       */
  142.     LocalFileInputSource
  143.     (
  144.         const   XMLCh* const    basePath
  145.         , const XMLCh* const    relativePath
  146.     );
  147.     /**
  148.       * This constructor takes a single parameter which is the fully qualified
  149.       * or relative path. If it is fully qualified, it is taken as is. If it is
  150.       * relative, then it is completed relative to the current working directory
  151.       * (or the equivalent on the local host machine.)
  152.       *
  153.       * The completed path will become the system id of this input source.
  154.       * The constructors don't take any public id for local files, but you
  155.       * still set them via the parent class' setPublicId() method of course.
  156.       *
  157.       * @param  filePath    The relative or fully qualified path.
  158.       *
  159.       * @exception XMLException If the path is relative and doesn't properly
  160.       *            resolve to a file.
  161.       */
  162.     LocalFileInputSource
  163.     (
  164.         const   XMLCh* const    filePath
  165.     );
  166.     //@}
  167.     /** @name Destructor */
  168.     //@{
  169.     ~LocalFileInputSource();
  170.     //@}
  171.     // -----------------------------------------------------------------------
  172.     //  Virtual input source interface
  173.     // -----------------------------------------------------------------------
  174.     /** @name Virtual methods */
  175.     //@{
  176.     /**
  177.     * This method will return a binary input stream derivative that will
  178.     * parse from the local file indicatedby the system id.
  179.     *
  180.     * @return A dynamically allocated binary input stream derivative that
  181.     *         can parse from the file indicated by the system id.
  182.     */
  183.     virtual BinInputStream* makeStream() const;
  184.     //@}
  185. };
  186. #endif