org.youscope.addon.component

Class GenericComponentMetadata<C extends Configuration>

java.lang.Object

org.youscope.addon.component.GenericComponentMetadata<C>

Type Parameters:

C - Specific subclass of configuration for which an UI should be created.

All Implemented Interfaces:

AddonMetadata, ComponentMetadata<C>

public class GenericComponentMetadata<C extends Configuration>
extends java.lang.Object
implements ComponentMetadata<C>

Helper class to construct configuration metadata. Most of the metadata is directly extracted from the configuration class using java reflection. During this extraction, the annotations defined in org.youscope.common.configuration.annotations are used, if given, or generic names for the respective properties is extracted given e.g. the name of the class.

Author:

Moritz Lang

Constructor Summary

Constructors

Constructor and Description
GenericComponentMetadata(java.lang.String typeIdentifier, java.lang.Class<C> configurationClass, java.lang.Class<? extends Component> componentInterface) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getClassification() Returns an array of strings (possibly of length 0) specifying the classification of the addon.
java.lang.Class<? extends Component>	getComponentInterface() Returns the interface of the measurement component created when the configuration is parsed.
java.lang.Class<C>	getConfigurationClass() Returns the class of the configuration of the measurement component.
javax.swing.ImageIcon	getIcon() Returns an icon representative for this addon, or null if no icon is set.
java.lang.String	getTypeIdentifier() Returns the type identifier of the addon.
java.lang.String	getTypeName() Returns a short human readable name of the addon.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericComponentMetadata

public GenericComponentMetadata(java.lang.String typeIdentifier,
                                java.lang.Class<C> configurationClass,
                                java.lang.Class<? extends Component> componentInterface)

Constructor.

Parameters:

typeIdentifier - Type identifier of the configuration.

configurationClass - Class of the configuration.

componentInterface - The interface of the measurement component which is created when the configuration is compiled.

Method Detail

getTypeName

public java.lang.String getTypeName()

Description copied from interface: AddonMetadata

Returns a short human readable name of the addon.

Specified by:

getTypeName in interface AddonMetadata

Returns:

Human readable name of the addon.

getConfigurationClass

public java.lang.Class<C> getConfigurationClass()

Description copied from interface: ComponentMetadata

Returns the class of the configuration of the measurement component. The class should have a public no-argument constructor, such that newInstance() can be called.

Specified by:

getConfigurationClass in interface ComponentMetadata<C extends Configuration>

Returns:

Configuration class of component.

getTypeIdentifier

public java.lang.String getTypeIdentifier()

Description copied from interface: AddonMetadata

Returns the type identifier of the addon.

Specified by:

getTypeIdentifier in interface AddonMetadata

Returns:

Type identifier of the addon.

getIcon

public javax.swing.ImageIcon getIcon()

Description copied from interface: AddonMetadata

Returns an icon representative for this addon, or null if no icon is set.

Specified by:

getIcon in interface AddonMetadata

Returns:

Icon representative of this addon.

getClassification

public java.lang.String[] getClassification()

Description copied from interface: AddonMetadata

Returns an array of strings (possibly of length 0) specifying the classification of the addon. This classification can e.g. be used to order addons into a certain folder structure.

Specified by:

getClassification in interface AddonMetadata

Returns:

classification of addon.

getComponentInterface

public java.lang.Class<? extends Component> getComponentInterface()

Description copied from interface: ComponentMetadata

Returns the interface of the measurement component created when the configuration is parsed. This should not be the implementation of the component, but rather a public interface implementing Remote.

Specified by:

getComponentInterface in interface ComponentMetadata<C extends Configuration>

Returns:

Component interface.