DOMLocator.hpp Source File

00001 #ifndef DOMLocator_HEADER_GUARD_
00002 #define DOMLocator_HEADER_GUARD_
00003 
00004 /*
00005  * Copyright 2002,2004 The Apache Software Foundation.
00006  * 
00007  * Licensed under the Apache License, Version 2.0 (the "License");
00008  * you may not use this file except in compliance with the License.
00009  * You may obtain a copy of the License at
00010  * 
00011  *      http://www.apache.org/licenses/LICENSE-2.0
00012  * 
00013  * Unless required by applicable law or agreed to in writing, software
00014  * distributed under the License is distributed on an "AS IS" BASIS,
00015  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00016  * See the License for the specific language governing permissions and
00017  * limitations under the License.
00018  */
00019 
00020 /*
00021  * $Log: DOMLocator.hpp,v $
00022  * Revision 1.8  2004/09/08 13:55:39  peiyongz
00023  * Apache License Version 2.0
00024  *
00025  * Revision 1.7  2003/03/07 19:59:05  tng
00026  * [Bug 11692] Unimplement the hidden constructors and assignment operator to remove warnings from gcc.
00027  *
00028  * Revision 1.6  2002/11/04 15:09:24  tng
00029  * C++ Namespace Support.
00030  *
00031  * Revision 1.5  2002/08/22 15:04:57  tng
00032  * Remove unused parameter variables in inline functions.
00033  *
00034  * Revision 1.4  2002/06/06 20:53:06  tng
00035  * Documentation Fix: Update the API Documentation for DOM headers
00036  *
00037  * Revision 1.3  2002/05/30 19:24:48  knoaman
00038  * documentation update
00039  *
00040  * Revision 1.2  2002/05/27 18:28:26  tng
00041  * To get ready for 64 bit large file, use XMLSSize_t to represent line and column number.
00042  *
00043  * Revision 1.1  2002/05/23 15:47:24  knoaman
00044  * DOM L3 core - support for DOMError, DOMErrorHandler and DOMLocator
00045  *
00046  */
00047 
00048 #include <xercesc/util/XercesDefs.hpp>
00049 
00050 XERCES_CPP_NAMESPACE_BEGIN
00051 
00052 
00053 class DOMNode;
00054 
00055 
00064 class  DOMLocator
00065 {
00066 protected:
00067     // -----------------------------------------------------------------------
00068     //  Hidden constructors
00069     // -----------------------------------------------------------------------
00072     DOMLocator() {};
00074     
00075 private:    
00076     // -----------------------------------------------------------------------
00077     // Unimplemented constructors and operators
00078     // -----------------------------------------------------------------------
00081     DOMLocator(const DOMLocator &);
00082     DOMLocator & operator = (const DOMLocator &);
00084 
00085 public:
00086     // -----------------------------------------------------------------------
00087     //  All constructors are hidden, just the destructor is available
00088     // -----------------------------------------------------------------------
00095     virtual ~DOMLocator() {};
00097 
00098     // -----------------------------------------------------------------------
00099     //  Virtual DOMLocator interface
00100     // -----------------------------------------------------------------------
00103     // -----------------------------------------------------------------------
00104     //  Getter methods
00105     // -----------------------------------------------------------------------
00115     virtual XMLSSize_t getLineNumber() const = 0;
00116 
00126     virtual XMLSSize_t getColumnNumber() const = 0;
00127 
00139     virtual XMLSSize_t getOffset() const = 0;
00140 
00150     virtual DOMNode* getErrorNode() const = 0;
00151 
00161     virtual const XMLCh* getURI() const = 0;
00162 
00163     // -----------------------------------------------------------------------
00164     //  Setter methods
00165     // -----------------------------------------------------------------------
00176     virtual void setLineNumber(const XMLSSize_t lineNumber) = 0;
00177 
00188     virtual void setColumnNumber(const XMLSSize_t columnNumber) = 0;
00189 
00200     virtual void setOffset(const XMLSSize_t offset) = 0;
00201 
00212     virtual void setErrorNode(DOMNode* const errorNode) = 0;
00213 
00224     virtual void setURI(const XMLCh* const uri) = 0;
00225 
00227 };
00228 
00229 XERCES_CPP_NAMESPACE_END
00230 
00231 #endif