org.youscope.addon.measurement

Class MeasurementAddonFactoryAdapter

java.lang.Object

org.youscope.addon.measurement.MeasurementAddonFactoryAdapter

All Implemented Interfaces:

MeasurementAddonFactory

Direct Known Subclasses:

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

public class MeasurementAddonFactoryAdapter
extends java.lang.Object
implements MeasurementAddonFactory

Adapter simplifying addon creation.

Author:

Moritz Lang

Constructor Summary

Constructors

Constructor and Description
MeasurementAddonFactoryAdapter() Constructor.
MeasurementAddonFactoryAdapter(java.lang.Class<? extends ComponentAddonUI<C>> configurationAddonClass, MeasurementInitializer<C> customInitializer, ComponentMetadata<C> metadata) Constructor.

Method Summary

Modifier and Type	Method and Description
<C extends MeasurementConfiguration> void	addAddon(java.lang.Class<? extends ComponentAddonUI<C>> configurationAddonClass, MeasurementInitializer<C> customInitializer, ComponentMetadata<C> metadata) Adds an addon.
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 typeIdentifier) Returns true if this addon supports measurement configurations with the given ID, false otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

MeasurementAddonFactoryAdapter

public MeasurementAddonFactoryAdapter(java.lang.Class<? extends ComponentAddonUI<C>> configurationAddonClass,
                                      MeasurementInitializer<C> customInitializer,
                                      ComponentMetadata<C> metadata)

Constructor. When invoked, the factory exposes the given addon.

Parameters:

configurationAddonClass - The UI exposed to the user.

customInitializer - Object for measurement initialization.

metadata - Metadata about this addon.

MeasurementAddonFactoryAdapter

public MeasurementAddonFactoryAdapter()

Constructor. Does no invoke any addon. Use addAddon() to expose addons later on.

Method Detail

addAddon

public <C extends MeasurementConfiguration> void addAddon(java.lang.Class<? extends ComponentAddonUI<C>> configurationAddonClass,
                                                          MeasurementInitializer<C> customInitializer,
                                                          ComponentMetadata<C> metadata)

Adds an addon.

Parameters:

configurationAddonClass - Class providing the UI elements.

customInitializer - A custom initializer for the measurement.

metadata - Metadata of the measurement.

getSupportedTypeIdentifiers

public java.lang.String[] getSupportedTypeIdentifiers()

Description copied from interface: MeasurementAddonFactory

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

Specified by:

getSupportedTypeIdentifiers in interface MeasurementAddonFactory

Returns:

List of supported configurations.

isSupportingTypeIdentifier

public boolean isSupportingTypeIdentifier(java.lang.String typeIdentifier)

Description copied from interface: MeasurementAddonFactory

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

Specified by:

isSupportingTypeIdentifier in interface MeasurementAddonFactory

Parameters:

typeIdentifier - 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.

createMeasurementUI

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

Description copied from interface: MeasurementAddonFactory

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.

Specified by:

createMeasurementUI in interface MeasurementAddonFactory

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

getComponentMetadata

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

Description copied from interface: MeasurementAddonFactory

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

Specified by:

getComponentMetadata in interface MeasurementAddonFactory

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.

initializeMeasurement

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

Description copied from interface: MeasurementAddonFactory

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

Specified by:

initializeMeasurement in interface MeasurementAddonFactory

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.