org.youscope.addon.measurement

Interface MeasurementAddonFactory

All Known Implementing Classes:

CellDetectionMeasurementAddonFactory, ComposedImagingMeasurementAddonFactory, ContinousImagingMeasurementAddonFactory, MeasurementAddonFactoryAdapter, MicroplateMeasurementAddonFactory, MultiCameraContinousImagingAddonFactory, SimpleMeasurementAddonFactory, TaskMeasurementAddonFactory, UserControlMeasurementAddonFactory

public interface MeasurementAddonFactory

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
ComponentAddonUI<? extends MeasurementConfiguration>	createMeasurementUI(java.lang.String typeIdentifier, YouScopeClient client, YouScopeServer server) Returns a new measurement configuration addon for the given ID, or null if addon does not support the configuration of measurements witht the given ID.
ComponentMetadata<? extends MeasurementConfiguration>	getComponentMetadata(java.lang.String typeIdentifier) Returns the metadata (like human readable name) for a given measurement type.
java.lang.String[]	getSupportedTypeIdentifiers() Returns a list of all measurement configuration types supported by this addon
void	initializeMeasurement(Measurement measurement, MeasurementConfiguration configuration, ConstructionContext constructionContext) Called when this addon should initialize the the measurement according to its configuration.
boolean	isSupportingTypeIdentifier(java.lang.String ID) Returns true if this addon supports measurement configurations with the given ID, false otherwise.

Method Detail

initializeMeasurement

void initializeMeasurement(Measurement measurement,
                           MeasurementConfiguration configuration,
                           ConstructionContext constructionContext)
                    throws ConfigurationException,
                           AddonException

Called when this addon should initialize the the measurement according to its configuration.

Parameters:

measurement - The measurement which should be initialized.

configuration - The configuration according to which the measurement should be initialized.

constructionContext - An interface to an object allowing to initialize the various measurement components.

Throws:

ConfigurationException - Thrown if the configuration is invalid.

AddonException - Thrown if an error occurred during the initialization.

createMeasurementUI

ComponentAddonUI<? extends MeasurementConfiguration> createMeasurementUI(java.lang.String typeIdentifier,
                                                                         YouScopeClient client,
                                                                         YouScopeServer server)
                                                                  throws AddonException

Returns a new measurement configuration addon for the given ID, or null if addon does not support the configuration of measurements witht the given ID.

Parameters:

typeIdentifier - The type identifier of the measurement.

client - Interface to allow the addon to communicate with the client.

server - Interface to the server.

Returns:

The created addon to configure a measurement.

Throws:

AddonException

getSupportedTypeIdentifiers

java.lang.String[] getSupportedTypeIdentifiers()

Returns a list of all measurement configuration types supported by this addon

Returns:

List of supported configurations.

isSupportingTypeIdentifier

boolean isSupportingTypeIdentifier(java.lang.String ID)

Returns true if this addon supports measurement configurations with the given ID, false otherwise.

Parameters:

ID - The ID of the measurement configuration for which it should be querried if this addon supports its construction.

Returns:

True if this addon supports measurement configurations with the given ID, false otherwise.

getComponentMetadata

ComponentMetadata<? extends MeasurementConfiguration> getComponentMetadata(java.lang.String typeIdentifier)
                                                                    throws AddonException

Returns the metadata (like human readable name) for a given measurement type.

Parameters:

typeIdentifier - The type identifier of the configuration for which the metadata should be returned.

Returns:

The metadata of the given configuration.

Throws:

AddonException - Thrown if identifier is not supported by the addon.