RecorderElement

java.lang.Object
- de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.RecorderElement

All Implemented Interfaces:

IMonitoringGroup

Direct Known Subclasses:

AbstractMultipleRecorderElement, BlockingRecorderElement, DefaultRecorderElement
```
public abstract class RecorderElement
extends java.lang.Object
implements IMonitoringGroup
```
Defines the element, i.e. the data to be recorded for a monitoring group.

Since:

1.00

Version:

1.20

Author:

Holger Eichelberger

Field Summary

Fields
Modifier and Type	Field and Description
`private MonitoringGroupConfiguration`	`conf` Stores the configuration.
`private LongHashMap<RecorderElement>`	`instanceElements` Stores the instance recorder elements.
`private int`	`varId` Stores a numerical (unique) identification of the variant this recorder element is assigned to.

Constructor Summary

Constructors
Modifier Constructor and Description

protected RecorderElement(MonitoringGroupConfiguration conf)
Creates a recorder element.

Constructors
Modifier	Constructor and Description
`protected`	`RecorderElement(MonitoringGroupConfiguration conf)` Creates a recorder element.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accountResource(ResourceType type)` Returns whether the specified resource should be accounted.
`(package private) abstract void`	`addNetBytes(long netInBytes, long netOutBytes)` Adds an external amount of input or output bytes to this recording element.
`void`	`checkConf(MonitoringGroupConfiguration conf)` Checks the configuration of this recorder element and replaces it if it is `MonitoringGroupConfiguration.STUB`.
`void`	`copy(RecorderElement from)` Copies the data stored in `from` into this instance.
`static RecorderElement`	`createForTest(MonitoringGroupConfiguration conf)` Factory method for creating test instances.
`MonitoringGroupConfiguration`	`getConfiguration()` Returns the monitoring group configuration.
`abstract RecorderElement`	`getContributing(int index)` Returns a contributing recording element, i.e. one of the elements assigned to individual variants in a variability configuration.
`(package private) abstract RecorderElement`	`getContributing(int index, RecorderElementFactory factory, int max)` Returns the currently relevant recorder element (in case that multiple subelements are supported).
`abstract int`	`getContributingSize()` Returns the number of contributing recording elements, i.e. the elements recording individual variants in a variability configuration.
`GroupAccountingType`	`getGroupAccounting()` Stores the accounting type.
`RecorderElement`	`getInstanceRecorderElement(long instanceId)` Returns an instance recorder element for recording how the data in this recorder element is composed.
`ResourceType[]`	`getResources()` Stores the resources to be accounted.
`protected abstract long`	`getStartCpuTime(long threadId)` Returns the CPU time when recording was started.
`protected abstract long`	`getStartSystemTime(long threadId)` Returns the system time when recording was started.
`int`	`getVarId()` Returns the (unique) numerical identification of the variant this recorder element is assigned to.
`boolean`	`hasDebugStates(DebugState state)` Returns if this instance has the given `state` selected.
`java.lang.Iterable<LongHashMap.MapElement<RecorderElement>>`	`instanceRecorderElements()` Returns all instance recorder elements.
`long[]`	`instanceRecorderIds()` Returns all instance recorder keys.
`boolean`	`isIndirectAccounting()` Returns whether indirect accounting is activated, either in this instance or (if `getGroupAccounting()` is `GroupAccountingType.DEFAULT`) than in `Configuration.getGroupAccountingType()`.
`boolean`	`isVisible()` Returns whether this element is a pseudo element and should not be visible to the user.
`(package private) abstract void`	`memoryAllocated(long size)` Records an amount of memory allocated by the underlying recording group.
`(package private) abstract void`	`memoryFreed(long size)` Records an amount of memory freed within the underlying recording group (memory unallocation).
`(package private) abstract void`	`readIo(int bytes, StreamType type)` Records an amount of bytes read from file or from network.
`(package private) abstract void`	`setCpuTimeTicks(long cpuTimeTicks)` Sets the current CPU time ticks for finishing recording of the entire program.
`(package private) void`	`setVarId(int varId)` Changes the (unique) numerical identification of the variant this recorder element is assigned to.
`(package private) abstract boolean`	`startTimeRecording(long nanoTime, long threadTicks, long threadId)` Start the time recording for this instance.
`(package private) abstract boolean`	`stopTimeRecording(long nanoTime, long threadTicks, long threadId)` Stops the time recording for this instance.
`(package private) abstract void`	`timeCorrection(long timeDiff, long threadTimeFraction, boolean decrement, long threadId)` Adds (overhead) time correction information.
`(package private) abstract void`	`updateMemoryFreedFromJvm()` Updates freed memory from the JVM instead of recording this information individually (memory unallocation).
`(package private) abstract void`	`writeIo(int bytes, StreamType type)` Records an amount of bytes written to file or from network.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.uni_hildesheim.sse.monitoring.runtime.plugins.IMonitoringGroup
getCpuTimeTicks, getFileIn, getFileOut, getIoRead, getIoWrite, getMemAllocated, getMemUse, getNetIn, getNetOut, getSystemTimeTicks, wasRecorded

- Field Detail
  - varId
```
private int varId
```
    Stores a numerical (unique) identification of the variant this recorder element is assigned to.
  - conf
```
private MonitoringGroupConfiguration conf
```
    Stores the configuration. In previous versions, different subclasses of recorder elements distinguished among debug and non-debug instances and configuration data was directly stored here. As we assume that the default will be defined by the global configuration, this will mostly be a reference to the default monitoring group configuration and therefore this implementation will probably save memory in the average case.
  - instanceElements
```
private LongHashMap<RecorderElement> instanceElements
```
    Stores the instance recorder elements.
- Constructor Detail
  - RecorderElement
```
protected RecorderElement(MonitoringGroupConfiguration conf)
```
    Creates a recorder element.
    
    Parameters:
    
    conf - the group configuration (either from XML or from source code)
    
    Since:
    
    1.00
- Method Detail
  - copy
```
public void copy(RecorderElement from)
```
    Copies the data stored in from into this instance. (Deep copy)
    
    Parameters:
    
    from - the instance from where to copy (may also be a subclass)
    
    Since:
    
    1.00
  - startTimeRecording
```
abstract boolean startTimeRecording(long nanoTime,
                                    long threadTicks,
                                    long threadId)
