Package org.palladiosimulizar.aggregation.aggregators

Class VariableSizeMeasurementAggregator

java.lang.Object

org.palladiosimulator.simulizar.metrics.PRMRecorder

org.palladiosimulizar.aggregation.aggregators.AbstractMeasurementAggregator

org.palladiosimulizar.aggregation.aggregators.VariableSizeMeasurementAggregator

All Implemented Interfaces:

org.palladiosimulator.measurementframework.listener.IMeasurementSourceListener

public class VariableSizeMeasurementAggregator
extends AbstractMeasurementAggregator

Implementation of the AbstractMeasurementAggregator class dedicated to aggregate a variable number of measurements and to forward the aggregation result to a RuntimeMeasurementModel.

Constructor Summary

Constructors

Constructor	Description
VariableSizeMeasurementAggregator(org.palladiosimulator.metricspec.NumericalBaseMetricDescription expectedMetric, RuntimeMeasurementModel runtimeMeasurementModel, org.palladiosimulator.monitorrepository.VariableSizeAggregation variableSizeAggregation)	Initializes a new instance of the VariableSizeMeasurementAggregator class with the given parameters.

Method Summary

Modifier and Type	Method	Description
protected boolean	aggregationRequired()	This method has to be implemented by all subclasses.
void	clear()	Discards all measurements collected for aggregation.
protected void	collectMeasurement(org.palladiosimulator.measurementframework.MeasuringValue newMeasurement)	This method has to be implemented by subclasses to collect a new measurement for aggregation.
protected Iterable<org.palladiosimulator.measurementframework.MeasuringValue>	getDataToAggregate()	Gets the sequence of measurements to be aggregated.
protected org.jscience.physics.amount.Amount<javax.measure.quantity.Duration>	getIntervalEndTime()	Gets the right (upper) bound of the interval that all measurements that are aggregated lie in.
protected org.jscience.physics.amount.Amount<javax.measure.quantity.Duration>	getIntervalStartTime()	Gets the left (lower) bound of the interval that all measurements that are aggregated lie in.
protected void	onPreAggregate()	This method is invoked directly before an aggregation of the measurements is to be performed and is intended to be overriden by subclasses to include implementation-specific behavior.

Methods inherited from class org.palladiosimulizar.aggregation.aggregators.AbstractMeasurementAggregator

decrementCounter, getExpectedMetric, getPointInTimeOfMeasurement, newMeasurementAvailable, onPostAggregate, preUnregister, resetCounter

Methods inherited from class org.palladiosimulator.simulizar.metrics.PRMRecorder

detachFromPRM, getMeasurementSpecification, getPRMMeasurement, getPrmModel, updateMeasurementValue

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableSizeMeasurementAggregator

public VariableSizeMeasurementAggregator(org.palladiosimulator.metricspec.NumericalBaseMetricDescription expectedMetric,
                                         RuntimeMeasurementModel runtimeMeasurementModel,
                                         org.palladiosimulator.monitorrepository.VariableSizeAggregation variableSizeAggregation)

Initializes a new instance of the VariableSizeMeasurementAggregator class with the given parameters.

Parameters:

expectedMetric - The expected NumericalBaseMetricDescription of the aggregated measurements to be forwarded to the runtime measurement model.

prmAccess - The RuntimeMeasurementModel where the aggregation results are forwarded to.

aggregation - The VariableSizeAggregation model element specifying the properties of measurement aggregation.

Throws:

NullPointerException - In case any of the parameters is null.

IllegalStateException - If the value of the 'Retrospection Length' attribute of the passed VariableSizeAggregation is not positive.

Method Detail

clear

public void clear()

Description copied from class: AbstractMeasurementAggregator

Discards all measurements collected for aggregation.

Specified by:

clear in class AbstractMeasurementAggregator

aggregationRequired

protected boolean aggregationRequired()

Description copied from class: AbstractMeasurementAggregator

This method has to be implemented by all subclasses. It is invoked by this instance each time a new measurements has been collected, i.e., directly after AbstractMeasurementAggregator.collectMeasurement(MeasuringValue) and AbstractMeasurementAggregator.decrementCounter() have been invoked, and the counter for the next upcoming aggregation has reached zero.
In case an aggregation is required, it is directly performed hereafter, yet preceded by the invocation of AbstractMeasurementAggregator.onPreAggregate() and followed by the invocation of AbstractMeasurementAggregator.onPostAggregate() and AbstractMeasurementAggregator.resetCounter().

Specified by:

aggregationRequired in class AbstractMeasurementAggregator

Returns:

true if an aggregation of the collected measurements shall be triggered, false otherwise.

See Also:

AbstractMeasurementAggregator.newMeasurementAvailable(MeasuringValue), AbstractMeasurementAggregator.onPreAggregate(), AbstractMeasurementAggregator.onPostAggregate()

getIntervalStartTime

protected org.jscience.physics.amount.Amount<javax.measure.quantity.Duration> getIntervalStartTime()

Description copied from class: AbstractMeasurementAggregator

Gets the left (lower) bound of the interval that all measurements that are aggregated lie in.

Specified by:

getIntervalStartTime in class AbstractMeasurementAggregator

Returns:

A non-negative Amount denoting the left bound of the interval.

See Also:

AbstractMeasurementAggregator.getIntervalEndTime()

getIntervalEndTime

protected org.jscience.physics.amount.Amount<javax.measure.quantity.Duration> getIntervalEndTime()

Description copied from class: AbstractMeasurementAggregator

Gets the right (upper) bound of the interval that all measurements that are aggregated lie in.

Specified by:

getIntervalEndTime in class AbstractMeasurementAggregator

Returns:

A non-negative Amount denoting the right bound of the interval.

See Also:

AbstractMeasurementAggregator.getIntervalStartTime()

getDataToAggregate

protected Iterable<org.palladiosimulator.measurementframework.MeasuringValue> getDataToAggregate()

Description copied from class: AbstractMeasurementAggregator

Gets the sequence of measurements to be aggregated.

Specified by:

getDataToAggregate in class AbstractMeasurementAggregator

Returns:

An Iterable encapsulating the sequence of measurements to be aggregated.

collectMeasurement

protected void collectMeasurement(org.palladiosimulator.measurementframework.MeasuringValue newMeasurement)

Description copied from class: AbstractMeasurementAggregator

This method has to be implemented by subclasses to collect a new measurement for aggregation.

Specified by:

collectMeasurement in class AbstractMeasurementAggregator

Parameters:

newMeasurement - A MeasuringValue denoting the measurement to include for aggregation.
It is ensured that the measurement passed here is not null and adheres to the expected metric, hence no more checks with regards to this have to be done by the implementations.

See Also:

AbstractMeasurementAggregator.decrementCounter()

onPreAggregate

protected void onPreAggregate()

Description copied from class: AbstractMeasurementAggregator

This method is invoked directly before an aggregation of the measurements is to be performed and is intended to be overriden by subclasses to include implementation-specific behavior.
The default implementation does nothing.

Overrides:

onPreAggregate in class AbstractMeasurementAggregator

See Also:

AbstractMeasurementAggregator.aggregationRequired()