org.youscope.plugin.customjob

Class CustomJobAddonFactory

java.lang.Object

org.youscope.plugin.customjob.CustomJobAddonFactory

All Implemented Interfaces:

ComponentAddonFactory

public class CustomJobAddonFactory
extends java.lang.Object
implements ComponentAddonFactory

Author:

Moritz Lang

Constructor Summary

Constructors

Constructor and Description
CustomJobAddonFactory()

Method Summary

Modifier and Type	Method and Description
Component	createComponent(PositionInformation positionInformation, Configuration configuration, ConstructionContext constructionContext) Creates an addon for the given configuration.
ComponentAddonUI<?>	createComponentUI(java.lang.String typeIdentifier, YouScopeClient client, YouScopeServer server) Returns a new UI to configure a component of the given type identifier.
ComponentMetadata<?>	getComponentMetadata(java.lang.String typeIdentifier) Returns the metadata (like human readable name) for a given configuration type.
java.lang.String[]	getSupportedTypeIdentifiers() Returns a list of all component type identifiers supported by this factory.
boolean	isSupportingTypeIdentifier(java.lang.String typeIdentifier) Returns true if this factory supports 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

CustomJobAddonFactory

public CustomJobAddonFactory()

Method Detail

createComponentUI

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

Description copied from interface: ComponentAddonFactory

Returns a new UI to configure a component of the given type identifier.

Specified by:

createComponentUI in interface ComponentAddonFactory

Parameters:

typeIdentifier - The ID for which a configuration addon should be created.

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

server - Interface to the server.

Returns:

The created addon for a given configuration type.

Throws:

AddonException - Thrown if configuration type identifier is not supported by this factory, or if any general error occured during the configuration addon creation.

getSupportedTypeIdentifiers

public java.lang.String[] getSupportedTypeIdentifiers()

Description copied from interface: ComponentAddonFactory

Returns a list of all component type identifiers supported by this factory. A type identifier is a string unique for a given component type, with which the component type is identified.

Specified by:

getSupportedTypeIdentifiers in interface ComponentAddonFactory

Returns:

List of supported component types.

isSupportingTypeIdentifier

public boolean isSupportingTypeIdentifier(java.lang.String typeIdentifier)

Description copied from interface: ComponentAddonFactory

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

Specified by:

isSupportingTypeIdentifier in interface ComponentAddonFactory

Parameters:

typeIdentifier - The ID of the configuration for which it should be queried if this factory supports its construction.

Returns:

True if this factory supports creating configurations with the given ID, false otherwise.

getComponentMetadata

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

Description copied from interface: ComponentAddonFactory

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

Specified by:

getComponentMetadata in interface ComponentAddonFactory

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.

createComponent

public Component createComponent(PositionInformation positionInformation,
                                 Configuration configuration,
                                 ConstructionContext constructionContext)
                          throws ConfigurationException,
                                 AddonException

Description copied from interface: ComponentAddonFactory

Creates an addon for the given configuration. Throws a construction addon exception if the configuration type provided is not supported.

Specified by:

createComponent in interface ComponentAddonFactory

Parameters:

positionInformation - The position in the measurement hierarchy where the addon should be constructed.

configuration - The configuration of the addon.

constructionContext - The context of the construction, providing information and functionality in the construction of the addon.

Returns:

The constructed addon.

Throws:

ConfigurationException - Thrown if the configuration is invalid.

AddonException - Thrown if an error occurred during the construction.