Package net.sf.saxon.instruct
Class InstructionDetails
- java.lang.Object
-
- net.sf.saxon.instruct.InstructionDetails
-
- All Implemented Interfaces:
java.io.Serializable
,javax.xml.transform.SourceLocator
,LocationProvider
,SaxonLocator
,InstructionInfo
,InstructionInfoProvider
,org.xml.sax.Locator
public final class InstructionDetails extends java.lang.Object implements InstructionInfo, InstructionInfoProvider, java.io.Serializable
Details about an instruction, used when reporting errors and when tracing- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description InstructionDetails()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getColumnNumber()
Get the column number identifying the position of the instruction.int
getConstructType()
Get the construct typeInstructionInfo
getInstructionInfo()
Get the InstructionInfo details about the construct.int
getLineNumber()
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 locationNamespaceResolver
getNamespaceResolver()
Get the namespace resolver to supply the namespace context of the instruction that is being tracedint
getObjectNameCode()
Get a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc.java.util.Iterator
getProperties()
Get an iterator over all the properties available.java.lang.Object
getProperty(java.lang.String name)
Get a named property of the instructionjava.lang.String
getPublicId()
Get the public ID of the module containing the instruction.java.lang.String
getSystemId()
Get the URI of the module containing the instructionjava.lang.String
getSystemId(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(java.lang.String name, java.lang.Object value)
Set a named property of the instructionvoid
setSystemId(java.lang.String systemId)
Set the URI of the module containing the instruction
-
-
-
Method Detail
-
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
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
-
getNamespaceResolver
public NamespaceResolver getNamespaceResolver()
Get the namespace resolver to supply the namespace context of the instruction that is being traced- Specified by:
getNamespaceResolver
in interfaceInstructionInfo
-
setSystemId
public void setSystemId(java.lang.String systemId)
Set the URI of the module containing the instruction- Parameters:
systemId
- the module's URI
-
getSystemId
public java.lang.String getSystemId()
Get the URI of the module containing the instruction- Specified by:
getSystemId
in interfaceInstructionInfo
- Specified by:
getSystemId
in interfaceorg.xml.sax.Locator
- Specified by:
getSystemId
in interfacejavax.xml.transform.SourceLocator
- 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 interfaceorg.xml.sax.Locator
- Specified by:
getLineNumber
in interfacejavax.xml.transform.SourceLocator
- 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
public void setProperty(java.lang.String name, java.lang.Object value)
Set a named property of the instruction
-
getProperty
public java.lang.Object getProperty(java.lang.String name)
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
public java.util.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 interfaceInstructionInfo
-
getPublicId
public java.lang.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- Specified by:
getPublicId
in interfaceorg.xml.sax.Locator
- Specified by:
getPublicId
in interfacejavax.xml.transform.SourceLocator
- 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 interfaceorg.xml.sax.Locator
- Specified by:
getColumnNumber
in interfacejavax.xml.transform.SourceLocator
- Returns:
- -1 if column number is not known
-
getInstructionInfo
public InstructionInfo getInstructionInfo()
Get the InstructionInfo details about the construct. This is to satisfy the InstructionInfoProvider interface.- Specified by:
getInstructionInfo
in interfaceInstructionInfoProvider
-
getSystemId
public java.lang.String getSystemId(int locationId)
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.
-
-