de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies

Class AbstractResultFormatter

java.lang.Object

de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.AbstractResultFormatter

All Implemented Interfaces:

ResultFormatter

Direct Known Subclasses:

TabFormatter

public abstract class AbstractResultFormatter
extends java.lang.Object
implements ResultFormatter

An abstract implementation of the resource formatter as a basis for implementations.

Since:

1.00

Version:

1.00

Author:

Holger Eichelberger

Nested Class Summary

Nested classes/interfaces inherited from interface de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.ResultFormatter

ResultFormatter.InfoCategory

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.StringBuilder	builder An internal buffer.
private ProcessData	data Stores the JVM and process measurements.
private java.util.Formatter	formatter Stores an instance of the formatter usually used to produce printf outputs.
private java.io.PrintStream	out Stores the current output stream.
private char	separator Stores the value columns separator char.
private boolean	showPercentages Stores if percentages or absolute values should be emitted.
private RecorderElement	total Stores the recorder element to compare against (usually the program record).

Constructor Summary

Constructors

Constructor and Description
AbstractResultFormatter()

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.
static boolean	excludeId(java.lang.String id) Returns if an id should be excluded from printing.
protected long	getIoRead(ProcessData.Measurements measurements) Returns the total (corrected) bytes read from external input.
protected long	getIoWrite(ProcessData.Measurements measurements) Returns the total (corrected) bytes written to external output.
protected ProcessData.Measurements	getJvmData() Returns the JVM data taken from the process data stored by setProcessData(ProcessData).
protected java.io.PrintStream	getOut() Returns the currently active output stream.
protected ProcessData.Measurements	getSystemData() Returns the system data taken from the process data stored by setProcessData(ProcessData).
protected RecorderElement	getTotal() Returns the total element to compare against.
boolean	isConfigured() Returns if this instance was configured by calling configure(PrintStream, RecorderElement, boolean).
protected void	print(double value) Emits a double value (two decimal places) and a column separator.
protected void	print(float value) Emits a float value (two decimal places) and a column separator.
protected void	print(int value) Emits an int value and a column separator.
protected void	print(long value) Emits a long value and a column separator.
protected void	print(java.lang.String string) Emits a string and a column separator.
protected void	printf(java.lang.String format, java.lang.Object... args) Writes a formatted string to this object's destination using the specified format string and arguments.
protected void	println() Emits a new empty line.
protected void	printNanoTime(long nano) Emits a nano time value (formatted) and a column separator.
protected void	printPercentage(double value) Emits a percentage value (two decimal places) and a column separator.
protected void	printPercentage(double fraction, double total) Prints a percentage or fraction dependent on showPercentages.
protected void	printPercentage(long fraction, long total) Prints a percentage or fraction dependent on showPercentages.
protected void	printPercentageNanoPrefix(long fraction, long total) Prints a percentage or fraction dependent on showPercentages with time prefix of interpreting the values as nano seconds and deriving the time unit.
protected void	printSeparator() Prints the column separator.
void	setProcessData(ProcessData data) Sets the data on system and JVM process data for printout.
protected void	setSeparator(char separator) Changes the value column separator.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.ResultFormatter

printCompare, printCurrentStateStatistics, printCurrentStateStatisticsFooter, printHeadline, printIndividual, printInfo, printProcessStatistics, printThreadData

Field Detail

builder

private java.lang.StringBuilder builder

An internal buffer.

formatter

private java.util.Formatter formatter

