net.sf.saxon.trace

Class RuleTraceListener

java.lang.Object

net.sf.saxon.trace.RuleTraceListener

All Implemented Interfaces:

EventListener, TraceListener, TraceListener2

public class RuleTraceListener
extends Object
implements TraceListener2

A trace listener that is specifically for tracing the application and time costs of pattern matching.

Constructor Summary

Constructors

Constructor and Description
RuleTraceListener()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Method called at the end of execution, that is, when the run-time execution ends
void	endCurrentItem(Item currentItem) Method that is called when an instruction has finished processing a new current item and is ready to select a new current item or revert to the previous current item.
void	endRuleSearch(Object rule, Mode mode, Item item) Called at the end of a rule search
void	enter(InstructionInfo instruction, XPathContext context) Method that is called when an instruction in the stylesheet gets processed.
void	leave(InstructionInfo instruction) Method that is called after processing an instruction of the stylesheet, that is, after any child instructions have been processed.
void	open(Controller controller) Called at start
void	setOutputDestination(Logger stream) Set the PrintStream to which the output will be written.
void	setSourceId(String sourceId)
void	setXslId(String xslId)
void	startCurrentItem(Item currentItem) Method that is called by an instruction that changes the current item in the source document: that is, xsl:for-each, xsl:apply-templates, xsl:for-each-group.
void	startRuleSearch() Method called when a search for a template rule is about to start

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RuleTraceListener

public RuleTraceListener()

Method Detail

setXslId

public void setXslId(String xslId)

setSourceId

public void setSourceId(String sourceId)

setOutputDestination

public void setOutputDestination(Logger stream)

Set the PrintStream to which the output will be written.

Specified by:

setOutputDestination in interface TraceListener

Parameters:

stream - the PrintStream to be used for output. By default, the output is written to System.err.

Throws:

XPathException

XMLStreamException

open

public void open(Controller controller)

Called at start

Specified by:

open in interface TraceListener

Parameters:

controller - identifies the transformation controller, and provides the listener with access to context and configuration information

startRuleSearch

public void startRuleSearch()

Description copied from interface: TraceListener2

Method called when a search for a template rule is about to start

Specified by:

startRuleSearch in interface TraceListener2

endRuleSearch

public void endRuleSearch(Object rule,
                 Mode mode,
                 Item item)

Called at the end of a rule search

Specified by:

endRuleSearch in interface TraceListener2

Parameters:

rule - the rule (or possible built-in ruleset) that has been selected

mode - the mode in operation

item -

close

public void close()

Description copied from interface: TraceListener

Method called at the end of execution, that is, when the run-time execution ends

Specified by:

close in interface TraceListener

enter

public void enter(InstructionInfo instruction,
         XPathContext context)

Description copied from interface: TraceListener

Method that is called when an instruction in the stylesheet gets processed.

Specified by:

enter in interface TraceListener

Parameters:

instruction - gives information about the instruction being executed, and about the context in which it is executed. This object is mutable, so if information from the InstructionInfo is to be retained, it must be copied.

leave

public void leave(InstructionInfo instruction)

Description copied from interface: TraceListener

Method that is called after processing an instruction of the stylesheet, that is, after any child instructions have been processed.

Specified by:

leave in interface TraceListener

Parameters:

instruction - gives the same information that was supplied to the enter method, though it is not necessarily the same object. Note that the line number of the instruction is that of the start tag in the source stylesheet, not the line number of the end tag.

startCurrentItem

public void startCurrentItem(Item currentItem)

Description copied from interface: TraceListener

Method that is called by an instruction that changes the current item in the source document: that is, xsl:for-each, xsl:apply-templates, xsl:for-each-group. The method is called after the enter method for the relevant instruction, and is called once for each item processed.

Specified by:

startCurrentItem in interface TraceListener

Parameters:

currentItem - the new current item. Item objects are not mutable; it is safe to retain a reference to the Item for later use.

endCurrentItem

public void endCurrentItem(Item currentItem)

Description copied from interface: TraceListener

Method that is called when an instruction has finished processing a new current item and is ready to select a new current item or revert to the previous current item. The method will be called before the leave() method for the instruction that made this item current.

Specified by:

endCurrentItem in interface TraceListener

Parameters:

currentItem - the item that was current, whose processing is now complete. This will represent the same underlying item as the corresponding startCurrentItem() call, though it will not necessarily be the same actual object.