net.sf.saxon.trace

Interface InstructionInfo

All Superinterfaces:

Location, org.xml.sax.Locator, javax.xml.transform.SourceLocator

All Known Implementing Classes:

Accumulator, Actor, AttributeSet, ClauseInfo, CompoundMode, GlobalParam, GlobalVariable, InstructionDetails, KeyDefinition, MemoFunction, Mode, ModeEE, ModePE, NamedTemplate, SimpleMode, StreamableUserFunction, TemplateRule, TemplateRuleEE, TraceExpression, UndeclaredVariable, UserFunction, XQueryFunction

public interface InstructionInfo
extends Location

Information about an instruction in the stylesheet or a construct in a Query, made available at run-time to a TraceListener. Although the class is mainly used to provide information for diagnostics, it also has a role in detecting circularities among global variables.

Method Summary

Modifier and Type	Method and Description
int	getConstructType() Get the type of construct.
StructuredQName	getObjectName() 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<java.lang.String>	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.

Methods inherited from interface net.sf.saxon.expr.parser.Location

getColumnNumber, getLineNumber, getPublicId, getSystemId, saveLocation

Method Detail

getConstructType

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 LocationKind.

Returns:

an integer identifying the kind of construct

getObjectName

StructuredQName getObjectName()

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.

Returns:

the QName of the object declared or manipulated by this instruction or expression

getProperty

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

java.util.Iterator<java.lang.String> 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.

Returns:

an iterator over the properties.