```
    Start the time recording for this instance.
    
    Parameters:
    
    nanoTime - the current system time in nano seconds
    
    threadTicks - the current number of thread ticks
    
    threadId - the identifier of the thread causing the call
    
    Returns:
    
    true if recording started on this instance with this call, false if recording was yet active, e.g. in case of recursive or reentrant calls
    
    Since:
    
    1.00
  - stopTimeRecording
```
abstract boolean stopTimeRecording(long nanoTime,
                                   long threadTicks,
                                   long threadId)
```
    Stops the time recording for this instance.
    
    Parameters:
    
    nanoTime - the current system time in nano seconds
    
    threadTicks - the current number of thread ticks
    
    threadId - the identifier of the thread causing the call
    
    Returns:
    
    true if recording stopped on this instance with this call, false if recording is still active, e.g. in case of recursive or reentrant calls, a negative value causes stopping time recording for all stored threaded times
    
    Since:
    
    1.00
  - memoryAllocated
```
abstract void memoryAllocated(long size)
```
    Records an amount of memory allocated by the underlying recording group.
    
    Parameters:
    
    size - the amount of memory allocated
    
    Since:
    
    1.00
  - memoryFreed
```
abstract void memoryFreed(long size)
```
    Records an amount of memory freed within the underlying recording group (memory unallocation).
    
    Parameters:
    
    size - the amount of memory freed
    
    Since:
    
    1.00
  - updateMemoryFreedFromJvm
```
abstract void updateMemoryFreedFromJvm()
```
    Updates freed memory from the JVM instead of recording this information individually (memory unallocation). Should be used for the (entire) program record only.
    
    Since:
    
    1.00
  - getStartCpuTime
```
protected abstract long getStartCpuTime(long threadId)
```
    Returns the CPU time when recording was started.
    
    Parameters:
    
    threadId - the identifier of the thread the start time should be returned for
    
    Returns:
    
    the time when recording was started, may be negative if disabled
    
    Since:
    
    1.00
  - getStartSystemTime
```
protected abstract long getStartSystemTime(long threadId)
```
    Returns the system time when recording was started.
    
    Parameters:
    
    threadId - the identifier of the thread the start time should be returned for
    
    Returns:
    
    the time when recording was started, may be negative if disabled
    
    Since:
    
    1.00
  - readIo
```
abstract void readIo(int bytes,
                     StreamType type)
