de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies

Interface ResultFormatter

All Known Implementing Classes:

AbstractResultFormatter, TabFormatter

public interface ResultFormatter

A formatter for emitting out monitoring results. First method of using this interface should be configure(java.io.PrintStream, de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.RecorderElement, boolean) and setProcessData(ProcessData).

Since:

1.00

Version:

1.00

Author:

Holger Eichelberger

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ResultFormatter.InfoCategory Defines some information categories to be printed as additional information.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all basic data for reuse of this instance.
void	configure(java.io.PrintStream out, RecorderElement total, boolean showPercentages) Defines the basic data for output.
boolean	isConfigured() Returns if this instance was configured by calling configure(PrintStream, RecorderElement, boolean).
void	printCompare(java.lang.String description, RecorderElement individual, boolean system) Prints a comparison among the individual element and the total element defined in setProcessData(de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.ProcessData).
void	printCurrentStateStatistics(RecorderElementMap elements, RecorderElement programRecord, RecorderElement overheadRecord) Prints the current (aggregated) state.
void	printCurrentStateStatisticsFooter(RecorderElementMap elements, RecorderElement programRecord, RecorderElement overheadRecord) Prints a footer for the runtime statistics section.
void	printHeadline() Prints out the headline describing the data columns.
void	printIndividual(java.lang.String description, RecorderElement individual) Prints out an individual recorder element.
void	printInfo(ResultFormatter.InfoCategory info) Prints some additional information categorizing the printout.
void	printProcessStatistics() Prints out the min/avg/max statistics for the system and the virtual machine.
void	printThreadData(java.lang.String description, ThreadData thread) Prints the information for an individual thread.
void	setProcessData(ProcessData data) Sets the current process data object for comparisons.

Method Detail

configure

void configure(java.io.PrintStream out,
               RecorderElement total,
               boolean showPercentages)

Defines the basic data for output.

Parameters:

out - the target output stream

total - the recorder element representing the entire program

showPercentages - should percentages be printed or absolute values instead

Since:

1.00

isConfigured

boolean isConfigured()

Returns if this instance was configured by calling configure(PrintStream, RecorderElement, boolean).

Returns:

true if it was configured, false else

Since:

1.00

setProcessData

void setProcessData(ProcessData data)

Sets the current process data object for comparisons.

Parameters:

data - the process data object with system and JVM measurements (may be null)

Since:

1.00

printThreadData

void printThreadData(java.lang.String description,
                     ThreadData thread)

Prints the information for an individual thread.

Parameters:

description - an additional description to be printed

thread - the thread information to be printed

Since:

1.00

printProcessStatistics

void printProcessStatistics()

Prints out the min/avg/max statistics for the system and the virtual machine.

printIndividual

void printIndividual(java.lang.String description,
                     RecorderElement individual)

Prints out an individual recorder element.

Parameters:

description - a description of the element to be printed out

individual - the individual element to be emitted

Since:

1.00

printHeadline

void printHeadline()

Prints out the headline describing the data columns.

printCompare

void printCompare(java.lang.String description,
                  RecorderElement individual,
                  boolean system)

Prints a comparison among the individual element and the total element defined in setProcessData(de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.ProcessData).

Parameters:

description - a description on the elements being compared

individual - the individual element to be compared with the total element

system - true if a comparison to system level properties, false if a comparison to JVM level properties should be done

Since:

1.00

printInfo

void printInfo(ResultFormatter.InfoCategory info)

Prints some additional information categorizing the printout.

Parameters:

info - the category to be printed

Since:

1.00

clear

void clear()

Clears all basic data for reuse of this instance.

printCurrentStateStatistics

void printCurrentStateStatistics(RecorderElementMap elements,
                                 RecorderElement programRecord,
                                 RecorderElement overheadRecord)

Prints the current (aggregated) state. This method needs an appropriate call of setProcessData(ProcessData) before.

Parameters:

elements - all (current) elements

programRecord - the program record

overheadRecord - the overhead record

Since:

1.00

printCurrentStateStatisticsFooter

void printCurrentStateStatisticsFooter(RecorderElementMap elements,
                                       RecorderElement programRecord,
                                       RecorderElement overheadRecord)

Prints a footer for the runtime statistics section. This method needs an appropriate call of setProcessData(ProcessData) before.

Parameters:

elements - all (current) elements

programRecord - the program record

overheadRecord - the overhead record

Since:

1.00