ch.unibe.iam.scg.archie.annotations
Annotation Type GetProperty

@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface GetProperty

Marks a method as getter. Used by the view to determine which elements can be changed by the user. This is a model driven design. The value of this annotation is used to describe the field in the view.

$Id$

Required Element Summary

java.lang.String

name Property name.

Optional Element Summary

java.lang.String	description A brief description about the getter method.
int	index Property index.
java.lang.String[]	items Returns a list of items for a given getter method.
java.lang.String	validationMessage A validation error message that will be displayed upon unsuccessful validation of the input for the method containing this annotation.
java.lang.String	validationRegex A regular expression pattern string to be performed as validations on the given method.
java.lang.Class<?>	vendorClass Custom widget implementors can define their own widget class and pass it to the getter method.
WidgetTypes	widgetType Widget type.

Element Detail

name

public abstract java.lang.String name

Property name. There has to be a setter method annotated with a SetProperty method with the same value to have any effect on the data provider. This name will also be the title of the corresponding widget shown in the UI.

Returns:

String name

description

public abstract java.lang.String description

A brief description about the getter method. This is used for tooltips in the UI.

Returns:

String A description.

Default:

""

index

public abstract int index

Property index. Defines the order in which this property is displayed and processed.

Returns:

Integer Order in which the fields are displayed and processed.

Default:

-1

widgetType

public abstract WidgetTypes widgetType

Widget type. What kind of widget?

Default:

ch.unibe.iam.scg.archie.ui.widgets.WidgetTypes.TEXT

validationRegex

public abstract java.lang.String validationRegex

A regular expression pattern string to be performed as validations on the given method.

Returns:

String Regular expression pattern.

See Also:

Pattern

Default:

""

validationMessage

public abstract java.lang.String validationMessage

A validation error message that will be displayed upon unsuccessful validation of the input for the method containing this annotation.

Returns:

String Validation error message.

Default:

""

items

public abstract java.lang.String[] items

Returns a list of items for a given getter method. This is only used if the widget is of type ComboWidget ( WidgetTypes.COMBO). The default value is an empty string array, the method is ignored for other types of widgets.

Returns:

Array of strings, empty string array by default.

Default:

""

vendorClass

public abstract java.lang.Class<?> vendorClass

Custom widget implementors can define their own widget class and pass it to the getter method. This property only needs to be set when you implement your own widget, USE AT OWN RISK, the framework is not responsible for UI inconsistencies caused by custom widgets. Default widget class is TextWidget class.

Returns:

The widget class defined by this annotation.

Default:

ch.unibe.iam.scg.archie.ui.widgets.TextWidget.class