org.apache.xerces.xni

Interface XMLLocator

All Known Implementing Classes:

SAXLocatorWrapper, SimpleLocator, StAXLocationWrapper, XML11EntityScanner, XMLEntityScanner, XMLLocatorWrapper

public interface XMLLocator

Location information.

Version:

$Id$

Author:

Andy Clark, IBM

Method Summary

Modifier and Type	Method and Description
String	getBaseSystemId() Returns the base system identifier.
int	getCharacterOffset() Returns the character offset, or -1 if no character offset is available.
int	getColumnNumber() Returns the column number, or -1 if no column number is available.
String	getEncoding() Returns the encoding of the current entity.
String	getExpandedSystemId() Returns the expanded system identifier.
int	getLineNumber() Returns the line number, or -1 if no line number is available.
String	getLiteralSystemId() Returns the literal system identifier.
String	getPublicId() Returns the public identifier.
String	getXMLVersion() Returns the XML version of the current entity.

Method Detail

getPublicId

String getPublicId()

Returns the public identifier.

getLiteralSystemId

String getLiteralSystemId()

Returns the literal system identifier.

getBaseSystemId

String getBaseSystemId()

Returns the base system identifier.

getExpandedSystemId

String getExpandedSystemId()

Returns the expanded system identifier.

getLineNumber

int getLineNumber()

Returns the line number, or -1 if no line number is available.

getColumnNumber

int getColumnNumber()

Returns the column number, or -1 if no column number is available.

getCharacterOffset

int getCharacterOffset()

Returns the character offset, or -1 if no character offset is available.

getEncoding

String getEncoding()

Returns the encoding of the current entity. Note that, for a given entity, this value can only be considered final once the encoding declaration has been read (or once it has been determined that there is no such declaration) since, no encoding having been specified on the XMLInputSource, the parser will make an initial "guess" which could be in error.

getXMLVersion

String getXMLVersion()

Returns the XML version of the current entity. This will normally be the value from the XML or text declaration or defaulted by the parser. Note that that this value may be different than the version of the processing rules applied to the current entity. For instance, an XML 1.1 document may refer to XML 1.0 entities. In such a case the rules of XML 1.1 are applied to the entire document. Also note that, for a given entity, this value can only be considered final once the XML or text declaration has been read or once it has been determined that there is no such declaration.