Skip to content

Latest commit

 

History

History
47 lines (38 loc) · 2.98 KB

21.adoc

File metadata and controls

47 lines (38 loc) · 2.98 KB
Raw

Configuration and parametrizable options of the components should be identified and documented

Concreteness: abstract
Strength: recommended
Category: WG4
Status: final

Components in systems such as Alvis offer several parameters used to configure the behavior of the component execution. In order to help users understand a specific parameter and its role, the parameters should be well identified and described. The descriptions should contain information to help users understand how and in what context a parameter is used, and also provide the data types (e.g., boolean, integer, string) accepted by a parameter.

Product Version Compliant Justification Status

Alvis

0.5rc

Full

The parameters are well-typed in Alvis, they may be simple (e.g., integer, String, boolean) or complex (e.g., list, map). A description is planned for each parameter even if some parameters currently lack descriptions.

Draft

ARGO

0.5

Full

As Argo components are also UIMA components containing UIMA XML descriptor files, all configuration parameters have a name, a type (String, Integer, Float, or Boolean), an optional description, can be multivalued and also made to be mandatory. Argo also allows an additional layer of information on top of the UIMA configuration parameters, such as indicating whether a string represents a file, a folder, or an enumeration. This is intended to assist in both validation of configuration values and in providing the most appropriate graphical widgets within the Argo UI.

Draft

DKPro Core

1.8.0

Full

Parameters are implemented in DKPro Core through the uimaFIT @ConfigurationParameter annotation on class fields. These fields are typed and usually have documentation. They can have a default value and they can be marked as optional/mandatory. The annotation is retained for runtime such that parameter information can be dynamically obtained via uimaFIT. Additionally, UIMA XML descriptors are automatically generated for each component which also include the parameter declarations and default values. The parameter types supported are the standard UIMA-supported types (boolean, int, float, String). Additional types are supported via uimaFIT' automatic type-coercion mechanism. In this way, fields that are annotated as @ConfigurationParameter can e.g. be of the type File or Pattern or be different Java collection types or arrays.

Draft

GATE

8.2

Full

Each parameter is typed and has a name and an optional description (most have a description but it is currently optional)

Draft

ILSP

1.2.1

Full

Configuration parameters are declared via either UIMA XML descriptors and/or as uimaFIT @ConfigurationParameter annotations.

Draft