org.apache.xerces.util

Class StAXLocationWrapper

java.lang.Object

org.apache.xerces.util.StAXLocationWrapper

All Implemented Interfaces:

XMLLocator

public final class StAXLocationWrapper
extends Object
implements XMLLocator

A light wrapper around a StAX location. This is useful when bridging between StAX and XNI components.

Version:

$Id$

Author:

Michael Glavassevich, IBM

Constructor Summary

Constructors

Constructor and Description
StAXLocationWrapper()

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.
Location	getLocation()
String	getPublicId() Returns the public identifier.
String	getXMLVersion() Returns the XML version of the current entity.
void	setLocation(Location location)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StAXLocationWrapper

public StAXLocationWrapper()

Method Detail

setLocation

public void setLocation(Location location)

getLocation

public Location getLocation()

getPublicId

public String getPublicId()

Description copied from interface: XMLLocator

Returns the public identifier.

Specified by:

getPublicId in interface XMLLocator

getLiteralSystemId

public String getLiteralSystemId()

Description copied from interface: XMLLocator

Returns the literal system identifier.

Specified by:

getLiteralSystemId in interface XMLLocator

getBaseSystemId

public String getBaseSystemId()

Description copied from interface: XMLLocator

Returns the base system identifier.

Specified by:

getBaseSystemId in interface XMLLocator

getExpandedSystemId

public String getExpandedSystemId()

Description copied from interface: XMLLocator

Returns the expanded system identifier.

Specified by:

getExpandedSystemId in interface XMLLocator

getLineNumber

public int getLineNumber()

Description copied from interface: XMLLocator

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

Specified by:

getLineNumber in interface XMLLocator

getColumnNumber

public int getColumnNumber()

Description copied from interface: XMLLocator

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

Specified by:

getColumnNumber in interface XMLLocator

getCharacterOffset

public int getCharacterOffset()

Description copied from interface: XMLLocator

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

Specified by:

getCharacterOffset in interface XMLLocator

getEncoding

public String getEncoding()

Description copied from interface: XMLLocator

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.

Specified by:

getEncoding in interface XMLLocator

getXMLVersion

public String getXMLVersion()

Description copied from interface: XMLLocator

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.

Specified by:

getXMLVersion in interface XMLLocator