org.youscope.clientinterfaces

Interface ClientAddonProvider

public interface ClientAddonProvider

Provider with which YouScop client addons can be constructed.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
<T extends Configuration> ComponentAddonUI<T>	createComponentUI(ComponentMetadata<T> metadata) Creates an component addon user interface compatible with the configuration metadata.
ComponentAddonUI<?>	createComponentUI(java.lang.String typeIdentifier) Creates a component addon user interface for the given type identifier.
<T extends Configuration> ComponentAddonUI<? extends T>	createComponentUI(java.lang.String typeIdentifier, java.lang.Class<T> configurationClass) Creates a component addon user interface with the given type identifier, producing component comfigurations of the given configuration class.
<T extends Configuration> ComponentAddonUI<? extends T>	createComponentUI(T configuration) Creates an component addon user interface compatible with the configuration, and initializes it with the configuration.
AddonUI<? extends AddonMetadata>	createPostProcessorUI(java.lang.String typeIdentifier, java.lang.String measurementFolder) Creates a post processor user interface for the given type identifier.
<T extends AddonMetadata> AddonUI<T>	createPostProcessorUI(T metadata, java.lang.String measurementFolder) Creates an post processor user interface compatible with the metadata.
ToolAddonUI	createToolUI(java.lang.String typeIdentifier) Creates a tool user interface for the given type identifier.
ToolAddonUI	createToolUI(ToolMetadata metadata) Creates a tool user interface compatible with the metadata.
java.util.List<ComponentMetadata<?>>	getComponentMetadata() Returns the metadata of all components.
<T extends Configuration> java.util.List<ComponentMetadata<? extends T>>	getComponentMetadata(java.lang.Class<T> configurationClass) Returns the metadata of all components being able to produce or consume sub-class of the provided configuration class.
ComponentMetadata<?>	getComponentMetadata(java.lang.String typeIdentifier) Returns the metadata of the component having the given type identifier
<T extends Configuration> ComponentMetadata<? extends T>	getComponentMetadata(java.lang.String typeIdentifier, java.lang.Class<T> configurationClass) Returns the metadata of the component having the given type identifier, with the component producing/consuming the given type of configurations.
java.util.List<java.lang.String>	getComponentTypeIdentifiers() Returns the type identifiers of all components.
java.util.List<java.lang.String>	getComponentTypeIdentifiers(java.lang.Class<? extends Configuration> configurationClass) Returns the type identifiers of all component addons capable of consuming and creating configuration being sub-classes of the provided configuration class.
Microplate	getMicroplateType(java.lang.String typeIdentifier) Returns the microplate type with the given type identifer.
java.util.List<java.lang.String>	getMicroplateTypeIdentifiers() Returns the type identifiers of all known microplate types.
java.util.List<Microplate>	getMicroplateTypes() Returns all known microplate types.
java.util.List<AddonMetadata>	getPostProcessorMetadata() Returns the metadata of all post processors.
AddonMetadata	getPostProcessorMetadata(java.lang.String typeIdentifier) Returns the metadata of the post processor having the given type identifier
java.util.List<java.lang.String>	getPostProcessorTypeIdentifiers() Returns the type identifiers of all post processors.
java.util.List<javax.script.ScriptEngineFactory>	getScriptEngineFactories() Returns all script engine factories supported by the client.
javax.script.ScriptEngineFactory	getScriptEngineFactory(java.lang.String typeIdentifier) Returns a script engine factory with the given type identifier.
java.util.List<ToolMetadata>	getToolMetadata() Returns the metadata of all tools.
ToolMetadata	getToolMetadata(java.lang.String typeIdentifier) Returns the metadata of the tool having the given type identifier
java.util.List<java.lang.String>	getToolTypeIdentifiers() Returns the type identifiers of all tools.

Method Detail

createComponentUI

ComponentAddonUI<?> createComponentUI(java.lang.String typeIdentifier)
                               throws AddonException

Creates a component addon user interface for the given type identifier.

Parameters:

typeIdentifier - type identifier of the addon/configuration.

Returns:

The created addon UI with the given type identifier.

Throws:

