de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies

Class StrategyStorage

java.lang.Object

de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.StrategyStorage

All Implemented Interfaces:

RecorderElementFactory

public class StrategyStorage
extends java.lang.Object
implements RecorderElementFactory

Implements the recorder strategy storage.

Since:

1.00

Version:

1.00

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field and Description
private HashMap<java.lang.String,RecorderElement>	defaults Stores default recorder elements which should be available by their name only (fix).
private RecorderElementMap	recorderElements Stores the recorder elements and performs the internal mapping between group ids and class names.
private boolean	variabilityDetectionEnabled Stores if automatic variability detection is enabled.

Constructor Summary

Constructors

Constructor and Description
StrategyStorage() Creates a new recorder strategy.

Method Summary

Modifier and Type	Method and Description
RecorderElement	create(MonitoringGroupConfiguration conf, boolean forceDefaultInstances) Creates a recorder element.
void	enableVariabilityDetection(boolean enable) Enables or disables automatic variability detection.
protected RecorderElement	getRecorderElement(java.lang.String id) Returns the recorder element for the given recording group id.
RecorderElementMap	getRecorderElements() Returns the set of recorder elements used by this strategy.
java.lang.String	getRecorderId(java.lang.String className) Maps a class name to its recorder id (called in this interface usually recId).
char	getVariabilitySeparatorChar() Returns the char used for separating the variability id and its current value (in configurations).
boolean	isOk(RecorderElement element, MonitoringGroupConfiguration conf) Returns if the given element is adequate (e.g. supports debugging) or if a new instance must be created and information must be taken over.
boolean	isVariabilityDetectionEnabled() Returns if automatic variability detection is enabled.
private static void	logConsistencyWarning(java.lang.String recId1, java.lang.String recId2) Emits a consistency warning.
void	registerDefaultRecorderElement(java.lang.String recId, RecorderElement elt) Registers an default recorder elements which should be available by its name only (fix).
void	registerForRecording(java.lang.String className, java.lang.String recId, MonitoringGroupConfiguration conf, MonitoringGroupSettings settings) Registers a given class for recording.

Methods inherited from class java.lang.Object

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

Field Detail

recorderElements

private RecorderElementMap recorderElements

Stores the recorder elements and performs the internal mapping between group ids and class names.

variabilityDetectionEnabled

private boolean variabilityDetectionEnabled

Stores if automatic variability detection is enabled.

defaults

private HashMap<java.lang.String,RecorderElement> defaults

Stores default recorder elements which should be available by their name only (fix).

Constructor Detail

StrategyStorage

public StrategyStorage()

Creates a new recorder strategy.

Since:

1.00

Method Detail

create

public RecorderElement create(MonitoringGroupConfiguration conf,
                              boolean forceDefaultInstances)

Creates a recorder element.

Specified by:

create in interface RecorderElementFactory

Parameters:

conf - the configuration to be considered for creating the element

forceDefaultInstances - if true do only create the default instances, otherways also those collecting contributing variants can be created

Returns:

the created instance

Since:

1.00

isOk

public boolean isOk(RecorderElement element,
                    MonitoringGroupConfiguration conf)

Returns if the given element is adequate (e.g. supports debugging) or if a new instance must be created and information must be taken over. This method is relevant, as instances may be created before the annotated class is loaded, e.g. during automated variant detection.

Specified by:

isOk in interface RecorderElementFactory

Parameters:

element - the element to be tested

conf - the configuration associated with element

Returns:

true if the instance is adequate, false if element must be revised

Since:

1.00

getRecorderElements

public RecorderElementMap getRecorderElements()

Returns the set of recorder elements used by this strategy.

Returns:

the recorder elements (map)

Since:

1.00

getRecorderId

public java.lang.String getRecorderId(java.lang.String className)

Maps a class name to its recorder id (called in this interface usually recId).

Parameters:

className - the class name to be mapped

Returns:

the recorder id of className

Since:

1.00

getVariabilitySeparatorChar

public char getVariabilitySeparatorChar()

Returns the char used for separating the variability id and its current value (in configurations).

Returns:

the separator char

Since:

1.00

registerForRecording

public void registerForRecording(java.lang.String className,
                                 java.lang.String recId,
                                 MonitoringGroupConfiguration conf,
                                 MonitoringGroupSettings settings)

Registers a given class for recording. Optional, a (group) id might be specified to which the measurements are assigned to. Ids are unique strings without inherent semantics. If not given, the className is used for grouping and assigning measurements (implicit 1-groups).

Parameters:

className - the name of the class measurements should be registered for

recId - an optional group identification (may be empty or null)

conf - additional configuration for the monitoring group derived from settings

settings - the monitoring group settings including all configuration information (reference should not be stored, will be freed explicitly)

Since:

1.00

logConsistencyWarning

private static void logConsistencyWarning(java.lang.String recId1,
                                          java.lang.String recId2)

Emits a consistency warning.

Parameters:

recId1 - the first recorder id

recId2 - the second recorder id

Since:

1.00

enableVariabilityDetection

public void enableVariabilityDetection(boolean enable)

Enables or disables automatic variability detection.

Parameters:

enable - true if variability detection should be enabled, false else

Since:

1.00

isVariabilityDetectionEnabled

public boolean isVariabilityDetectionEnabled()

Returns if automatic variability detection is enabled.

Returns:

true if variability detection should be enabled, false else

Since:

1.00

getRecorderElement

protected RecorderElement getRecorderElement(java.lang.String id)

Returns the recorder element for the given recording group id. Considers defaults.

Parameters:

id - the group identification

Returns:

the recorder element or null

Since:

1.00

registerDefaultRecorderElement

public void registerDefaultRecorderElement(java.lang.String recId,
                                           RecorderElement elt)

Registers an default recorder elements which should be available by its name only (fix).

Parameters:

recId - the recorder id

elt - the element