de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies

Class RecorderElementMap

java.lang.Object

de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.RecorderElementMap

public class RecorderElementMap
extends java.lang.Object

Implements a double indirected map which may assign recorder elements to class names which then can be referenced by ids, i.e. a recorder element may be retrieved by its class name or by a grouping id which represents multiple class names.

The interface of this class is incomplete as (nearly) only required methods are realized (pragmatic agility).

Since:

1.00

Version:

1.00

Author:

Holger Eichelberger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	RecorderElementMap.PositionRecord Information to be stored for a recording id on the index into the configuration string and the related char value.

Field Summary

Fields

Modifier and Type	Field and Description
private HashMap<java.lang.String,java.lang.String>	classNameToId Stores the class name to group-id mappings.
private char[]	currentConfiguration Stores the current configuration as array of numbers (can be transformed to a string as map key).
private RecorderElement	currentConfigurationRecord Stores the current configuration record for fast access.
private RecorderElementFactory	factory Stores the recorder element factory.
private HashMap<java.lang.String,RecorderElementMap.PositionRecord>	idToConfiguration Stores the records for the recording ids.
private HashMap<java.lang.String,RecorderElementMap.PositionRecord>	lruRecords Stores the last recently used mappings between variability (i.e.
private HashMap<java.lang.String,RecorderElement>	mappedClasses Stores the class name / id mapping to recorder elements.
private HashMap<java.lang.String,RecorderElement>	mappedConfigurations Stores the records for the individual configurations.
private java.util.LinkedList<MultipleRecorderElement>	pseudoElt Stores the pseudo recorder elements.
private ArrayList<java.lang.String>	recorderIds Stores the recorder ids (in sequence of registration).
private char	separatorChar Stores the variant separator, i.e. the separator to be used between variability and variant (e.g. drawer@none).
private java.lang.String	variabilitySeparator Stores the variability separator, i.e. the separator to be used between two variabilities.
private char	variabilitySeparatorChar Stores the variability separator, i.e. the separator to be used between two variabilities.
private HashMap<java.lang.String,java.lang.Integer>	varIds Stores the variability identification to integer mapping (simplified recognition of variabilities during assignment to recording elements).

Constructor Summary

Constructors

Constructor and Description
RecorderElementMap(RecorderElementFactory factory) Creates a new map.

Method Summary

Modifier and Type	Method and Description
java.lang.String	configurationKeyToString(java.lang.String key, boolean check) Formats a configuration key to a string, i.e. converts chars to numbers and inserts a separator char.
java.lang.Iterable<java.lang.String>	configurations() Returns the set of all configurations recorded until now.
java.lang.Iterable<HashMap.Entry<java.lang.String,RecorderElement>>	configurationToRecording() Returns the bindings between configurations and recording elements.
boolean	containsKey(java.lang.String recId) Does this map contains a (redirected) entry for className?
void	enterCompleteConfiguration(java.lang.String ids, boolean force) Changes the entire variability configuration, i.e. sets all currently active variants new.
void	enterConfiguration(java.lang.String id) Notifies this class about explicitly entering a configuration, i.e. the change of an individual variability (used for automatic detection).
RecorderElement	getAggregatedRecord(java.lang.String recId) Returns the (redirected) entry assigned to recId?
int	getConfigurationLength() Returns the current length of the configuration.
ConfigurationToName	getConfigurationMapping() Returns an instance which is responsible for mapping back a configuration string to a readable configuration description.
java.lang.String	getCurrentConfigurationId() Returns the current configuration identification.
RecorderElement	getCurrentConfigurationRecord(java.lang.String recId) Returns the current configuration record.
private java.lang.String	getId(java.lang.String className) Maps a class name back to the key used for mappedClasses.
java.lang.String	getPossibleAggregatedRecorderId(java.lang.String recId) Returns a possible recording id for the given recId.
(package private) java.lang.String	getRecorderId(RecorderElement element) Returns the recording id for the given recorder element.
java.lang.String	getRecorderId(java.lang.String className) Returns the recording id for the given class name.
char	getSeparatorChar() Returns the char separating variabilities from concrete variants in recorder ids.
java.lang.String	getVariabilityId(java.lang.String recId) Returns the part of the recId representing the variability identification.
int	getVariabilityIdNum(java.lang.String recId) Returns the numerical identification of the variability identification (retrieved by getVariabilityId(String).
java.lang.Iterable<HashMap.Entry<java.lang.String,RecorderElement>>	idToRecordingSet() Returns all mappings to recorder elements.
boolean	isEmpty() Returns whether recorder elements have been stored (not classname-id-mappings).
java.util.LinkedList<MultipleRecorderElement>	pseudoElements() Returns the pseudo elements.
int	pseudoElementsSize() Returns the current number of pseudo elements.
void	put(java.lang.String recId, RecorderElement[] elements, MonitoringGroupConfiguration conf, MonitoringGroupSettings settings) Adds a pseudo recorder element which represents multiple recorder elements.
void	put(java.lang.String className, java.lang.String id, MonitoringGroupConfiguration conf) Stores a new recorder element.
java.util.Iterator<java.lang.String>	recorderIds() Returns all stored recorder ids (in sequence of registration).
private void	setCurrentConfigurationRecord() Changes the current configuration record, i.e. caches the record assigned to the current configuration.
java.lang.Iterable<RecorderElement>	values() Returns all stored recorder elements.

Methods inherited from class java.lang.Object

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

Field Detail

classNameToId

private HashMap<java.lang.String,java.lang.String> classNameToId

Stores the class name to group-id mappings. Multiple class names might be assigned to one id.

mappedClasses

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

Stores the class name / id mapping to recorder elements.

recorderIds

private ArrayList<java.lang.String> recorderIds

Stores the recorder ids (in sequence of registration).

mappedConfigurations

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

Stores the records for the individual configurations.

currentConfigurationRecord

private RecorderElement currentConfigurationRecord

Stores the current configuration record for fast access.

idToConfiguration

private HashMap<java.lang.String,RecorderElementMap.PositionRecord> idToConfiguration

Stores the records for the recording ids.

lruRecords

private HashMap<java.lang.String,RecorderElementMap.PositionRecord> lruRecords

Stores the last recently used mappings between variability (i.e. the substring before separatorChar) and the assigned position.

varIds

private HashMap<java.lang.String,java.lang.Integer> varIds

Stores the variability identification to integer mapping (simplified recognition of variabilities during assignment to recording elements).

pseudoElt

private java.util.LinkedList<MultipleRecorderElement> pseudoElt

Stores the pseudo recorder elements.

currentConfiguration

private char[] currentConfiguration

Stores the current configuration as array of numbers (can be transformed to a string as map key).

separatorChar

private char separatorChar

Stores the variant separator, i.e. the separator to be used between variability and variant (e.g. drawer@none).

variabilitySeparatorChar

private char variabilitySeparatorChar

Stores the variability separator, i.e. the separator to be used between two variabilities.

variabilitySeparator

private java.lang.String variabilitySeparator

Stores the variability separator, i.e. the separator to be used between two variabilities.

factory

private RecorderElementFactory factory

Stores the recorder element factory.

Constructor Detail

RecorderElementMap

public RecorderElementMap(RecorderElementFactory factory)

Creates a new map.

Parameters:

factory - the recorder element factory

Since:

1.00

Method Detail

getSeparatorChar

public char getSeparatorChar()

Returns the char separating variabilities from concrete variants in recorder ids.

Returns:

the separating character

Since:

1.00

getVariabilityId

public java.lang.String getVariabilityId(java.lang.String recId)

Returns the part of the recId representing the variability identification.

Parameters:

recId - the recording identification

Returns:

the variability identification or null if not applicable

Since:

1.00

getVariabilityIdNum

public int getVariabilityIdNum(java.lang.String recId)

Returns the numerical identification of the variability identification (retrieved by getVariabilityId(String).

Parameters:

recId - the recording identification

Returns:

the (unique) numerical identification, a negative number if none was assigned

Since:

1.00

put

public void put(java.lang.String recId,
                RecorderElement[] elements,
                MonitoringGroupConfiguration conf,
                MonitoringGroupSettings settings)

Adds a pseudo recorder element which represents multiple recorder elements.

Parameters:

recId - the unique (pseudo) identification

elements - the elements

conf - the recorder configuration

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

Since:

1.00

pseudoElements

public java.util.LinkedList<MultipleRecorderElement> pseudoElements()

Returns the pseudo elements.

Returns:

the pseudo elements.

Since:

1.00

pseudoElementsSize

public int pseudoElementsSize()

Returns the current number of pseudo elements.

Returns:

the current number of pseudo elements

Since:

1.00

put

public void put(java.lang.String className,
                java.lang.String id,
                MonitoringGroupConfiguration conf)

Stores a new recorder element. 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

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

conf - an optional monitoring group configuration associated with id (may be null)

Since:

1.00

setCurrentConfigurationRecord

private void setCurrentConfigurationRecord()

Changes the current configuration record, i.e. caches the record assigned to the current configuration.

Since:

1.00

enterConfiguration

public void enterConfiguration(java.lang.String id)

Notifies this class about explicitly entering a configuration, i.e. the change of an individual variability (used for automatic detection).

Parameters:

id - the new configuration entry (variability@variant)

Since:

1.00

enterCompleteConfiguration

public void enterCompleteConfiguration(java.lang.String ids,
                                       boolean force)

Changes the entire variability configuration, i.e. sets all currently active variants new. This is used for manual variability recording.

Parameters:

ids - the recording ids for the currently active configuration

force - if true dummy recording elements are created for recording groups which have not been registered so far (but which probably will during the run of the monitored program, if false only registered ids will be considered (may lead to incomplete configurations)

Since:

1.00

getCurrentConfigurationRecord

public RecorderElement getCurrentConfigurationRecord(java.lang.String recId)

Returns the current configuration record.

Parameters:

recId - the requested variant at the specified position

Returns:

the related recorder element recording the variant

Since:

1.00

getPossibleAggregatedRecorderId

public java.lang.String getPossibleAggregatedRecorderId(java.lang.String recId)

Returns a possible recording id for the given recId. If recId denotes a recoding group, the recorder element for that group is returned. Otherways, recId is considered as a possible prefix to a variant (if enabled) and the related active variant is returned.

Parameters:

recId - the recorder id or a recorder id prefix

Returns:

the related recorder id (or null in case of none)

Since:

1.00

getCurrentConfigurationId

public java.lang.String getCurrentConfigurationId()

Returns the current configuration identification. To map back this strg

Returns:

the current configuration identification (each char is a number representing the internal id of the variant)

Since:

1.00

getConfigurationMapping

public ConfigurationToName getConfigurationMapping()

Returns an instance which is responsible for mapping back a configuration string to a readable configuration description.

Returns:

the (reusable) instance being responsible for configuration mapping

Since:

1.00

getId

private java.lang.String getId(java.lang.String className)

Maps a class name back to the key used for mappedClasses. This method queries classNameToId if an id was registered for className. If an id was registered, mappedClasses is queried with that id

Parameters:

className - the class name to be searched for

Returns:

the key in mappedClasses

Since:

1.00

getRecorderId

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

Returns the recording id for the given class name. This method considers registration of classes in monitoring groups.

Parameters:

className - the class name to look for

Returns:

the recording id

Since:

1.00

containsKey

public boolean containsKey(java.lang.String recId)

Does this map contains a (redirected) entry for className?

Parameters:

recId - the recorder identification

Returns:

true if this map contains an entry, false else

Since:

1.00

getAggregatedRecord

public RecorderElement getAggregatedRecord(java.lang.String recId)

Returns the (redirected) entry assigned to recId?

Parameters:

recId - the recorder identification

Returns:

the entry or null if not found

Since:

1.00

idToRecordingSet

public java.lang.Iterable<HashMap.Entry<java.lang.String,RecorderElement>> idToRecordingSet()

Returns all mappings to recorder elements. Keys might be ids or class names.

Returns:

all mappings to recorder elements

Since:

1.00

isEmpty

public boolean isEmpty()

Returns whether recorder elements have been stored (not classname-id-mappings).

Returns:

true if recorder elements have been stored, false else

Since:

1.00

values

public java.lang.Iterable<RecorderElement> values()

Returns all stored recorder elements.

Returns:

all stored recorder elements

Since:

1.00

recorderIds

public java.util.Iterator<java.lang.String> recorderIds()

Returns all stored recorder ids (in sequence of registration).

Returns:

all stored recorder ids

Since:

1.00

configurations

public java.lang.Iterable<java.lang.String> configurations()

Returns the set of all configurations recorded until now.

Returns:

the set of all configurations

Since:

1.00

configurationToRecording

public java.lang.Iterable<HashMap.Entry<java.lang.String,RecorderElement>> configurationToRecording()

Returns the bindings between configurations and recording elements.

Returns:

the bindings

Since:

1.00

getConfigurationLength

public int getConfigurationLength()

Returns the current length of the configuration. May change over time in case of automated detection of variabilities.

Returns:

the length of the configuration

Since:

1.00

configurationKeyToString

public java.lang.String configurationKeyToString(java.lang.String key,
                                                 boolean check)

Formats a configuration key to a string, i.e. converts chars to numbers and inserts a separator char.

Parameters:

key - the key to be formatted

check - if true emit only valid configurations

Returns:

a representation of the configuration, null else

Since:

1.00

getRecorderId

java.lang.String getRecorderId(RecorderElement element)

Returns the recording id for the given recorder element. This method is intended for debugging only.

Parameters:

element - the recorder element

Returns:

the assigned recording identification (may be null)

Since:

1.00