AddonException - Thrown if no factory for the given component addon exists, or if the creation of the addon failed.

createComponentUI

<T extends Configuration> ComponentAddonUI<? extends T> createComponentUI(java.lang.String typeIdentifier,
                                                                          java.lang.Class<T> configurationClass)
                                                                   throws AddonException

Creates a component addon user interface with the given type identifier, producing component comfigurations of the given configuration class.

Parameters:

typeIdentifier - type identifier of the addon/configuration.

configurationClass - The configuration class which the addon user interface produces.

Returns:

The created addon UI with the given type identifier.

Throws:

AddonException - Thrown if no factory for the given component addon exists, or if the addon does not create configurations of the given configuration class.

createComponentUI

<T extends Configuration> ComponentAddonUI<? extends T> createComponentUI(T configuration)
                                                                   throws AddonException,
                                                                          ConfigurationException

Creates an component addon user interface compatible with the configuration, and initializes it with the configuration.

Parameters:

configuration - Configuration to edit.

Returns:

The created component addon UI, initialized with the given configuration.

Throws:

AddonException - Thrown if no factory for the given component type exists, or if the addon does not create configurations of the given configuration class.

ConfigurationException - Thrown if corresponding component addon was found, but configuration was invalid.

createComponentUI

<T extends Configuration> ComponentAddonUI<T> createComponentUI(ComponentMetadata<T> metadata)
                                                         throws AddonException

Creates an component addon user interface compatible with the configuration metadata.

Parameters:

metadata - The metadata for which a component addon UI should be constructed.

Returns:

The created component addon UI.

Throws:

AddonException - Thrown if no factory for the given component metadata exists.

getComponentTypeIdentifiers

java.util.List<java.lang.String> getComponentTypeIdentifiers(java.lang.Class<? extends Configuration> configurationClass)

Returns the type identifiers of all component addons capable of consuming and creating configuration being sub-classes of the provided configuration class.

Parameters:

configurationClass - Configuration class for which all component type identifiers of configurations being sub-classes of this configuration should be returned.

Returns:

All type identifiers of component conforming to the given configuration class.

getComponentTypeIdentifiers

java.util.List<java.lang.String> getComponentTypeIdentifiers()

Returns the type identifiers of all components.

Returns:

All type identifiers of measurement components.

getComponentMetadata

<T extends Configuration> java.util.List<ComponentMetadata<? extends T>> getComponentMetadata(java.lang.Class<T> configurationClass)

Returns the metadata of all components being able to produce or consume sub-class of the provided configuration class.

Parameters:

configurationClass - Configuration class for which all metadata of componentsshould be returned.

Returns:

All metadata of components conforming to the given configuration class.

getComponentMetadata

java.util.List<ComponentMetadata<?>> getComponentMetadata()

Returns the metadata of all components.

Returns:

metadata of all components.

getComponentMetadata

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

Returns the metadata of the component having the given type identifier

Parameters:

typeIdentifier - type identifier of the component.

Returns:

The metadata of the component having given type identifier.

Throws:

AddonException - Thrown if no factory for the given component exists, or if the creation of the metadata failed.

getComponentMetadata

<T extends Configuration> ComponentMetadata<? extends T> getComponentMetadata(java.lang.String typeIdentifier,
                                                                              java.lang.Class<T> configurationClass)
                                                                       throws AddonException

Returns the metadata of the component having the given type identifier, with the component producing/consuming the given type of configurations.

Parameters:

typeIdentifier - type identifier of the component.

configurationClass - Configuration class of the component.

Returns:

Configurations metadata having the given type identifier.

Throws:

AddonException - Thrown if no factory for the given component exists, if the creation of the metadata failed, or if component cannot consume/produce given configuration class.

getMicroplateTypes

java.util.List<Microplate> getMicroplateTypes()

Returns all known microplate types.

Returns:

List of all known microplate types.

getMicroplateTypeIdentifiers

java.util.List<java.lang.String> getMicroplateTypeIdentifiers()

Returns the type identifiers of all known microplate types.

Returns:

List of all known microplate type identifier.

getMicroplateType

Microplate getMicroplateType(java.lang.String typeIdentifier)
                      throws AddonException