```
    Records an amount of bytes read from file or from network.
    
    Parameters:
    
    bytes - the amount of bytes read
    
    type - the type of stream used for reading
    
    Since:
    
    1.00
  - writeIo
```
abstract void writeIo(int bytes,
                      StreamType type)
```
    Records an amount of bytes written to file or from network.
    
    Parameters:
    
    bytes - the amount of bytes written
    
    type - the type of stream used for writing
    
    Since:
    
    1.00
  - setCpuTimeTicks
```
abstract void setCpuTimeTicks(long cpuTimeTicks)
```
    Sets the current CPU time ticks for finishing recording of the entire program.
    
    Parameters:
    
    cpuTimeTicks - the current CPU time ticks
    
    Since:
    
    1.00
  - addNetBytes
```
abstract void addNetBytes(long netInBytes,
                          long netOutBytes)
```
    Adds an external amount of input or output bytes to this recording element. This method is used for recording overhead bytes. (This method is currently available only for network overhead as networked monitoring may lead to uncontrolled recursive network recording).
    
    Parameters:
    
    netInBytes - the amount of bytes read from network
    
    netOutBytes - the amount of bytes written to network
    
    Since:
    
    1.00
  - hasDebugStates
```
public boolean hasDebugStates(DebugState state)
```
    Returns if this instance has the given state selected.
    
    Parameters:
    
    state - the state to be tested
    
    Returns:
    
    true if the state is selected, false else
  - timeCorrection
```
abstract void timeCorrection(long timeDiff,
                             long threadTimeFraction,
                             boolean decrement,
                             long threadId)
```
    Adds (overhead) time correction information.
    
    Parameters:
    
    timeDiff - time difference
    
    threadTimeFraction - threaded time fraction
    
    decrement - negative or positive correction
    
    threadId - the thread id of the causing thread
    
    Since:
    
    1.00
  - getContributing
```
abstract RecorderElement getContributing(int index,
                                         RecorderElementFactory factory,
                                         int max)
