Package net.sf.saxon.instruct
Class InstructionDetails
java.lang.Object
net.sf.saxon.instruct.InstructionDetails
- All Implemented Interfaces:
Serializable
,SourceLocator
,LocationProvider
,SaxonLocator
,InstructionInfo
,InstructionInfoProvider
,Locator
public final class InstructionDetails
extends Object
implements InstructionInfo, InstructionInfoProvider, Serializable
Details about an instruction, used when reporting errors and when tracing
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
Get the column number identifying the position of the instruction.int
Get the construct typeGet the InstructionInfo details about the construct.int
Get the line number of the instruction within its moduleint
getLineNumber
(int locationId) Get the line number within the document or module containing a particular locationGet 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 instructionGet the public ID of the module containing the instruction.Get the URI of the module containing the instructiongetSystemId
(int locationId) Get the URI of the document or module containing a particular locationvoid
setColumnNumber
(int column) Set the column numbervoid
setConstructType
(int type) Set the type of constructvoid
setLineNumber
(int lineNumber) Set the line number of the instruction within the modulevoid
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 instructionvoid
setSystemId
(String systemId) Set the URI of the module containing the instruction
-
Constructor Details
-
InstructionDetails
public InstructionDetails()
-
-
Method Details
-
setConstructType
public void setConstructType(int type) Set the type of construct -
getConstructType
public int getConstructType()Get the construct type- Specified by:
getConstructType
in interfaceInstructionInfo
-
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
- Returns:
- the module's URI
-
setLineNumber
public void setLineNumber(int lineNumber) Set the line number of the instruction within the module- Parameters:
lineNumber
- the line number
-
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
- 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 -
getProperty
Get a named property of the instruction- 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
-
getPublicId
Get the public ID of the module containing the instruction. This method is provided to satisfy the SourceLocator interface. However, the public ID is not maintained by Saxon, and the method always returns null- Specified by:
getPublicId
in interfaceLocator
- Specified by:
getPublicId
in interfaceSourceLocator
- Returns:
- null
-
setColumnNumber
public void setColumnNumber(int column) Set the column number -
getColumnNumber
public int getColumnNumber()Get the column number identifying the position of the instruction.- Specified by:
getColumnNumber
in interfaceLocator
- Specified by:
getColumnNumber
in interfaceSourceLocator
- Returns:
- -1 if column number is not known
-
getInstructionInfo
Get the InstructionInfo details about the construct. This is to satisfy the InstructionInfoProvider interface.- Specified by:
getInstructionInfo
in interfaceInstructionInfoProvider
-
getSystemId
Description copied from interface:LocationProvider
Get the URI of the document or module containing a particular location- Specified by:
getSystemId
in interfaceLocationProvider
- Parameters:
locationId
- identifier of the location in question (as passed down the Receiver pipeline)- Returns:
- the URI of the document or module.
-
getLineNumber
public int getLineNumber(int locationId) Description copied from interface:LocationProvider
Get the line number within the document or module containing a particular location- Specified by:
getLineNumber
in interfaceLocationProvider
- Parameters:
locationId
- identifier of the location in question (as passed down the Receiver pipeline)- Returns:
- the line number within the document or module.
-