Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

Locator.h

Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 //=============================================================================
00004 /**
00005  *  @file    Locator.h
00006  *
00007  *  $Id: Locator.h,v 1.1.1.1 2003/02/21 18:36:32 chad Exp $
00008  *
00009  *  @author Nanbor Wang <nanbor@cs.wustl.edu>
00010  */
00011 //=============================================================================
00012 
00013 #ifndef _ACEXML_LOCATOR_H_
00014 #define _ACEXML_LOCATOR_H_
00015 #include "ace/pre.h"
00016 
00017 #include "ACEXML/common/XML_Types.h"
00018 
00019 /**
00020  * @class ACEXML_Locator Locator.h "ACEXML/common/Locator.h"
00021  *
00022  * @brief ACEXML_Locator defines operations that an XML locator should support.
00023  *
00024  * If a SAX parser provides location information to the SAX
00025  * application, it does so by implementing this interface and then
00026  * passing an instance to the application using the content handler's
00027  * setDocumentLocator method. The application can use the object to
00028  * obtain the location of any other content handler event in the XML
00029  * source document.
00030  *
00031  * Note that the results returned by the object will be valid only
00032  * during the scope of each content handler method: the application
00033  * will receive unpredictable results if it attempts to use the
00034  * locator at any other time.
00035  *
00036  * SAX parsers are not required to supply a locator, but they are very
00037  * strongly encouraged to do so. If the parser supplies a locator, it
00038  * must do so before reporting any other document events. If no
00039  * locator has been set by the time the application receives the
00040  * startDocument event, the application should assume that a locator
00041  * is not available.
00042  */
00043 class ACEXML_Export ACEXML_Locator
00044 {
00045 public:
00046   /*
00047    * Return the column number where the current document event ends.
00048    */
00049   virtual int getColumnNumber (void) const = 0;
00050 
00051   /*
00052    * Return the line number where the current document event ends.
00053    */
00054   virtual int getLineNumber (void) const = 0;
00055 
00056   /*
00057    * Return the public identifier for the current document event.
00058    */
00059   virtual const ACEXML_Char *getPublicId (void) const = 0;
00060 
00061   /*
00062    * Return the system identifier for the current document event.
00063    */
00064   virtual const ACEXML_Char *getSystemId (void) const = 0;
00065 };
00066 
00067 
00068 #include "ace/post.h"
00069 
00070 #endif /* _ACEXML_LOCATOR_H_ */

Generated on Mon Jun 16 13:23:22 2003 for ACEXML by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002