net.sf.saxon.instruct
Class InstructionDetails
public final
class
InstructionDetails
extends Object
implements InstructionInfo, InstructionInfoProvider, Serializable
Details about an instruction, used when reporting errors and when tracing
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) |
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 |
String | getPublicId()
Get the public ID of the module containing the instruction. |
String | getSystemId()
Get the URI of the module containing the instruction |
String | getSystemId(int locationId) |
void | setColumnNumber(int column)
Set the column number |
void | setConstructType(int type)
Set the type of construct |
void | setLineNumber(int lineNumber)
Set the line number of the instruction within the module |
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 |
void | setSystemId(String systemId)
Set the URI of the module containing the instruction |
public InstructionDetails()
public int getColumnNumber()
Get the column number identifying the position of the instruction.
Returns: -1 if column number is not known
public int getConstructType()
Get the construct type
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 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
public String 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
Returns: null
public String getSystemId()
Get the URI of the module containing the instruction
Returns: the module's URI
public String getSystemId(int locationId)
public void setColumnNumber(int column)
Set the column number
public void setConstructType(int type)
Set the type of construct
public void setLineNumber(int lineNumber)
Set the line number of the instruction within the module
Parameters: lineNumber the line number
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
public void setSystemId(String systemId)
Set the URI of the module containing the instruction
Parameters: systemId the module's URI