Package edu.kit.ipd.sdq.eventsim.measurement.r

Class RMeasurementStore

java.lang.Object

edu.kit.ipd.sdq.eventsim.measurement.r.RMeasurementStore

All Implemented Interfaces:

MeasurementStorage

public class RMeasurementStore
extends Object
implements MeasurementStorage

Stores Measurements into R using Rserve (for details on Rserve see https://rforge.net/Rserve).

Measurements are buffered and sent to R as a batch once the buffer size reaches its capacity. Increasing the buffer capacity improves performance at the cost of higher memory consumption (this needs to be further evaluated, however).

Constructor Summary

Constructors

Constructor	Description
RMeasurementStore(RserveConnection connection)	Use this constructor when no RDS file is to be created upon finish.
RMeasurementStore(RserveConnection connection, String rdsFilePath)	Use this constructor when an RDS file is to be created upon finish.

Method Summary

Modifier and Type	Method	Description
void	addIdExtractor(Class<? extends Object> elementClass, Function<Object,String> extractionFunction)	Adds a mapping (by means of a Function) from Objects of a fixed type to Strings that uniquely identify (id) objects of the specified type.
void	addMetadata(Metadata... metadata)	Adds global metadata that will be appended to each Measurement added via MeasurementStorage.put(Measurement).
void	addMetadata(List<Metadata> metadata)
void	addNameExtractor(Class<? extends Object> elementClass, Function<Object,String> extractionFunction)
void	addTypeExtractor(Class<? extends Object> elementClass, Function<Object,String> extractionFunction)
void	finish()
static RMeasurementStore	fromLaunchConfiguration(Map<String,Object> configuration, RserveConnection connection)	Constructs a RMeasurementStore by extracting configuration options from the provided launch configuration.
void	put(Measurement<?> m)	Stores the given measurement.
void	start()

Methods inherited from class java.lang.Object

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

Constructor Detail

RMeasurementStore

public RMeasurementStore(RserveConnection connection)

Use this constructor when no RDS file is to be created upon finish.

RMeasurementStore

public RMeasurementStore(RserveConnection connection,
                         String rdsFilePath)

Use this constructor when an RDS file is to be created upon finish.

Parameters:

rdsFilePath - the location of the file to be created.

Method Detail

fromLaunchConfiguration

public static RMeasurementStore fromLaunchConfiguration(Map<String,Object> configuration,
                                                        RserveConnection connection)

Constructs a RMeasurementStore by extracting configuration options from the provided launch configuration.

Parameters:

configuration - the launch configuration

Returns:

the constructed RMeasurementStore, or null if expected configuration options could not be found in the provided launch configuration.

addIdExtractor

public void addIdExtractor(Class<? extends Object> elementClass,
                           Function<Object,String> extractionFunction)

Description copied from interface: MeasurementStorage

Adds a mapping (by means of a Function) from Objects of a fixed type to Strings that uniquely identify (id) objects of the specified type. This allows to extract ids from arbitrary Objects without dictating an interface.

Specified by:

addIdExtractor in interface MeasurementStorage

Parameters:

elementClass - the type's class

extractionFunction - the function that maps type instances to id-Strings.

addNameExtractor

public void addNameExtractor(Class<? extends Object> elementClass,
                             Function<Object,String> extractionFunction)

Specified by:

addNameExtractor in interface MeasurementStorage

Parameters:

elementClass - the type's class

extractionFunction - the function that maps type instances to name-Strings.

See Also:

MeasurementStorage.addIdExtractor(Class, Function)

addTypeExtractor

public void addTypeExtractor(Class<? extends Object> elementClass,
                             Function<Object,String> extractionFunction)

Specified by:

addTypeExtractor in interface MeasurementStorage

extractionFunction - the function that maps type instances to type-Strings.

See Also:

MeasurementStorage.addIdExtractor(Class, Function)

put

public void put(Measurement<?> m)

Description copied from interface: MeasurementStorage

Stores the given measurement.

Specified by:

put in interface MeasurementStorage

Parameters:

m - the measurement to be added

addMetadata

public void addMetadata(Metadata... metadata)

Description copied from interface: MeasurementStorage

Adds global metadata that will be appended to each Measurement added via MeasurementStorage.put(Measurement).

Specified by:

addMetadata in interface MeasurementStorage

Parameters:

metadata - the global metadata to be appended

addMetadata

public void addMetadata(List<Metadata> metadata)

Specified by:

addMetadata in interface MeasurementStorage

See Also:

MeasurementStorage.addMetadata(Metadata...)

start

public void start()
           throws MeasurementStorageStartException

Specified by:

start in interface MeasurementStorage

Throws:

MeasurementStorageStartException

finish

public void finish()

Specified by:

finish in interface MeasurementStorage