net.sf.saxon.instruct

Class InstructionDetails

public final class InstructionDetails extends Object implements InstructionInfo, Serializable

Details about an instruction, used when reporting errors and when tracing
Constructor Summary
InstructionDetails()
Method Summary
intgetColumnNumber()
Get the column number identifying the position of the instruction.
intgetColumnNumber(long locationId)
intgetConstructType()
Get the construct type
InstructionInfogetInstructionInfo()
Get the InstructionInfo details about the construct.
intgetLineNumber()
Get the line number of the instruction within its module
intgetLineNumber(long locationId)
StructuredQNamegetObjectName()
Get a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc.
IteratorgetProperties()
Get an iterator over all the properties available.
ObjectgetProperty(String name)
Get a named property of the instruction
StringgetPublicId()
Get the public ID of the module containing the instruction.
StringgetSystemId()
Get the URI of the module containing the instruction
StringgetSystemId(long locationId)
voidsetColumnNumber(int column)
Set the column number
voidsetConstructType(int type)
Set the type of construct
voidsetLineNumber(int lineNumber)
Set the line number of the instruction within the module
voidsetObjectName(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.
voidsetProperty(String name, Object value)
Set a named property of the instruction
voidsetSystemId(String systemId)
Set the URI of the module containing the instruction

Constructor Detail

InstructionDetails

public InstructionDetails()

Method Detail

getColumnNumber

public int getColumnNumber()
Get the column number identifying the position of the instruction.

Returns: -1 if column number is not known

getColumnNumber

public int getColumnNumber(long locationId)

getConstructType

public int getConstructType()
Get the construct type

getInstructionInfo

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

getLineNumber

public int getLineNumber()
Get the line number of the instruction within its module

Returns: the line number

getLineNumber

public int getLineNumber(long locationId)

getObjectName

public StructuredQName getObjectName()
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.

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.

getProperty

public Object getProperty(String name)
Get a named property of the instruction

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

Returns: the module's URI

getSystemId

public String getSystemId(long locationId)

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

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.

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