org.youscope.addon.tool

Class ToolAddonFactoryAdapter

java.lang.Object

org.youscope.addon.tool.ToolAddonFactoryAdapter

All Implemented Interfaces:

ToolAddonFactory

Direct Known Subclasses:

CustomJobToolFactory, CustomMicroplatesFactory, DeviceSettingManagerFactory, FluigentControllerFactory, LiveStreamFactory, MeasurementViewerFactory, MultiCameraAndColorStreamFactory, MultiColorStreamFactory, MultiStreamFactory, NemesysControllerFactory, OnixControllerFactory, OpenHouseFactory, PositionControlFactory, ScriptingToolFactory, SlimIdentificationFactory, TemplateToolFactory, YouPongFactory

public class ToolAddonFactoryAdapter
extends java.lang.Object
implements ToolAddonFactory

Adapter simplifying tool addon creation.

Author:

Moritz Lang

Constructor Summary

Constructors

Constructor and Description
ToolAddonFactoryAdapter() Constructor.
ToolAddonFactoryAdapter(java.lang.Class<? extends ToolAddonUI> toolAddonUIClass, ToolMetadata metadata) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addAddon(java.lang.Class<? extends ToolAddonUI> toolAddonUIClass, ToolMetadata metadata) Adds an addon.
ToolAddonUI	createToolUI(java.lang.String typeIdentifier, YouScopeClient client, YouScopeServer server) Returns the UI of a Tool for the given type identifier.
java.lang.String[]	getSupportedTypeIdentifiers() Returns all tool type identifiers supported by this addon
ToolMetadata	getToolMetadata(java.lang.String typeIdentifier) Returns the metadata (like human readable name) for the tool with the given type identifier.
boolean	isSupportingTypeIdentifier(java.lang.String typeIdentifier) Returns true if this addon supports tools with the given type identifier, false otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolAddonFactoryAdapter

public ToolAddonFactoryAdapter(java.lang.Class<? extends ToolAddonUI> toolAddonUIClass,
                               ToolMetadata metadata)

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

Parameters:

toolAddonUIClass - The class of the UI exposed to the user.

metadata - Metadata about this tool.

ToolAddonFactoryAdapter

public ToolAddonFactoryAdapter()

Constructor. Factory does no (yet) expose any addon. Use addAddon(java.lang.Class<? extends org.youscope.addon.tool.ToolAddonUI>, org.youscope.addon.tool.ToolMetadata) to expose addons.

Method Detail

addAddon

public void addAddon(java.lang.Class<? extends ToolAddonUI> toolAddonUIClass,
                     ToolMetadata metadata)

Adds an addon. When invoked, the factory exposes the given tool addon.

Parameters:

toolAddonUIClass - The class of the UI exposed to the user.

metadata - Metadata about this tool.

getSupportedTypeIdentifiers

public java.lang.String[] getSupportedTypeIdentifiers()

Description copied from interface: ToolAddonFactory

Returns all tool type identifiers supported by this addon

Specified by:

getSupportedTypeIdentifiers in interface ToolAddonFactory

Returns:

Tool type identifiers.

isSupportingTypeIdentifier

public boolean isSupportingTypeIdentifier(java.lang.String typeIdentifier)

Description copied from interface: ToolAddonFactory

Returns true if this addon supports tools with the given type identifier, false otherwise.

Specified by:

isSupportingTypeIdentifier in interface ToolAddonFactory

Parameters:

typeIdentifier - The type identifier of the tool for which it should be queried if this addon supports it.

Returns:

True if this addon supports tools with the given type identifier, false otherwise.

createToolUI

public ToolAddonUI createToolUI(java.lang.String typeIdentifier,
                                YouScopeClient client,
                                YouScopeServer server)
                         throws AddonException

Description copied from interface: ToolAddonFactory

Returns the UI of a Tool for the given type identifier. If tools with the given type identifier are not supported by this factory, throws an AddonException.

Specified by:

createToolUI in interface ToolAddonFactory

Parameters:

typeIdentifier - The type identifier of the tool.

client - YouScope client.

server - YouScope server.

Returns:

The created tool UI.

Throws:

AddonException - Thrown if tools with given type identifier are not supported by this factory.*

getToolMetadata

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

Description copied from interface: ToolAddonFactory

Returns the metadata (like human readable name) for the tool with the given type identifier.

Specified by:

getToolMetadata in interface ToolAddonFactory

Parameters:

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

Returns:

The metadata of the given tool.

Throws:

AddonException - Thrown if type identifier is not supported by the factory.