org.dllearner.core
Annotation Type ComponentAnn

@Retention(value=RUNTIME)
public @interface ComponentAnn

Annotation for DL-Learner components. Each component has to implement the interface as well as use this notation.

Author:

Jens Lehmann

Required Element Summary

String	name The name of this component.
String	shortName The short name of this component, which should exclusively consist of lower case ASCII symbols without whitespace.
double	version The version of this component. 1.0 indicates a stable component.

Optional Element Summary

String

description An optional description of the component.

Element Detail

name

public abstract String name

The name of this component.

Returns:

The name of this component.

See Also:

ComponentManager#getName(Component)

shortName

public abstract String shortName

The short name of this component, which should exclusively consist of lower case ASCII symbols without whitespace.

Returns:

The short name of this component.

version

public abstract double version

The version of this component. 1.0 indicates a stable component. Developers should increase the version number in case of major implementation changes.

Returns:

A version number of this component.

description

public abstract String description

An optional description of the component. This can be shown in tool tips, help etc.

Returns:

The description of the component.

Default:

""