<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:48:52 GMT 2011 --> <TITLE> net.sf.saxon.trace </TITLE> <META NAME="date" CONTENT="2011-12-09"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="net.sf.saxon.trace"; } } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <HR> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../net/sf/saxon/sxpath/package-summary.html"><B>PREV PACKAGE</B></A> <A HREF="../../../../net/sf/saxon/trans/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?net/sf/saxon/trace/package-summary.html" target="_top"><B>FRAMES</B></A> <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <H2> Package net.sf.saxon.trace </H2> This package provides an interface to Saxon tracing and debugging capabilities. <P> <B>See:</B> <BR> <A HREF="#package_description"><B>Description</B></A> <P> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Interface Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/trace/InstructionInfo.html" title="interface in net.sf.saxon.trace">InstructionInfo</A></B></TD> <TD>Information about an instruction in the stylesheet or a construct in a Query, made available at run-time to a TraceListener</TD> </TR> </TABLE> <P> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Class Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/trace/AbstractTraceListener.html" title="class in net.sf.saxon.trace">AbstractTraceListener</A></B></TD> <TD>This is the standard trace listener used when the -T option is specified on the command line.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/trace/ContextStackFrame.html" title="class in net.sf.saxon.trace">ContextStackFrame</A></B></TD> <TD>An entry on the context stack.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/trace/ContextStackFrame.ApplyTemplates.html" title="class in net.sf.saxon.trace">ContextStackFrame.ApplyTemplates</A></B></TD> <TD>Subclass of ContextStackFrame representing an xsl:apply-templates call in XSLT</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/trace/ContextStackFrame.BuiltInTemplateRule.html" title="class in net.sf.saxon.trace">ContextStackFrame.BuiltInTemplateRule</A></B></TD> <TD>Subclass of ContextStackFrame representing a built-in template rule in XSLT</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/trace/ContextStackFrame.CallingApplication.html" title="class in net.sf.saxon.trace">ContextStackFrame.CallingApplication</A></B></TD> <TD>Subclass of ContextStackFrame representing the outermost stack frame, for the calling application</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/trace/ContextStackFrame.CallTemplate.html" title="class in net.sf.saxon.trace">ContextStackFrame.CallTemplate</A></B></TD> <TD>Subclass of ContextStackFrame representing an xsl:call-template instruction in XSLT</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/trace/ContextStackFrame.FunctionCall.html" title="class in net.sf.saxon.trace">ContextStackFrame.FunctionCall</A></B></TD> <TD>Subclass of ContextStackFrame representing a call to a user-defined function either in XSLT or XQuery</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/trace/ContextStackFrame.VariableEvaluation.html" title="class in net.sf.saxon.trace">ContextStackFrame.VariableEvaluation</A></B></TD> <TD>Subclass of ContextStackFrame representing the evaluation of a variable (typically a global variable)</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/trace/ContextStackIterator.html" title="class in net.sf.saxon.trace">ContextStackIterator</A></B></TD> <TD>This class provides a representation of the current runtime call stack, as represented by the stack of XPathContext objects.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/trace/ExpressionPresenter.html" title="class in net.sf.saxon.trace">ExpressionPresenter</A></B></TD> <TD>This class handles the display of an abstract expression tree in an XML format with some slight resemblence to XQueryX</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/trace/Location.html" title="class in net.sf.saxon.trace">Location</A></B></TD> <TD>This class holds constants identifying different kinds of location in a source stylesheet or query.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/trace/TimingCodeInjector.html" title="class in net.sf.saxon.trace">TimingCodeInjector</A></B></TD> <TD>A code injector that wraps the body of a template or function in a TraceExpression, which causes the TimingTraceListener to be notified at the start and end of the function/template evaluation</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/trace/TimingTraceListener.html" title="class in net.sf.saxon.trace">TimingTraceListener</A></B></TD> <TD>A trace listener that records timing information for templates and functions, outputting this information as an HTML report to a specified destination when the transformation completes.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/trace/TraceCodeInjector.html" title="class in net.sf.saxon.trace">TraceCodeInjector</A></B></TD> <TD>A code injector that wraps every expression (other than a literal) in a TraceExpression, which causes a TraceListener to be notified when the expression is evaluated</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/trace/TraceEventMulticaster.html" title="class in net.sf.saxon.trace">TraceEventMulticaster</A></B></TD> <TD>A class which implements efficient and thread-safe multi-cast event dispatching for the TraceListener evants.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/trace/XQueryTraceListener.html" title="class in net.sf.saxon.trace">XQueryTraceListener</A></B></TD> <TD>A Simple trace listener for XQuery that writes messages (by default) to System.err</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/trace/XSLTTraceCodeInjector.html" title="class in net.sf.saxon.trace">XSLTTraceCodeInjector</A></B></TD> <TD>A code injector that wraps every expression (other than a literal) in a TraceExpression, which causes a TraceListener to be notified when the expression is evaluated</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/trace/XSLTTraceListener.html" title="class in net.sf.saxon.trace">XSLTTraceListener</A></B></TD> <TD>A Simple trace listener for XSLT that writes messages (by default) to System.err</TD> </TR> </TABLE> <P> <A NAME="package_description"><!-- --></A><H2> Package net.sf.saxon.trace Description </H2> <P> <p>This package provides an interface to Saxon tracing and debugging capabilities.</p> <p>The package was originally created by Edwin Glaser.</p> <p>The package includes three tracing modules that can be optionally selected: <code>XSLTTraceListener</code>, <code>XQueryTraceListener</code>, and <code>TimedTraceListener</code>. These all receive notification of the same events, but select and format the events in different ways to meet different requirements. Other events are notified through the <code>TraceListener</code> interface that are ignored by tracing applications, but may be of interest to debuggers.</p> <hr> <p align="center"><i>Michael H. Kay<br/> Saxonica Limited<br/> 9 February 2005</i></p> <P> <P> <DL> </DL> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../net/sf/saxon/sxpath/package-summary.html"><B>PREV PACKAGE</B></A> <A HREF="../../../../net/sf/saxon/trans/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?net/sf/saxon/trace/package-summary.html" target="_top"><B>FRAMES</B></A> <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> Copyright (c) 2004-2011 Saxonica Limited. All rights reserved. </BODY> </HTML>