Class TimingTraceListener

  • All Implemented Interfaces:

    public class TimingTraceListener
    extends java.lang.Object
    implements TraceListener
    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.
    • Constructor Detail

      • TimingTraceListener

        public TimingTraceListener()
    • Method Detail

      • setOutputDestination

        public void setOutputDestination​(Logger stream)
        Set the PrintStream to which the output will be written.
        Specified by:
        setOutputDestination in interface TraceListener
        stream - the PrintStream to be used for output. By default, the output is written to System.err.
      • setStylesheet

        public void setStylesheet​( stylesheet)
        Set the URI of the stylesheet to be used for formatting the results
        stylesheet - the URI of the stylesheet
      • open

        public void open​(Controller controller)
        Called at start
        Specified by:
        open in interface TraceListener
        controller - identifies the transformation controller, and provides the listener with access to context and configuration information
      • close

        public void close()
        Called at end. This method builds the XML out and analyzed html output
        Specified by:
        close in interface TraceListener
      • enter

        public void enter​(Traceable instruction,
                          java.util.Map<java.lang.String,​java.lang.Object> properties,
                          XPathContext context)
        Called when an instruction in the stylesheet gets processed
        Specified by:
        enter in interface TraceListener
        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.
        properties - extra information about the instruction to be included in the trace
        context - the XPath evaluation context
      • leave

        public void leave​(Traceable instruction)
        Called after an instruction of the stylesheet got processed
        Specified by:
        leave in interface TraceListener
        instruction - the instruction or other construct that has now finished execution
      • startCurrentItem

        public void startCurrentItem​(Item item)
        Called when an item becomes current
        Specified by:
        startCurrentItem in interface TraceListener
        item - 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 item)
        Called after a node of the source tree got processed
        Specified by:
        endCurrentItem in interface TraceListener
        item - 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.
      • getStyleSheet

        protected PreparedStylesheet getStyleSheet()
                                            throws XPathException
        Prepare Stylesheet to render the analyzed XML data out. This method can be overridden in a subclass to produce the output in a different format.
      • getStylesheetInputStream

        protected getStylesheetInputStream()
        Get an input stream containing the stylesheet used for formatting results. The method is protected so that a user-written stylesheet can be supplied in a subclass.
        the input stream containing the stylesheet for processing the results.