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

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: Locator.hpp,v $
  58.  * Revision 1.6  2000/03/02 19:54:35  roddey
  59.  * This checkin includes many changes done while waiting for the
  60.  * 1.1.0 code to be finished. I can't list them all here, but a list is
  61.  * available elsewhere.
  62.  *
  63.  * Revision 1.5  2000/02/24 20:12:55  abagchi
  64.  * Swat for removing Log from API docs
  65.  *
  66.  * Revision 1.4  2000/02/12 03:31:55  rahulj
  67.  * Removed duplicate CVS Log entries.
  68.  *
  69.  * Revision 1.3  2000/02/09 01:55:06  abagchi
  70.  * Removed private function docs
  71.  *
  72.  * Revision 1.2  2000/02/06 07:47:58  rahulj
  73.  * Year 2K copyright swat.
  74.  *
  75.  * Revision 1.1.1.1  1999/11/09 01:07:46  twl
  76.  * Initial checkin
  77.  *
  78.  * Revision 1.3  1999/11/08 20:45:01  rahul
  79.  * Swat for adding in Product name and CVS comment log variable.
  80.  *
  81.  */
  82. #ifndef LOCATOR_HPP
  83. #define LOCATOR_HPP
  84. #include <util/XercesDefs.hpp>
  85. /**
  86.   * Interface for associating a SAX event with a document location.
  87.   *
  88.   * <p>If a SAX parser provides location information to the SAX
  89.   * application, it does so by implementing this interface and then
  90.   * passing an instance to the application using the document
  91.   * handler's setDocumentLocator method.  The application can use the
  92.   * object to obtain the location of any other document handler event
  93.   * in the XML source document.</p>
  94.   *
  95.   * <p>Note that the results returned by the object will be valid only
  96.   * during the scope of each document handler method: the application
  97.   * will receive unpredictable results if it attempts to use the
  98.   * locator at any other time.</p>
  99.   *
  100.   * <p>SAX parsers are not required to supply a locator, but they are
  101.   * very strong encouraged to do so.  If the parser supplies a
  102.   * locator, it must do so before reporting any other document events.
  103.   * If no locator has been set by the time the application receives
  104.   * the startDocument event, the application should assume that a
  105.   * locator is not available.</p>
  106.   *
  107.   * @see DocumentHandler#setDocumentLocator 
  108.   */
  109. class SAX_EXPORT Locator
  110. {
  111. public:
  112.     /** @name Constructors and Destructor */
  113.     //@{
  114.     /** Default constructor */
  115.     Locator()
  116.     {
  117.     }
  118.     /** Destructor */
  119.     virtual ~Locator()
  120.     {
  121.     }
  122.     //@}
  123.     /** @name The locator interface */
  124.     //@{
  125.   /**
  126.     * Return the public identifier for the current document event.
  127.     * <p>This will be the public identifier
  128.     * @return A string containing the public identifier, or
  129.     *         null if none is available.
  130.     * @see #getSystemId
  131.     */
  132.     virtual const XMLCh* getPublicId() const = 0;
  133.   /**
  134.     * Return the system identifier for the current document event.
  135.     *
  136.     * <p>If the system identifier is a URL, the parser must resolve it
  137.     * fully before passing it to the application.</p>
  138.     *
  139.     * @return A string containing the system identifier, or null
  140.     *         if none is available.
  141.     * @see #getPublicId
  142.     */
  143.     virtual const XMLCh* getSystemId() const = 0;
  144.   /**
  145.     * Return the line number where the current document event ends.
  146.     * Note that this is the line position of the first character
  147.     * after the text associated with the document event.
  148.     * @return The line number, or -1 if none is available.
  149.     * @see #getColumnNumber
  150.     */
  151.     virtual int getLineNumber() const = 0;
  152.   /**
  153.     * Return the column number where the current document event ends.
  154.     * Note that this is the column number of the first
  155.     * character after the text associated with the document
  156.     * event.  The first column in a line is position 1.
  157.     * @return The column number, or -1 if none is available.
  158.     * @see #getLineNumber
  159.     */
  160.     virtual int getColumnNumber() const = 0;
  161.     //@}
  162. private :
  163.     /* Copy constructor */
  164.     Locator(const Locator&);
  165.     /* Assignment operator */
  166.     void operator=(const Locator&);
  167. };
  168. #endif