org.youscope.common

Interface MeasurementContext

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

SimpleMeasurementContext

public interface MeasurementContext
extends java.rmi.Remote

Handed over to measurement components upon initialization, execution and uninitialization. Allows the components to access global measurement properties, transmit data between components.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
java.util.UUID	getMeasurementUUID() Returns the unique identifier of the measurement containing this component.
java.io.Serializable	getProperty(java.lang.String identifier) Returns a previously-by this or another measurement component-stored property.
<T extends java.io.Serializable> T	getProperty(java.lang.String identifier, java.lang.Class<T> propertyType) Returns a previously-by this or another measurement component-stored property.
java.lang.String[]	getPropertyIdentifiers() Returns the identifiers of all stored properties.
void	notifyMeasurementStructureChanged() Should be called if the structure of the measurement changed during execution, e.g.
void	setProperty(java.lang.String identifier, java.io.Serializable property) Sets a property, such that it can be loaded by any other job in the measurement.

Method Detail

setProperty

void setProperty(java.lang.String identifier,
                 java.io.Serializable property)
          throws java.rmi.RemoteException

Sets a property, such that it can be loaded by any other job in the measurement. Any property with the same identifier will be replaced.

Parameters:

identifier - a short identifier for the property.

property - The property which should be saved.

Throws:

java.rmi.RemoteException

getProperty

java.io.Serializable getProperty(java.lang.String identifier)
                          throws java.rmi.RemoteException

Returns a previously-by this or another measurement component-stored property.

Parameters:

identifier - identifier of the property.

Returns:

previously stored property, or null if yet not stored.

Throws:

java.rmi.RemoteException

getProperty

<T extends java.io.Serializable> T getProperty(java.lang.String identifier,
                                               java.lang.Class<T> propertyType)
                                        throws java.rmi.RemoteException

Returns a previously-by this or another measurement component-stored property. The property is tried to be casted to the provided class or interface. If this fails, null is returned.

Parameters:

propertyType - type to which the property should be casted.

identifier - identifier of the property.

Returns:

previously stored property, or null if yet not stored or cast fails.

Throws:

java.rmi.RemoteException

getPropertyIdentifiers

java.lang.String[] getPropertyIdentifiers()
                                   throws java.rmi.RemoteException

Returns the identifiers of all stored properties.

Returns:

identifiers of stored properties.

Throws:

java.rmi.RemoteException

notifyMeasurementStructureChanged

void notifyMeasurementStructureChanged()
                                throws java.rmi.RemoteException

Should be called if the structure of the measurement changed during execution, e.g. when child jobs were added or removed or similar.

Throws:

java.rmi.RemoteException

getMeasurementUUID

java.util.UUID getMeasurementUUID()
                           throws java.rmi.RemoteException

Returns the unique identifier of the measurement containing this component.

Returns:

Unique identifier of measurement.

Throws:

java.rmi.RemoteException