```
    Returns the currently relevant recorder element (in case that multiple subelements are supported).
    
    Parameters:
    
    index - the index of the sub element (may be negative if not known)
    
    factory - a factory to create new elements if needed
    
    max - the (current) number of maximum required subelements (variabilities)
    
    Returns:
    
    the subelement or this instance
    
    Since:
    
    1.00
  - getContributing
```
public abstract RecorderElement getContributing(int index)
```
    Returns a contributing recording element, i.e. one of the elements assigned to individual variants in a variability configuration.
    
    Parameters:
    
    index - the element to be returned
    
    Returns:
    
    the element assigned to the given index
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - if index<0 || index>=getContributingSize()
    
    Since:
    
    1.00
  - getContributingSize
```
public abstract int getContributingSize()
```
    Returns the number of contributing recording elements, i.e. the elements recording individual variants in a variability configuration.
    
    Returns:
    
    the number of contributing recording elements
    
    Since:
    
    1.00
  - setVarId
```
void setVarId(int varId)
```
    Changes the (unique) numerical identification of the variant this recorder element is assigned to.
    
    Parameters:
    
    varId - the new variability identification
  - getVarId
```
public int getVarId()
```
    Returns the (unique) numerical identification of the variant this recorder element is assigned to.
    
    Returns:
    
    the new variability identification
  - getGroupAccounting
```
public GroupAccountingType getGroupAccounting()
```
    Stores the accounting type.
    
    Returns:
    
    the group accounting type
  - getResources
```
public ResourceType[] getResources()
```
    Stores the resources to be accounted.
    
    Returns:
    
    the resources to be accounted (empty if all)
  - accountResource
```
public boolean accountResource(ResourceType type)
```
    Returns whether the specified resource should be accounted.
    
    Parameters:
    
    type - the type of the resource to query for
    
    Returns:
    
    true if it should be accounted, false else
    
    Since:
    
    1.00
  - isIndirectAccounting
```
public boolean isIndirectAccounting()
```
    Returns whether indirect accounting is activated, either in this instance or (if getGroupAccounting() is GroupAccountingType.DEFAULT) than in Configuration.getGroupAccountingType().
    
    Returns:
    
    true if indirect is activated, false else
    
    Since:
    
    1.00
  - getConfiguration
```
public MonitoringGroupConfiguration getConfiguration()
```
    Returns the monitoring group configuration.
    
    Returns:
    
    the configuration
    
    Since:
    
    1.00
  - createForTest
```
public static RecorderElement createForTest(MonitoringGroupConfiguration conf)
```
    Factory method for creating test instances.
    
    Parameters:
    
    conf - the monitoring group configuration
    
    Returns:
    
    the created instance
    
    Since:
    
    1.00
  - isVisible
```
public boolean isVisible()
```
    Returns whether this element is a pseudo element and should not be visible to the user.
    
    Returns:
    
    true if this element is visible, false else
    
    Since:
    
    1.00
  - checkConf
```
public void checkConf(MonitoringGroupConfiguration conf)
```
    Checks the configuration of this recorder element and replaces it if it is MonitoringGroupConfiguration.STUB.
    
    Parameters:
    
    conf - the new configuration
    
    Since:
    
    1.00
  - getInstanceRecorderElement
```
public RecorderElement getInstanceRecorderElement(long instanceId)
```
    Description copied from interface: IMonitoringGroup
    
    Returns an instance recorder element for recording how the data in this recorder element is composed.
    
    Specified by:
    
    getInstanceRecorderElement in interface IMonitoringGroup
    
    Parameters:
    
    instanceId - the instance identifier
    
    Returns:
    
    the instance recorder element
  - instanceRecorderElements
```
public java.lang.Iterable<LongHashMap.MapElement<RecorderElement>> instanceRecorderElements()
```
    Description copied from interface: IMonitoringGroup
    
    Returns all instance recorder elements.
    
    Specified by:
    
    instanceRecorderElements in interface IMonitoringGroup
    
    Returns:
    
    the instance recorder elements
  - instanceRecorderIds
```
public long[] instanceRecorderIds()
```
    Description copied from interface: IMonitoringGroup
    
    Returns all instance recorder keys.
    
    Specified by:
    
    instanceRecorderIds in interface IMonitoringGroup
    
    Returns:
    
    the instance recorder keys

Class RecorderElement

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface de.uni_hildesheim.sse.monitoring.runtime.plugins.IMonitoringGroup

Field Detail

varId

conf

instanceElements

Constructor Detail

RecorderElement

Method Detail

copy

startTimeRecording

stopTimeRecording

memoryAllocated

memoryFreed

updateMemoryFreedFromJvm

getStartCpuTime

getStartSystemTime

readIo

writeIo

setCpuTimeTicks

addNetBytes

hasDebugStates

timeCorrection

getContributing

getContributing

getContributingSize

setVarId

getVarId

getGroupAccounting

getResources

accountResource

isIndirectAccounting

getConfiguration

createForTest

isVisible

checkConf

getInstanceRecorderElement

instanceRecorderElements

instanceRecorderIds