net.sf.saxon.instruct

Class InstructionDetails

Implemented Interfaces:
InstructionInfo, Locator, InstructionInfoProvider, LocationProvider, SaxonLocator, Serializable, SourceLocator

public final class InstructionDetails
extends java.lang.Object
implements InstructionInfo, InstructionInfoProvider, Serializable

Details about an instruction, used when reporting errors and when tracing

Constructor Summary

InstructionDetails()

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(long locationId)
NamespaceResolver
getNamespaceResolver()
Get the namespace resolver to supply the namespace context of the instruction that is being traced
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 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(long 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
setObjectName(StructuredQName qName)
Set a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc.
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

Constructor Details

InstructionDetails

public InstructionDetails()

Method Details

getColumnNumber

public int getColumnNumber()
Get the column number identifying the position of the instruction.
Returns:
-1 if column number is not known

getConstructType

public int getConstructType()
Get the construct type
Specified by:
getConstructType in interface InstructionInfo

getInstructionInfo

public InstructionInfo getInstructionInfo()
Get the InstructionInfo details about the construct. This is to satisfy the InstructionInfoProvider interface.
Specified by:
getInstructionInfo in interface InstructionInfoProvider

getLineNumber

public int getLineNumber()
Get the line number of the instruction within its module
Specified by:
getLineNumber in interface InstructionInfo
Returns:
the line number

getLineNumber

public int getLineNumber(long locationId)
Specified by:
getLineNumber in interface LocationProvider

getNamespaceResolver

public NamespaceResolver getNamespaceResolver()
Get the namespace resolver to supply the namespace context of the instruction that is being traced
Specified by:
getNamespaceResolver in interface InstructionInfo

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.
Specified by:
getObjectName in interface InstructionInfo
Parameters:
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.
Specified by:
getProperties in interface InstructionInfo

getProperty

public Object getProperty(String name)
Get a named property of the instruction
Specified by:
getProperty in interface InstructionInfo

getPublicId

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

getSystemId

public String getSystemId()
Get the URI of the module containing the instruction
Specified by:
getSystemId in interface InstructionInfo
Returns:
the module's URI

getSystemId

public String getSystemId(long locationId)
Specified by:
getSystemId in interface LocationProvider

setColumnNumber

public void setColumnNumber(int column)
Set the column number

setConstructType

public void setConstructType(int type)
Set the type of construct

setLineNumber

public void setLineNumber(int lineNumber)
Set the line number of the instruction within the module
Parameters:
lineNumber - the line number

setNamespaceResolver

public void setNamespaceResolver(NamespaceResolver resolver)
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

setObjectName

public void setObjectName(StructuredQName qName)
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.

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.

setProperty

public void setProperty(String name,
                        Object value)
Set a named property of the instruction

setSystemId

public void setSystemId(String systemId)
Set the URI of the module containing the instruction
Parameters:
systemId - the module's URI