Package net.sf.saxon.instruct
Class TraceExpression
java.lang.Object
net.sf.saxon.expr.ComputedExpression
net.sf.saxon.instruct.Instruction
net.sf.saxon.instruct.TraceWrapper
net.sf.saxon.instruct.TraceExpression
- All Implemented Interfaces:
Serializable
,SourceLocator
,LocationProvider
,SaxonLocator
,Container
,Expression
,TailCallReturner
,InstructionInfo
,InstructionInfoProvider
,Locator
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.
- See Also:
-
Field Summary
Fields inherited from class net.sf.saxon.instruct.TraceWrapper
child
Fields inherited from class net.sf.saxon.expr.ComputedExpression
locationId, staticProperties
Fields inherited from interface net.sf.saxon.expr.Expression
EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD
-
Constructor Summary
ConstructorsConstructorDescriptionTraceExpression
(Expression child) Create a trace expression that traces execution of a given child expression -
Method Summary
Modifier and TypeMethodDescriptionint
Get the column number identifying the position of the instruction.int
Get the construct type.Get the InstructionInfo details about the construct.int
Get the line number of the instruction within its moduleint
getLineNumber
(int locationId) Get the line number of the expression being traced.Get the namespace resolver to supply the namespace context of the instruction that is being tracedint
Get a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc.Get an iterator over all the properties available.getProperty
(String name) Get a named property of the instruction/expressionGet the URI of the module containing the instructiongetSystemId
(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 tracedvoid
setConstructType
(int type) Set the type of construct.void
setLineNumber
(int line) Set the line number of the expression being tracedvoid
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/expressionvoid
setSystemId
(String systemId) Set the URI of the module containing the instructionMethods inherited from class net.sf.saxon.instruct.TraceWrapper
computeDependencies, createsNewNodes, display, evaluateItem, getCardinality, getDependencies, getInstructionNameCode, getItemType, iterate, iterateSubExpressions, optimize, processLeavingTail, promote, replaceSubExpression, simplify, typeCheck
Methods inherited from class net.sf.saxon.instruct.Instruction
appendItem, assembleParams, assembleTunnelParams, computeCardinality, computeSpecialProperties, dynamicError, evaluateAsString, getImplementationMethod, getSourceLocator, isXSLT, process, promoteInst
Methods inherited from class net.sf.saxon.expr.ComputedExpression
adoptChildExpression, checkPermittedContents, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, getExecutable, getHostLanguage, getIntrinsicDependencies, getLocationId, getLocationProvider, getParentExpression, getPublicId, getSlotsUsed, getSpecialProperties, hasBadParentPointer, markTailFunctionCalls, resetStaticProperties, setLocationId, setParentExpression, setParentExpression, suppressValidation, typeError
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.xml.sax.Locator
getPublicId
Methods inherited from interface javax.xml.transform.SourceLocator
getPublicId
-
Constructor Details
-
TraceExpression
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.
-
-
Method Details
-
setLineNumber
public void setLineNumber(int line) Set the line number of the expression being traced- Parameters:
line
-
-
setColumnNumber
public void setColumnNumber(int column) Set the column number of the expression being traced- Parameters:
column
-
-
setConstructType
public void setConstructType(int type) Set the type of construct. This will generally be a constant in classLocation
-
getConstructType
public int getConstructType()Get the construct type. This will generally be a constant in classLocation
- Specified by:
getConstructType
in interfaceInstructionInfo
- Overrides:
getConstructType
in classComputedExpression
- Returns:
- the type of expression, as enumerated in class
Location
-
setNamespaceResolver
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 -
getNamespaceResolver
Get the namespace resolver to supply the namespace context of the instruction that is being traced- Specified by:
getNamespaceResolver
in interfaceInstructionInfo
-
setSystemId
Set the URI of the module containing the instruction- Parameters:
systemId
- the module's URI
-
getSystemId
Get the URI of the module containing the instruction- Specified by:
getSystemId
in interfaceInstructionInfo
- Specified by:
getSystemId
in interfaceLocator
- Specified by:
getSystemId
in interfaceSourceLocator
- Overrides:
getSystemId
in classComputedExpression
- Returns:
- the module's URI
-
getLineNumber
public int getLineNumber()Get the line number of the instruction within its module- Specified by:
getLineNumber
in interfaceInstructionInfo
- Specified by:
getLineNumber
in interfaceLocator
- Specified by:
getLineNumber
in interfaceSourceLocator
- Overrides:
getLineNumber
in classComputedExpression
- Returns:
- the line number
-
setObjectNameCode
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. -
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.- Specified by:
getObjectNameCode
in interfaceInstructionInfo
-
setProperty
Set a named property of the instruction/expression -
getProperty
Get a named property of the instruction/expression- Specified by:
getProperty
in interfaceInstructionInfo
- Parameters:
name
- The name of the required property- Returns:
- The value of the requested property, or null if the property is not available
-
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.- Specified by:
getProperties
in interfaceInstructionInfo
-
getColumnNumber
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- Specified by:
getColumnNumber
in interfaceLocator
- Specified by:
getColumnNumber
in interfaceSourceLocator
- Overrides:
getColumnNumber
in classComputedExpression
- Returns:
- -1
-
getInstructionInfo
Get the InstructionInfo details about the construct. This is to satisfy the InstructionInfoProvider interface.- Specified by:
getInstructionInfo
in interfaceInstructionInfoProvider
- Overrides:
getInstructionInfo
in classInstruction
-
getSystemId
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 theLocationProvider
interface.- Specified by:
getSystemId
in interfaceLocationProvider
- Parameters:
locationId
- not used- Returns:
- the URI of the module containing the expression
-
getLineNumber
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 theLocationProvider
interface.- Specified by:
getLineNumber
in interfaceLocationProvider
- Parameters:
locationId
- not used- Returns:
- the line number of the expression within its module
-