net.sf.saxon.trace

Class AbstractTraceListener

Implemented Interfaces:
EventListener, TraceListener
Known Direct Subclasses:
XQueryTraceListener, XSLTTraceListener

public abstract class AbstractTraceListener
extends java.lang.Object
implements TraceListener

This is the standard trace listener used when the -T option is specified on the command line. There are two variants, represented by subclasses: one for XSLT, and one for XQuery. The two variants differ in that they present the trace output in terms of constructs used in the relevant host language.

Method Summary

void
close()
Called at end
void
endCurrentItem(Item item)
Called after a node of the source tree got processed
void
enter(InstructionInfo info, XPathContext context)
Called when an instruction in the stylesheet gets processed
String
escape(String in)
Escape a string for XML output (in an attribute delimited by double quotes).
protected abstract String
getOpeningAttributes()
PrintStream
getOutputDestination()
Get the output destination
void
leave(InstructionInfo info)
Called after an instruction of the stylesheet got processed
void
open()
Called at start
void
setOutputDestination(PrintStream stream)
Set the output destination (default is System.err)
void
startCurrentItem(Item item)
Called when an item becomes the context item
protected abstract String
tag(int construct)

Method Details

close

public void close()
Called at end
Specified by:
close in interface TraceListener

endCurrentItem

public void endCurrentItem(Item item)
Called after a node of the source tree got processed
Specified by:
endCurrentItem in interface TraceListener

enter

public void enter(InstructionInfo info,
                  XPathContext context)
Called when an instruction in the stylesheet gets processed
Specified by:
enter in interface TraceListener

escape

public String escape(String in)
Escape a string for XML output (in an attribute delimited by double quotes). This method also collapses whitespace (since the value may be an XPath expression that was originally written over several lines).

getOpeningAttributes

protected abstract String getOpeningAttributes()

getOutputDestination

public PrintStream getOutputDestination()
Get the output destination

leave

public void leave(InstructionInfo info)
Called after an instruction of the stylesheet got processed
Specified by:
leave in interface TraceListener

open

public void open()
Called at start
Specified by:
open in interface TraceListener

setOutputDestination

public void setOutputDestination(PrintStream stream)
Set the output destination (default is System.err)
Parameters:
stream - the output destination for tracing output

startCurrentItem

public void startCurrentItem(Item item)
Called when an item becomes the context item
Specified by:
startCurrentItem in interface TraceListener

tag

protected abstract String tag(int construct)