net.sf.saxon.trace
Interface InstructionInfo

All Known Implementing Classes:

FunctionInstr, InstructionDetails, UserFunction

public interface InstructionInfo

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

Method Summary

String	getInstructionName() Get the name of the instruction.
int	getLineNumber() Get the line number of the instruction in the source stylesheet module.
HashMap	getProperties() Get all the properties of the instruction.
Object	getProperty(String name) Get the value of a particular property of the instruction.
String	getSystemId() Get the system identifier (URI) of the source stylesheet module containing the instruction.

Method Detail

getInstructionName

String getInstructionName()

Get the name of the instruction. This will normally be the name of an XSLT instruction, a literal result element, or an extension element. The name is passed in a form suitable for display to the user: it will generally be a QName, but this is not guaranteed. Some instructions may be internally generated by the Saxon compiler, in which case the name might not relate to anything obvious in the source stylesheet

getSystemId

String getSystemId()

Get the system identifier (URI) of the source stylesheet 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.

getLineNumber

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.

getProperty

Object getProperty(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

HashMap getProperties()

Get all the properties of the instruction. Properties of XSLT instructions are generally known by the name of the stylesheet attribute that defines them.

Returns:

a HashMap containing all the properties of this instruction.