Returns the microplate type with the given type identifer.

Parameters:

typeIdentifier - Type identifier of the microplate.

Returns:

Microplate type with given type identifer.

Throws:

AddonException - Thrown if microplate type identifier is unknown.

createPostProcessorUI

AddonUI<? extends AddonMetadata> createPostProcessorUI(java.lang.String typeIdentifier,
                                                       java.lang.String measurementFolder)
                                                throws AddonException

Creates a post processor user interface for the given type identifier.

Parameters:

typeIdentifier - type identifier of the post processor.

measurementFolder - The folder where the measurement which should be processed is located.

Returns:

The created post processor UI with the given type identifier.

Throws:

AddonException - Thrown if no factory for the given post processor addon exists, or if the creation of the post processor failed.

createPostProcessorUI

<T extends AddonMetadata> AddonUI<T> createPostProcessorUI(T metadata,
                                                           java.lang.String measurementFolder)
                                                    throws AddonException

Creates an post processor user interface compatible with the metadata.

Parameters:

metadata - The metadata for which a post processor addon UI should be constructed.

measurementFolder - The folder where the measurement which should be processed is located.

Returns:

The created post processor addon UI.

Throws:

AddonException - Thrown if no factory for the given post processor metadata exists.

getPostProcessorTypeIdentifiers

java.util.List<java.lang.String> getPostProcessorTypeIdentifiers()

Returns the type identifiers of all post processors.

Returns:

All type identifiers of post processors.

getPostProcessorMetadata

java.util.List<AddonMetadata> getPostProcessorMetadata()

Returns the metadata of all post processors.

Returns:

metadata of all post processors.

getPostProcessorMetadata

AddonMetadata getPostProcessorMetadata(java.lang.String typeIdentifier)
                                throws AddonException

Returns the metadata of the post processor having the given type identifier

Parameters:

typeIdentifier - type identifier of the post processor.

Returns:

The metadata of the post processor having given type identifier.

Throws:

AddonException - Thrown if no factory for the given post processor exists, or if the creation of the metadata failed.

createToolUI

ToolAddonUI createToolUI(java.lang.String typeIdentifier)
                  throws AddonException

Creates a tool user interface for the given type identifier.

Parameters:

typeIdentifier - type identifier of the tool.

Returns:

The created tool UI with the given type identifier.

Throws:

AddonException - Thrown if no factory for the given tool exists, or if the creation of the tool failed.

createToolUI

ToolAddonUI createToolUI(ToolMetadata metadata)
                  throws AddonException

Creates a tool user interface compatible with the metadata.

Parameters:

metadata - The metadata for which a tool UI should be constructed.

Returns:

The created tool UI.

Throws:

AddonException - Thrown if no factory for the given tool metadata exists.

getToolTypeIdentifiers

java.util.List<java.lang.String> getToolTypeIdentifiers()

Returns the type identifiers of all tools.

Returns:

All type identifiers of tools.

getToolMetadata

java.util.List<ToolMetadata> getToolMetadata()

Returns the metadata of all tools.

Returns:

metadata of all tools.

getToolMetadata

ToolMetadata getToolMetadata(java.lang.String typeIdentifier)
                      throws AddonException

Returns the metadata of the tool having the given type identifier

Parameters:

typeIdentifier - type identifier of the tool.

Returns:

The metadata of the tool having given type identifier.

Throws:

AddonException - Thrown if no factory for the given tool exists, or if the creation of the metadata failed.

getScriptEngineFactories

java.util.List<javax.script.ScriptEngineFactory> getScriptEngineFactories()

Returns all script engine factories supported by the client.

Returns:

List of all script engines.

getScriptEngineFactory

javax.script.ScriptEngineFactory getScriptEngineFactory(java.lang.String typeIdentifier)
                                                 throws AddonException

Returns a script engine factory with the given type identifier.

Parameters:

typeIdentifier - The type identifier/name of the script engine factory. Same as ScriptEngineFactory.getEngineName().

Returns:

script engine factory for given type identifier.

Throws:

AddonException - Thrown if no script engine factory for the given type identifier exists.