net.sf.saxon.instruct
Class TraceExpression
public
class
TraceExpression
extends TraceWrapper
implements InstructionInfo
A subclass of TraceWrapper used to trace expressions in XPath and XQuery. Unlike
the TraceInstruction class, this class contains all information needed for tracing,
rather than referencing a separate InstructionDetails object.
Method Summary |
int | getColumnNumber()
Get the column number identifying the position of the instruction. |
int | getConstructType()
Get the construct type. |
InstructionInfo | getInstructionInfo()
Get the InstructionInfo details about the construct. |
int | getLineNumber()
Get the line number of the instruction within its module |
int | getLineNumber(int locationId)
Get the line number of the expression being
traced. |
NamespaceResolver | getNamespaceResolver()
Get the namespace resolver to supply the namespace context of the instruction
that is being traced |
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. |
Iterator | getProperties()
Get an iterator over all the properties available. |
Object | getProperty(String name)
Get a named property of the instruction/expression |
String | getSystemId()
Get the URI of the module containing the instruction |
String | getSystemId(int locationId)
Get the system identifier (that is the base URI) of the static context of the expression being
traced. |
void | setColumnNumber(int column)
Set the column number of the expression being traced |
void | setConstructType(int type)
Set the type of construct. |
void | setLineNumber(int line)
Set the line number of the expression being traced |
void | setNamespaceResolver(NamespaceResolver resolver)
Set the namespace context for the instruction being traced. |
void | setObjectNameCode(int nameCode)
Set a name identifying the object of the expression, for example a function name, template name,
variable name, key name, element name, etc. |
void | setProperty(String name, Object value)
Set a named property of the instruction/expression |
void | setSystemId(String systemId)
Set the URI of the module containing the instruction |
Create a trace expression that traces execution of a given child expression
Parameters: child the expression to be traced. This will be available to the TraceListener
as the value of the "expression" property of the InstructionInfo.
public int getColumnNumber()
Get the column number identifying the position of the instruction. This method
is provided to satisfy the SourceLocator interface. However, the column number is
not maintained by Saxon, and the method always returns -1
Returns: -1
public int getConstructType()
Get the construct type. This will generally be a constant
in class
Location
Get the InstructionInfo details about the construct. This is to satisfy the InstructionInfoProvider
interface.
public int getLineNumber()
Get the line number of the instruction within its module
Returns: the line number
public int getLineNumber(int locationId)
Get the line number of the expression being
traced. This returns the same result as getLineNumber(), it is provided to satisfy the
LocationProvider interface.
Parameters: locationId not used
Returns: the line number of the expression within its module
Get the namespace resolver to supply the namespace context of the instruction
that is being traced
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.
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.
public Object getProperty(String name)
Get a named property of the instruction/expression
public String getSystemId()
Get the URI of the module containing the instruction
Returns: the module's URI
public String getSystemId(int locationId)
Get the system identifier (that is the base URI) of the static context of the expression being
traced. This returns the same result as getSystemId(), it is provided to satisfy the
LocationProvider interface.
Parameters: locationId not used
Returns: the URI of the module containing the expression
public void setColumnNumber(int column)
Set the column number of the expression being traced
Parameters: column
public void setConstructType(int type)
Set the type of construct. This will generally be a constant
in class
Location
public void setLineNumber(int line)
Set the line number of the expression being traced
Parameters: line
Set the namespace context for the instruction being traced. This is needed if the
tracelistener wants to evaluate XPath expressions in the context of the current instruction
public void setObjectNameCode(int nameCode)
Set 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.
public void setProperty(String name, Object value)
Set a named property of the instruction/expression
public void setSystemId(String systemId)
Set the URI of the module containing the instruction
Parameters: systemId the module's URI