org.perfcake.reporting

Class Measurement

java.lang.Object

org.perfcake.reporting.Measurement

public class Measurement
extends Object

Measurement is a product of Reporter. It is typically a combination of multiple Measuremen Units. The way they are combined is the matter of a particular Reporter implementation.

Author:

Pavel Macík, Martin Večeřa

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_RESULT The default result name.

Constructor Summary

Constructors

Constructor and Description
Measurement(long percentage, long time, long iteration) Creates a new instance of Measurement.

Method Summary

Modifier and Type	Method and Description
Object	get() Gets a default result from the result map.
Object	get(String name) Gets the result with the given name.
Map<String,Object>	getAll() Gets the map with the measured results.
long	getIteration() Gets the number of iteration to which the Measurement is related.
long	getPercentage() Gets the percentage value of progress of the scenario execution.
long	getTime() Gets the time of the scenario execution in milliseconds.
void	remove(String name) Removes the result stored under the given name from the results map.
void	set(Object result) Puts the default result in the result map.
void	set(String name, Object result) Puts the result in the result map with a given name used as a key.
void	setAll(Map<String,Object> newResults) Puts all the results from the result map into the measurement.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_RESULT

public static final String DEFAULT_RESULT

The default result name.

See Also:

Constant Field Values

Constructor Detail

Measurement

public Measurement(long percentage,
                   long time,
                   long iteration)

Creates a new instance of Measurement.

Parameters:

percentage - The current progress of the scenario execution in percents.

time - The current time of the scenario execution.

iteration - The current iteration of the scenario execution.

Method Detail

getPercentage

public long getPercentage()

Gets the percentage value of progress of the scenario execution.

Returns:

The percentage progress of the execution.

getTime

public long getTime()

Gets the time of the scenario execution in milliseconds.

Returns:

The time of the execution.

getIteration

public long getIteration()

Gets the number of iteration to which the Measurement is related.

Returns:

The iteration of the execution.

getAll

public Map<String,Object> getAll()

Gets the map with the measured results.

Returns:

The measured results.

get

public Object get()

Gets a default result from the result map. The default value is placed in the result map under DEFAULT_RESULT key.

Returns:

The default result.

get

public Object get(String name)

Gets the result with the given name.

Parameters:

name - The name of the result to get.

Returns:

The result value.

set

public void set(String name,
                Object result)

Puts the result in the result map with a given name used as a key.

Parameters:

name - The name of the result.

result - The result value.

set

public void set(Object result)

Puts the default result in the result map. The default value is placed in the result map under DEFAULT_RESULT key.

Parameters:

result - The default result value.

remove

public void remove(String name)

Removes the result stored under the given name from the results map.

Parameters:

name - The name of the result to be removed.

setAll

public void setAll(Map<String,Object> newResults)

Puts all the results from the result map into the measurement.

Parameters:

newResults - New results to be added.

toString

public String toString()

Overrides:

toString in class Object