artefaktur
software engineer &        architecture

 
 
 
 

class XmlLibLocator

Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   Namespace Members   Compound Members   Related Pages  

acdk::xml::sax::XmlLibLocator Class Reference

#include <XmlLibLocator.h>

Inheritance diagram for acdk::xml::sax::XmlLibLocator:

acdk::lang::Object org::xml::sax::Locator acdk::lang::ObjectBase acdk::lang::dmi::StdDispatch List of all members.

Detailed Description

API: org.xml.sax<br>.

Author:
Roger Rene Kommer
Version:
Revision
1.4
Date:
Date
2005/02/05 10:45:37


Public Member Functions

 XmlLibLocator (xmlParserCtxtPtr pcp, xmlSAXLocatorPtr loc)
RString getPublicId ()
 Return the public identifier for the current document event.

RString getSystemId ()
 Return the system identifier for the current document event.

int getLineNumber ()
 Return the line number where the current document event ends.

int getColumnNumber ()
 Return the column number where the current document event ends.


Private Attributes

xmlParserCtxtPtr _ctx
xmlSAXLocatorPtr _loc

Constructor & Destructor Documentation

acdk::xml::sax::XmlLibLocator::XmlLibLocator xmlParserCtxtPtr  pcp,
xmlSAXLocatorPtr  loc
[inline]
 


Member Function Documentation

int acdk::xml::sax::XmlLibLocator::getColumnNumber  )  [inline, virtual]
 

Return the column number where the current document event ends.

This is one-based number of Java char values since the last line end.

Warning: The return value from the method is intended only as an approximation for the sake of diagnostics; it is not intended to provide sufficient information to edit the character content of the original XML document. For example, when lines contain combining character sequences, wide characters, surrogate pairs, or bi-directional text, the value may not correspond to the column in a text editor's display.

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 driver 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.
See also:
getLineNumber

Implements org::xml::sax::Locator.

int acdk::xml::sax::XmlLibLocator::getLineNumber  )  [inline, virtual]
 

Return the line number where the current document event ends.

Lines are delimited by line ends, which are defined in the XML specification.

Warning: The return value from the method is intended only as an approximation for the sake of diagnostics; it is not intended to provide sufficient information to edit the character content of the original XML document. In some cases, these line numbers match what would be displayed as columns, and in others they may not match the source text due to internal entity expansion.

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 driver should provide the line position of the first character after the text associated with the document event. The first line is line 1.

Returns:
The line number, or -1 if none is available.
See also:
getColumnNumber

Implements org::xml::sax::Locator.

RString acdk::xml::sax::XmlLibLocator::getPublicId  )  [inline, virtual]
 

Return 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 null if none is available.
See also:
getSystemId

Implements org::xml::sax::Locator.

RString acdk::xml::sax::XmlLibLocator::getSystemId  )  [inline, virtual]
 

Return 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 parser must resolve it fully before passing it to the application. For example, a file name must always be provided as a file:... URL, and other kinds of relative URI are also resolved against their bases.

Returns:
A string containing the system identifier, or null if none is available.
See also:
getPublicId

Implements org::xml::sax::Locator.


Member Data Documentation

xmlParserCtxtPtr acdk::xml::sax::XmlLibLocator::_ctx [private]
 

xmlSAXLocatorPtr acdk::xml::sax::XmlLibLocator::_loc [private]
 

 
Last modified 2005-05-08 18:34 by SYSTEM By Artefaktur, Ing. Bureau Kommer