org.adroitlogic.x.annotation.config

Annotation Type Processor

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
public @interface Processor

This annotation is used to indicate a class as a Processing Element. Any class that is annotated using this should adhere to the following guidelines.

1. This annotation can only be used on classes
2. The class must be public
3. The class should not be an abstract class
4. The class must be a subclass of org.adroitlogic.x.processor.AbstractProcessingElement class
5. The display name should be unique

A class with this annotation as a class level annotation can act as a processor in the integration flows defined by the project-x runtime. All user configurable parameters should be annotated with the Parameter annotation at the filed level, while all processing elements that are defined to be used for next level invocation should be annotated with the OutPort annotation at the field declaration level.

Processors defined in the class path with this annotation are presented in the design view of the flow designer tool to be dragged and dropped to use them in the integration flows with connections coming in from either one of the connectors or an another processing element to build a channel of processing units

Since:

17.01

Author:

Udith Gunaratna

See Also:

OutPort, Parameter, BeanRef

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	description Description of the processing element to be used for rendering purposes
String	displayName The name of the annotated processing element to be used in the user interface

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	customTypes Custom types of the annotated processing element, which will be used as a categorization of the processing elements
String	documentationURL The location of the documentation page for the particular Processing Element
String	iconFileName The name of the icon file to be used for the rendering purposes in the designer pallet
boolean	requireConfiguration If true, when processing element is added, the property pane will be visible automatically and if false, property pane will not be visible when element is added
ScopeType	scope Scope of the processing element which defines the places where an element annotated with this element can be placed in the design pallet
ProcessorType[]	type Types of the annotated processing element, which will be used as a categorization of the processing elements

Element Detail

displayName

public abstract String displayName

The name of the annotated processing element to be used in the user interface

Returns:

the display name of the processor

description

public abstract String description

Description of the processing element to be used for rendering purposes

Returns:

the description of the processing element

type

public abstract ProcessorType[] type

Types of the annotated processing element, which will be used as a categorization of the processing elements

Following strategy will be used when categorizing the processing element based on the value of this parameter and customTypes() parameter.

1. If only this parameter is defined and the customTypes() parameter is not, then the processing element will be categorized into all the ProcessorType values specified as the value of this parameter.
2. If the value of this parameter is ProcessorType.CUSTOM and the customTypes() parameter is defined, the processing element will be categorized into all the types specified as the value of customTypes() parameter.
3. If the value of this parameter contains any types other than ProcessorType.CUSTOM and the customTypes() parameter is also defined, the processing element will be categorized into all ProcessorType values specified as the value of this parameter as well as into the all the types specified as the value of customTypes() parameter.

Returns:

the types of the processing element

Default:

org.adroitlogic.x.api.config.ProcessorType.CUSTOM

customTypes

public abstract String[] customTypes

Custom types of the annotated processing element, which will be used as a categorization of the processing elements

For details of the categorization strategy, see the documentation of type() parameter.

Returns:

the custom types of the processing element

Default:

{}

iconFileName

public abstract String iconFileName

The name of the icon file to be used for the rendering purposes in the designer pallet

Returns:

the icon file name of the processor

Default:

"default"

scope

public abstract ScopeType scope

Scope of the processing element which defines the places where an element annotated with this element can be placed in the design pallet

Returns:

the scope of the processor element

Default:

org.adroitlogic.x.api.config.ScopeType.ALL

requireConfiguration

public abstract boolean requireConfiguration

If true, when processing element is added, the property pane will be visible automatically and if false, property pane will not be visible when element is added

Returns:

whether the configuration window should be visible or not

Default:

true

documentationURL

public abstract String documentationURL

The location of the documentation page for the particular Processing Element

Returns:

the URL of the documentation page

Default:

"https://developer.adroitlogic.com"