org.adroitlogic.x.annotation.config

Annotation Type Parameter

@Target(value={FIELD,PARAMETER})
 @Retention(value=RUNTIME)
 @Documented
 @Inherited
public @interface Parameter

This annotation is used to indicate a field or a parameter as user supplied. Any field or parameter that is annotated using this should adhere to the following guidelines.

1. This annotation can only be used on fields or parameters.
2. The display name of the Parameter should be unique within the class.

Flow designer user interface rendering will use this annotation to present the user interface controls to provide the input for the configured parameters/fields. This annotation can be used in classes which represent processors where they are annotated with Processor annotation of connectors where they are either annotated with IngressConnector or EgressConnector annotations or connector operations where they are annotated with ConnectorOperation annotation, to provide the information on its input fields

Since:

17.01

Author:

Ruwan Linton

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	displayName The display name to be used for the input control label in the flow designer

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	category Category to which this parameter belongs to for the belonging processor, connector or the connector operation.
String	defaultValue The default value assigned for this parameter if it is not provided by the user.
String	dependentPropertyName This field and hideOnDependentPropValue() properties can be used toggle the availability of a particular parameter in the property pane based on the user specified value of another parameter.
String	description Description of the parameter to be used for rendering of the input controls.
String[]	hideOnDependentPropValue This property is used in conjunction with dependentPropertyName() to hide the parameter in the property pane for the specified value(s) of the dependentPropertyName()
InputType	inputType Type of the form input to be used for the input controls
boolean	isOptional Specifies whether this parameter is optional or mandatory to the operations of the processor, connector or the connector operation that this parameter is associated with
MetaType	metaType The meta-type of the parameter which is used to identify certain meta-information related to the configuration parameters of the processors, connectors or connector operations.
int	order Order in which the parameters annotated with this annotation are rendered in the input form of the processor, connectors or connector operations
String	placeHolder The place holder to be used in the input controls if applicable.
String[]	possibleValues Possible values that can be used for the parameter, which is generally used in conjunction with the inputType() specified as InputType.SELECT to specify the values rendered in the select control
String	propertyName Name of the property key to be used if the value of the parameter should be externalized.
String[]	showOnDependentPropValue This property is used in conjunction with dependentPropertyName() to show the parameter in the property pane for the specified value(s) of the dependentPropertyName()
String	validator Input validator as a regular expression for this parameter input validation.

Element Detail

displayName

public abstract String displayName

The display name to be used for the input control label in the flow designer

Returns:

the display name of the parameter

order

public abstract int order

Order in which the parameters annotated with this annotation are rendered in the input form of the processor, connectors or connector operations

Returns:

the order in which this field input control is positioned over others

Default:

0

inputType

public abstract InputType inputType

Type of the form input to be used for the input controls

Returns:

the type of the input

Default:

org.adroitlogic.x.api.config.InputType.TEXT_BOX

description

public abstract String description

Description of the parameter to be used for rendering of the input controls. It will be used as the help text for the input controls in the rendered user interface form

Returns:

the description of the parameter

Default:

""

placeHolder

public abstract String placeHolder

The place holder to be used in the input controls if applicable. If the text input controls are used this is used for the place holder of the text input controls

Returns:

the place holder value of the parameter

Default:

""

possibleValues

public abstract String[] possibleValues

Possible values that can be used for the parameter, which is generally used in conjunction with the inputType() specified as InputType.SELECT to specify the values rendered in the select control

Returns:

the possible values for the parameter

Default:

{}

validator

public abstract String validator

Input validator as a regular expression for this parameter input validation. This is used to match and validate the input provided by the user for this parameter value

Returns:

the validator regular expression for the parameter input

Default:

".*"

isOptional

public abstract boolean isOptional

Specifies whether this parameter is optional or mandatory to the operations of the processor, connector or the connector operation that this parameter is associated with

Returns:

true if this parameter is optional, false if it is mandatory

Default:

false

category

public abstract String category

Category to which this parameter belongs to for the belonging processor, connector or the connector operation. Based on the categorizations specified, the input controls representing the parameters are rendered into different tabs

Returns:

the category to which this parameter belongs to, which defaults to "Basic"

Default:

"Basic"

defaultValue

public abstract String defaultValue

The default value assigned for this parameter if it is not provided by the user. If this default value is present the placeHolder() would not be useful.

Returns:

the default value to be used for the parameter annotated with this annotation

Default:

""

metaType

public abstract MetaType metaType

The meta-type of the parameter which is used to identify certain meta-information related to the configuration parameters of the processors, connectors or connector operations.

Returns:

the meta type of this parameter which defaults to MetaType.NONE

Default:

org.adroitlogic.x.api.config.MetaType.NONE

propertyName

public abstract String propertyName

Name of the property key to be used if the value of the parameter should be externalized. The user specified value will be inserted to the default.properties file within main/resources directory under the specified property name. NOTE: If a non-empty property name is specified, the parameter value will be externalized.

Returns:

the name of the property key to be used. Default value is an empty string.

Default:

""

dependentPropertyName

public abstract String dependentPropertyName

This field and hideOnDependentPropValue() properties can be used toggle the availability of a particular parameter in the property pane based on the user specified value of another parameter.

As an example suppose there are two InputType.SELECT parameters. One to select the Country and other one to select the State. But the State drop down list should be shown only when USA is selected from the Country list. In this case for the State parameter, you can specify the actual variable name of the Country parameter as dependentPropertyName and specify String array with "USA" for showOnDependentPropValue.

Similarly if you want to hide a parameter for a specific property value, specify that under the hideOnDependentPropValue.

You cannot use both hideOnDependentPropValue() and showOnDependentPropValue() at the same time for a given parameter. You have to use the most appropriate one.

NOTE: This dynamic toggling the visibility of parameters only works when the dependent property is of type InputType.SELECT, InputType.CHECK_BOX

Returns:

the variable name of the dependent property

Default:

""

hideOnDependentPropValue

public abstract String[] hideOnDependentPropValue

This property is used in conjunction with dependentPropertyName() to hide the parameter in the property pane for the specified value(s) of the dependentPropertyName()

Returns:

an array of String which contains the value(s) of dependentPropertyName() where the parameter should be hidden from the property pane.

Default:

{}

showOnDependentPropValue

public abstract String[] showOnDependentPropValue

This property is used in conjunction with dependentPropertyName() to show the parameter in the property pane for the specified value(s) of the dependentPropertyName()

Returns:

an array of String which contains the value(s) of dependentPropertyName() where the parameter should be shown on the property pane.

Default:

{}