org.youscope.addon.tool

Interface ToolAddonFactory

All Known Implementing Classes:

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

public interface ToolAddonFactory

Author:

langmo

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

createToolUI

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

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.

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

getSupportedTypeIdentifiers

java.lang.String[] getSupportedTypeIdentifiers()

Returns all tool type identifiers supported by this addon

Returns:

Tool type identifiers.

isSupportingTypeIdentifier

boolean isSupportingTypeIdentifier(java.lang.String typeIdentifier)

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

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.

getToolMetadata

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

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

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.