DOMLocator.hpp Source File

00001 #ifndef DOMLocator_HEADER_GUARD_
00002 #define DOMLocator_HEADER_GUARD_
00003 
00004 /*
00005  * The Apache Software License, Version 1.1
00006  *
00007  * Copyright (c) 2002 The Apache Software Foundation.  All rights
00008  * reserved.
00009  *
00010  * Redistribution and use in source and binary forms, with or without
00011  * modification, are permitted provided that the following conditions
00012  * are met:
00013  *
00014  * 1. Redistributions of source code must retain the above copyright
00015  *    notice, this list of conditions and the following disclaimer.
00016  *
00017  * 2. Redistributions in binary form must reproduce the above copyright
00018  *    notice, this list of conditions and the following disclaimer in
00019  *    the documentation and/or other materials provided with the
00020  *    distribution.
00021  *
00022  * 3. The end-user documentation included with the redistribution,
00023  *    if any, must include the following acknowledgment:
00024  *       "This product includes software developed by the
00025  *        Apache Software Foundation (http://www.apache.org/)."
00026  *    Alternately, this acknowledgment may appear in the software itself,
00027  *    if and wherever such third-party acknowledgments normally appear.
00028  *
00029  * 4. The names "Xerces" and "Apache Software Foundation" must
00030  *    not be used to endorse or promote products derived from this
00031  *    software without prior written permission. For written
00032  *    permission, please contact apache\@apache.org.
00033  *
00034  * 5. Products derived from this software may not be called "Apache",
00035  *    nor may "Apache" appear in their name, without prior written
00036  *    permission of the Apache Software Foundation.
00037  *
00038  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00039  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00040  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00041  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00042  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00043  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00044  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00045  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00046  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00047  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00048  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00049  * SUCH DAMAGE.
00050  * ====================================================================
00051  *
00052  * This software consists of voluntary contributions made by many
00053  * individuals on behalf of the Apache Software Foundation, and was
00054  * originally based on software copyright (c) 1999, International
00055  * Business Machines, Inc., http://www.ibm.com .  For more information
00056  * on the Apache Software Foundation, please see
00057  * <http://www.apache.org/>.
00058  */
00059 
00060 /*
00061  * $Log: DOMLocator.hpp,v $
00062  * Revision 1.6  2002/11/04 15:09:24  tng
00063  * C++ Namespace Support.
00064  *
00065  * Revision 1.5  2002/08/22 15:04:57  tng
00066  * Remove unused parameter variables in inline functions.
00067  *
00068  * Revision 1.4  2002/06/06 20:53:06  tng
00069  * Documentation Fix: Update the API Documentation for DOM headers
00070  *
00071  * Revision 1.3  2002/05/30 19:24:48  knoaman
00072  * documentation update
00073  *
00074  * Revision 1.2  2002/05/27 18:28:26  tng
00075  * To get ready for 64 bit large file, use XMLSSize_t to represent line and column number.
00076  *
00077  * Revision 1.1  2002/05/23 15:47:24  knoaman
00078  * DOM L3 core - support for DOMError, DOMErrorHandler and DOMLocator
00079  *
00080  */
00081 
00082 #include <xercesc/util/XercesDefs.hpp>
00083 
00084 XERCES_CPP_NAMESPACE_BEGIN
00085 
00086 
00087 class DOMNode;
00088 
00089 
00098 class  DOMLocator
00099 {
00100 protected:
00101     // -----------------------------------------------------------------------
00102     //  Hidden constructors
00103     // -----------------------------------------------------------------------
00106     DOMLocator() {};
00107     DOMLocator(const DOMLocator &) {};
00108     DOMLocator & operator = (const DOMLocator &) {return *this;};
00110 
00111 public:
00112     // -----------------------------------------------------------------------
00113     //  All constructors are hidden, just the destructor is available
00114     // -----------------------------------------------------------------------
00121     virtual ~DOMLocator() {};
00123 
00124     // -----------------------------------------------------------------------
00125     //  Virtual DOMLocator interface
00126     // -----------------------------------------------------------------------
00129     // -----------------------------------------------------------------------
00130     //  Getter methods
00131     // -----------------------------------------------------------------------
00141     virtual XMLSSize_t getLineNumber() const = 0;
00142 
00152     virtual XMLSSize_t getColumnNumber() const = 0;
00153 
00165     virtual XMLSSize_t getOffset() const = 0;
00166 
00176     virtual DOMNode* getErrorNode() const = 0;
00177 
00187     virtual const XMLCh* getURI() const = 0;
00188 
00189     // -----------------------------------------------------------------------
00190     //  Setter methods
00191     // -----------------------------------------------------------------------
00202     virtual void setLineNumber(const XMLSSize_t lineNumber) = 0;
00203 
00214     virtual void setColumnNumber(const XMLSSize_t columnNumber) = 0;
00215 
00226     virtual void setOffset(const XMLSSize_t offset) = 0;
00227 
00238     virtual void setErrorNode(DOMNode* const errorNode) = 0;
00239 
00250     virtual void setURI(const XMLCh* const uri) = 0;
00251 
00253 };
00254 
00255 XERCES_CPP_NAMESPACE_END
00256 
00257 #endif