org.apache.xml.utils

Class SAXSourceLocator

Implemented Interfaces:
Serializable, Locator, SourceLocator

public class SAXSourceLocator
extends LocatorImpl
implements SourceLocator, Serializable

Class SAXSourceLocator extends org.xml.sax.helpers.LocatorImpl for the purpose of implementing the SourceLocator interface, and thus can be both a SourceLocator and a SAX Locator.

Constructor Summary

SAXSourceLocator()
Constructor SAXSourceLocator
SAXSourceLocator(SourceLocator locator)
Constructor SAXSourceLocator
SAXSourceLocator(Locator locator)
Constructor SAXSourceLocator
SAXSourceLocator(SAXParseException spe)
Constructor SAXSourceLocator

Method Summary

int
getColumnNumber()
Return the column number where the current document event ends.
int
getLineNumber()
Return the line number where the current document event ends.
String
getPublicId()
Return the public identifier for the current document event.
String
getSystemId()
Return the system identifier for the current document event.

Methods inherited from class org.xml.sax.helpers.LocatorImpl

getColumnNumber, getLineNumber, getPublicId, getSystemId, setColumnNumber, setLineNumber, setPublicId, setSystemId

Constructor Details

SAXSourceLocator

public SAXSourceLocator()
Constructor SAXSourceLocator

SAXSourceLocator

public SAXSourceLocator(SourceLocator locator)
Constructor SAXSourceLocator
Parameters:
locator - Source locator

SAXSourceLocator

public SAXSourceLocator(Locator locator)
Constructor SAXSourceLocator
Parameters:
locator - Source locator

SAXSourceLocator

public SAXSourceLocator(SAXParseException spe)
Constructor SAXSourceLocator
Parameters:
spe - SAXParseException exception.

Method Details

getColumnNumber

public int getColumnNumber()
Return 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.

Specified by:
getColumnNumber in interface SourceLocator
getColumnNumber in interface Locator
Overrides:
getColumnNumber in interface LocatorImpl
Returns:
The column number, or -1 if none is available.

getLineNumber

public int getLineNumber()
Return 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.

Specified by:
getLineNumber in interface SourceLocator
getLineNumber in interface Locator
Overrides:
getLineNumber in interface LocatorImpl
Returns:
The line number, or -1 if none is available.

getPublicId

public String getPublicId()
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.

Specified by:
getPublicId in interface SourceLocator
getPublicId in interface Locator
Overrides:
getPublicId in interface LocatorImpl
Returns:
A string containing the public identifier, or null if none is available.
See Also:
getSystemId()

getSystemId

public String getSystemId()
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.

Specified by:
getSystemId in interface SourceLocator
getSystemId in interface Locator
Overrides:
getSystemId in interface LocatorImpl
Returns:
A string containing the system identifier, or null if none is available.
See Also:
getPublicId()

Copyright B) 2004 Apache XML Project. All Rights Reserved.