Namespace Sax
Class CLocator

class CLocator: public CInterface {
public:
    CLocator();
    virtual ~CLocator();
public:
    virtual const WCHAR *GetPublicId() = 0;
    virtual const WCHAR *GetSystemId() = 0;
    virtual int GetLineNumber() = 0;
    virtual int GetColumnNumber() = 0;
    };
typedef XInterface<CLocator> XLocator;

The abstract interface for associating SAX events with document locations.

If a SAX reader provides location information to the SAX application, it does so by implementing this interface and then passing an instance to the application using the content handler's CContentHandler::SetDocumentLocator method. The application can use the object to obtain the location of any other content event in the XML source document.

Note that the results returned by the object will be valid only during the scope of each content handler method: the application will receive unpredictable results if it attempts to use the locator at any other time.

SAX readers are not required to supply a locator, but they are very strongly encouraged to do so. If the reader supplies a locator, it must do so before reporting any other document events. If no locator has been set by the time the application receives the CContentHandler::StartDocument event, the application should assume that a locator is not available.

Since:

1.00.00

Version:

1.50.00

Author:

C++ interfaces by Alexey Gokhberg; based on the original SAX2 specification by David Megginson

CLocator

CLocator();

Constructs the locator.

~CLocator

virtual ~CLocator();

Destroys the locator.

GetPublicId

virtual WCHAR *GetPublicId() = 0;

Gets the public identifier for the current document event.

The return value is the public identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.

Returns:

a string containing the public identifier, or the empty string if none is available

GetSystemId

virtual WCHAR *GetSystemId() = 0;

Gets the system identifier for the current document event.

The return value is the system identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.

If the system identifier is a URL, the reader must resolve it fully before passing it to the application.

Returns:

a string containing the system identifier, or the empty string if none is available

GetLineNumber

virtual int GetLineNumber() = 0;

Gets the line number where the current document event ends.

WARNING: The return value from the method is intended only as an approximation for the sake of error reporting; it is not intended to provide sufficient information to edit the character content of the original XML document.

The return value is an approximation of the line number in the document entity or external parsed entity where the markup triggering the event appears.

If possible, the SAX reader should provide the line position of the first character after the text associated with the document event. The first line in the document is line 1.

Returns:

the line number, or -1 if none is available

GetColumnNumber

virtual int GetColumnNumber() = 0;

Gets the column number where the current document event ends.

WARNING: The return value from the method is intended only as an approximation for the sake of error reporting; it is not intended to provide sufficient information to edit the character content of the original XML document.

The return value is an approximation of the column number in the document entity or external parsed entity where the markup triggering the event appears.

If possible, the SAX reader should provide the line position of the first character after the text associated with the document event.

If possible, the SAX reader should provide the line position of the first character after the text associated with the document event. The first column in each line is column 1.

Returns:

the column number, or -1 if none is available