net.sf.saxon.trace

Interface InstructionInfo

All Superinterfaces:
Locator, LocationProvider, SaxonLocator, SourceLocator
Known Implementing Classes:
AbsentExtensionElement, ExtensionInstruction, InstructionDetails, LiteralResultElement, SaxonAssign, SaxonCallTemplate, SaxonCollation, SaxonDoctype, SaxonEntityRef, SaxonImportQuery, SaxonScript, SaxonWhile, SQLClose, SQLColumn, SQLConnect, SQLDelete, SQLInsert, SQLQuery, SQLUpdate, StyleElement, TraceExpression, XQueryFunction, XSLAnalyzeString, XSLApplyImports, XSLApplyTemplates, XSLAttribute, XSLAttributeSet, XSLCallTemplate, XSLCharacterMap, XSLChoose, XSLComment, XSLCopy, XSLCopyOf, XSLDecimalFormat, XSLDocument, XSLElement, XSLFallback, XSLForEach, XSLForEachGroup, XSLFunction, XSLGeneralIncorporate, XSLGeneralVariable, XSLIf, XSLImport, XSLImportSchema, XSLInclude, XSLKey, XSLMatchingSubstring, XSLMessage, XSLNamespace, XSLNamespaceAlias, XSLNextMatch, XSLNumber, XSLOtherwise, XSLOutput, XSLOutputCharacter, XSLParam, XSLPerformSort, XSLPreserveSpace, XSLProcessingInstruction, XSLResultDocument, XSLSequence, XSLSort, XSLStringConstructor, XSLStylesheet, XSLTemplate, XSLText, XSLValueOf, XSLVariable, XSLVariableDeclaration, XSLWhen, XSLWithParam

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.
StructuredQName
getObjectName(NamePool pool)
Get a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc.
Iterator
getProperties()
Get an iterator over all the properties available.
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 or query module containing the instruction.

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

getLineNumber, getSystemId

Method Details

getConstructType

public int getConstructType()

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.

getNamespaceResolver

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

getObjectName

public StructuredQName getObjectName(NamePool pool)
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.
Parameters:
pool - the name pool

getProperties

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

getProperty

public 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

getSystemId

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