net.sf.saxon.trace
Interface InstructionInfo

All Superinterfaces:

LocationProvider, org.xml.sax.Locator, SaxonLocator, javax.xml.transform.SourceLocator

All Known Implementing Classes:

InstructionDetails, StyleElement, TraceExpression, XQueryFunction

public interface InstructionInfo

extends SaxonLocator

Information about an instruction in the stylesheet, made available at run-time to a TraceListener

Method Summary

int	getConstructType() Get the type of construct.
int	getLineNumber() Get the line number of the instruction in the source stylesheet module.
NamespaceResolver	getNamespaceResolver() Get the namespace context of the instruction.
int	getObjectNameCode() Get a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc.
java.util.Iterator	getProperties() Get an iterator over all the properties available.
java.lang.Object	getProperty(java.lang.String name) Get the value of a particular property of the instruction.
java.lang.String	getSystemId() Get the system identifier (URI) of the source stylesheet or query module containing the instruction.

Methods inherited from interface org.xml.sax.Locator

getColumnNumber, getPublicId

Methods inherited from interface javax.xml.transform.SourceLocator

getColumnNumber, getPublicId

Methods inherited from interface net.sf.saxon.event.LocationProvider

getLineNumber, getSystemId

Method Detail

getConstructType

public int getConstructType()

Get the type of construct. This will either be the fingerprint of a standard XSLT instruction name (values in StandardNames: all less than 1024) or it will be a constant in class Location.

getObjectNameCode

public int getObjectNameCode()

Get a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc. This is used only where the name is known statically.

getSystemId

public java.lang.String getSystemId()

Get the system identifier (URI) of the source stylesheet or query module containing the instruction. This will generally be an absolute URI. If the system identifier is not known, the method may return null. In some cases, for example where XML external entities are used, the correct system identifier is not always retained.

Specified by:

getSystemId in interface org.xml.sax.Locator

Returns:

A string containing the system identifier, or null if none is available.

See Also:

Locator.getPublicId()

getLineNumber

public int getLineNumber()

Get the line number of the instruction in the source stylesheet module. If this is not known, or if the instruction is an artificial one that does not relate to anything in the source code, the value returned may be -1.

Specified by:

getLineNumber in interface org.xml.sax.Locator

Returns:

The line number, or -1 if none is available.

See Also:

Locator.getColumnNumber()

getNamespaceResolver

public NamespaceResolver getNamespaceResolver()

Get the namespace context of the instruction. This will not always be available, in which case the method returns null.

getProperty

public java.lang.Object getProperty(java.lang.String name)

Get the value of a particular property of the instruction. Properties of XSLT instructions are generally known by the name of the stylesheet attribute that defines them.

Parameters:

name - The name of the required property

Returns:

The value of the requested property, or null if the property is not available

getProperties

public java.util.Iterator getProperties()

Get an iterator over all the properties available. The values returned by the iterator will be of type String, and each string can be supplied as input to the getProperty() method to retrieve the value of the property. The iterator may return properties whose value is null.