Stores an instance of the formatter usually used to produce printf outputs. We need an own instance here because the one in System.out may cause deadlocks. :(

out

private java.io.PrintStream out

Stores the current output stream.

total

private RecorderElement total

Stores the recorder element to compare against (usually the program record).

showPercentages

private boolean showPercentages

Stores if percentages or absolute values should be emitted.

separator

private char separator

Stores the value columns separator char.

data

private ProcessData data

Stores the JVM and process measurements.

Constructor Detail

AbstractResultFormatter

public AbstractResultFormatter()

Method Detail

excludeId

public static boolean excludeId(java.lang.String id)

Returns if an id should be excluded from printing. [DEBUG ONLY]

Parameters:

id - the id to be tested

Returns:

if it should be excluded

Since:

1.00

clear

public void clear()

Clears all basic data for reuse of this instance.

Specified by:

clear in interface ResultFormatter

configure

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

Defines the basic data for output. Should be followed by a call to setProcessData(ProcessData).

Specified by:

configure in interface ResultFormatter

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

public boolean isConfigured()

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

Specified by:

isConfigured in interface ResultFormatter

Returns:

true if it was configured, false else

Since:

1.00

printf

protected void printf(java.lang.String format,
                      java.lang.Object... args)

Writes a formatted string to this object's destination using the specified format string and arguments. The locale used is the one defined during the construction of this formatter.

Parameters:

format - A format string as described in the Java API documentation.

args - Arguments referenced by the format specifiers in the format string.

setSeparator

protected void setSeparator(char separator)

Changes the value column separator.

Parameters:

separator - the value column separator

Since:

1.00

getOut

protected java.io.PrintStream getOut()

Returns the currently active output stream.

Returns:

the currently active output stream

Since:

1.00

setProcessData

public void setProcessData(ProcessData data)

Sets the data on system and JVM process data for printout.

Specified by:

setProcessData in interface ResultFormatter

Parameters:

data - the process data object

Since:

1.00

getJvmData

protected ProcessData.Measurements getJvmData()

Returns the JVM data taken from the process data stored by setProcessData(ProcessData).

Returns:

the JVM measurements object, do not keep this reference (may be null)

Since:

1.00

getSystemData

protected ProcessData.Measurements getSystemData()

Returns the system data taken from the process data stored by setProcessData(ProcessData). Please use getIoRead(de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.ProcessData.Measurements) instead of ProcessData.Measurements.getIoRead() and getIoWrite(de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.ProcessData.Measurements) instead of ProcessData.Measurements.getIoWrite() as the method in this class considers the values from total in case that no network or file statistics are provided.

Returns:

the system measurements object, do not keep this reference (may be null)

Since:

1.00

getIoRead

protected long getIoRead(ProcessData.Measurements measurements)

Returns the total (corrected) bytes read from external input. This method considers ProcessData.Measurements.getStatus() and corrects the values if needed based on total. This is needed because some concrete platforms may not support I/O process accounting.

Parameters:

measurements - the measurements object

Returns:

the (corrected) number of bytes read from external input

Since:

1.00

getIoWrite

protected long getIoWrite(ProcessData.Measurements measurements)

Returns the total (corrected) bytes written to external output. This method considers ProcessData.Measurements.getStatus() and corrects the values if needed based on total. This is needed because some concrete platforms may not support I/O process accounting.

Parameters:

measurements - the measurements object

Returns:

the (corrected) number of bytes written to external output

Since:

1.00

getTotal

protected RecorderElement getTotal()

Returns the total element to compare against.

Returns:

the total element

Since:

1.00

printSeparator

protected void printSeparator()

Prints the column separator.

Since:

1.00

printPercentage

protected void printPercentage(double fraction,
                               double total)

Prints a percentage or fraction dependent on showPercentages.

Parameters:

fraction - the fraction determining the percentage

total - the value for 100%

Since:

1.00

printPercentage

protected void printPercentage(long fraction,
                               long total)

Prints a percentage or fraction dependent on showPercentages.

Parameters:

fraction - the fraction determining the percentage

total - the value for 100%

Since:

1.00

printPercentageNanoPrefix

protected void printPercentageNanoPrefix(long fraction,
                                         long total)

Prints a percentage or fraction dependent on showPercentages with time prefix of interpreting the values as nano seconds and deriving the time unit.

Parameters:

fraction - the fraction determining the percentage

total - the value for 100%

Since:

1.00

printNanoTime

protected void printNanoTime(long nano)

Emits a nano time value (formatted) and a column separator.

Parameters:

nano - the nano value to be emitted

Since:

1.00

print

protected void print(java.lang.String string)

Emits a string and a column separator.

Parameters:

string - the string to be emitted

Since:

1.00

print

protected void print(int value)

Emits an int value and a column separator.

Parameters:

value - the value to be emitted

Since:

1.00

print

protected void print(long value)

Emits a long value and a column separator.

Parameters:

value - the value to be emitted

Since:

1.00

print

protected void print(double value)

Emits a double value (two decimal places) and a column separator.

Parameters:

value - the value to be emitted

Since:

1.00

print

protected void print(float value)

Emits a float value (two decimal places) and a column separator.

Parameters:

value - the value to be emitted

Since:

1.00

printPercentage

protected void printPercentage(double value)

Emits a percentage value (two decimal places) and a column separator.

Parameters:

value - the value to be emitted

Since:

1.00

println

protected void println()

Emits a new empty line.

Since:

1.00