Setter/Getter methods

This section describes the setter and getter methods when packaging your CVPlugin.

This page discusses:

See Also
About the CVPlugin public class
Top level component class(es)
Setter/Getter methods

About setters

Setters are:

  • public methods that do not return any value (void return type),

  • whose names are prefixed by set (the property names following the set prefix keep the same letter case),

  • and take exactly one argument (the value to be set).

Setters may bear annotations, see Setter function annotations. Setters annotated with the IsHidden (com.exalead.config.bean.IsHidden) class are ignored.

These are the setters for the Proxy and ProxyPort properties. 

@IsMandatory(false)
@PropertyLabel("Proxy to use")
public void setProxy(final String proxy) {
    this.proxy = proxy;
}
@IsMandatory(false)
@PropertyLabel("Proxy port to use")
public void setProxyPort(final int port) {
    this.port = port;
}
Note: The first upper case is kept for the property name.

Each setter method should be associated with a getter method.

About getters

Getters are:

  • public methods returning a value,

  • the returned value should be equivalent to the value taken as argument in the setter,

  • and take no argument.

Getters do not bear any annotation.

These are the getters for the Proxy and ProxyPort properties. 

public String getProxy()
{
    return proxy;
}
public int getProxyPort()
{
    return proxy;
}
Note: The first upper case is kept for the property name.

The available types, recognized by the framework for setters and getters are the following ones:

  • The String class.

  • Base boolean types: boolean, Boolean.

  • Base numerical types: byte, char, short, int, long, float, double, Boolean, Byte, Character, Short, Integer, Long, Float, Double.

  • Any class supporting the public static valueOf method taking exactly one String argument, and returning an object of its own class (in this case, the toString method from the Object base class will also be used); such as enums classes.

  • Any class taking exactly one String argument (in this case, the toString method from the Object base class will also be used); such as the Date class.

  • Generic Interface class (to accept outer components in configurations; used internally only).

  • An array of an allowed type.

Example of array parameters:

public class NotesServerConfig implements CVComponentConfigSamplify {
     public static class NotesDBRule
     {
         public NotesDBRule(final String rule)
         {
             this.rule = rule;
         }
         public NotesDBRule()
         {
         } 

         protected String rule;
         public String getRule()
         {
             return rule;
         }
         @Override public String toString() {
             return getRule();
         }
     }

     private NotesDBRule[] includes = new NotesDBRule[] {};

     @IsMandatory(false)
     @PropertyLabel("Include rules (regular expression)")
     public void setIncludes(final NotesDBRule[] includes) {
         this.includes = includes;
     }

     public NotesDBRule[] getIncludes() {
         return includes;
     }
}

Setter function annotations

The following annotation classes may be used in setters to provide additional information on property types and settings.

Annotation

Description

@BeeKeyValueType (com.exalead.config.bean.BeeKeyValueType)

Possible values include:

  • string for generic string,
  • numeric for a signed long integer value,
  • enum:value1,value2... for a selection restricted to certain values.
  • encrypted for values that shall be encrypted, such as passwords.
  • hidden for values that must not be displayed/edited at all. Consider using @IsHiddenUI instead.

@Connector (com.exalead.config.bean.Connector)

Displays a combo box to list configured connectors. The list of connectors can be restricted with the following flags:

  • allowSelf: if the component describes a connector, it indicates whether this connector is included in the combobox (default is false).
  • allowDeployed: indicates whether deployed connectors are listed (default is true).
  • allowUndeployed: indicates whether undeployed connectors are listed (default is true)
  • allowUnmanaged: indicates whether unmanaged connectors are listed (default is true)
  • allowManaged: indicates whether managed connectors are listed (default is true)
  • allowedClassId: a regular expression to filter by connector classid. If the regular expression is an empty string, then all connectors are listed.
  • forbiddenClassId: a regular expression to exclude connectors by classid.
  • allowEmpty: adds an extra empty option in the combo box. Property value will be "" when this option is selected.

@DataModelClass (com.exalead.config.bean.DataModelClass)

Displays a combo box to list available classes in all configured data models. The data models to search classes in can be restricted with the following options (both options are mutually exclusive):

  • dataModel: only list classes of the given data model.
  • buildGroup: only list classes of the data model referenced by the given build group.

@Date (com.exalead.config.bean.Date)

Displays a calendar to configure the property field. The property field will be stored as a string formatted with the date format specified in the annotation.

Default date format is: @Date(format=“yyyy-MM-dd”)

Example: If you add a startDate field with 

@Date(format=“yyyy-MM-dd”)
public void setStartDate(String startDate) {
    this.startDate = startDate;
}

The UI will display: Start date: [calendar widget]

And when dates are saved, they will be stored with the yyyy-MM-dd date format.

@DateTime (com.exalead.config.bean.DateTime)

Same as @Date with time information.

Default datetime format is: @DateTime(format=“yyyy-MM-dd HH:mm:ss”)

@EnumFieldType (com.exalead.config.bean.EnumFieldType)

The given setter takes only a subset of String representations (enum) as value.

Example:

@EnumFieldType(possibleValue = { @PossibleValueType("red"),

@PossibleValueType("green"), @PossibleValueType("blue") })

Note: in @PossibleValueType you can associate a label to each value.

@IsHidden (com.exalead.config.bean.IsHidden)

The given setter is to be ignored. For example, you can use it if the function is not part of the bean setter subset.

Example:

@IsHidden()

@IsHiddenUI (com.exalead.config.bean.IsHiddenUI)

The given setter property should not be editable or displayed, but must still be processed as a regular property. Use it to hide internal properties.

Example:

@IsHiddenUI()

@IsMandatory (com.exalead.config.bean.IsMandatory)

If the associated boolean is true, then the given setter property must be defined (non-empty unserialized value) so that the configuration can be considered as valid.

Otherwise, the property will be considered as optional.

Note: Without this annotation, the default is mandatory.

Example:

@IsMandatory(false)

@MultiLineString (com.exalead.config.bean.MultiLineString)

Displays a multi-line text input control.

@Path (com.exalead.config.bean.Path)

Displays a file chooser widget, that browses Exalead CloudView host filesystem.

@PropertyDescription (com.exalead.config.bean.PropertyDescription)

The property description, as a string. Typically displayed for comment or tooltip. It supports text only, no HTML code.

Example:

@PropertyDescription("Define the hostname to be used for the proxy")

@PropertyLabel (com.exalead.config.bean.PropertyLabel)

The property label, as a string. Typically displayed for short name.

Example:

@PropertyLabel("Proxy hostname")

@SecuritySource (com.exalead.config.bean.SecuritySource)

Displays a combo box to list configured security sources. The list of security sources can be restricted with the following flags:

  • allowSelf: if the component describes a security source, indicates whether this security source is included in the combobox (default is false)
  • allowDeployed: indicates whether deployed security sources are listed (default is true)
  • allowUndeployed: indicates whether undeployed security sources are listed (default is true)
  • allowedClassId: a regular expression to filter by security source classid. If the regular expression is an empty string, then all security sources are listed.
  • forbiddenClassId: a regular expression to exclude security sources by classid.
  • allowEmpty: adds an extra empty option in the combo box. Property value will be "" when this option is selected.

@WithSuggest (com.exalead.config.bean.WithSuggest)

Displays a text input that performs remote queries to suggest entries. In order to remote suggestions to work, the CVComponent must support SuggestOption queries. Here is a full example:

Component config class:

MyComponentConfig extends ConnectorConfig {
	...
	
	private String folder;
	
	@WithSuggest
	public void setFolder(String folder) {
		this.folder = folder;
	}
}

Component class:

@IntrospectableComponent(introspectorClass=MyComponentIntrospector.class, 
supportedQueries = {@SupportedQuery(queryClass = SuggestOption.class)})
class MyComponent extends Connector {
	...
}

Introspector class:

class MyComponentIntrospector implements CVComponentIntrospector {
 public Object execute(CVComponentConfig componentConfig, IntrospectionQuery query) throws Exception {
   if (query instanceof SuggestOption) {
	 SuggestOption suggestQuery = (SuggestOption) query;
	 SuggestOption.SuggestResult result = new SuggestOption.SuggestResult();
	
    // disambiguate by field name if you have several fields annotated with @WithSuggest		
	 if ("Folder".equals(suggestQuery.getConfigKey())) { 
	  String currentValue = suggestQuery.getCurrentValue();
	  MyComponentConfig myConfig = (MyComponentConfig) componentConfig;
	  String[] suggestedValues = ...;
	  result.setSuggestedValues(suggestedValues);
	 }
			
	 return result;
	}
   throw new IllegalStateException("Unknown introspection query");
 }
}

Available classes for setters and getters

The following classes can be used in setters and getters.

Class

Description

BooleanChecked (com.exalead.config.bean.BooleanChecked)

Ensures that the value entered for an option is either true or false.

Use it with boolean options to enforce the option values to true or false.

BytesValue (com.exalead.config.bean.BytesValue)

A value representing a number of Bytes, in any SI Unit.

For example, you can use "10KB" or "10MB" as value, and still handle an amount of bytes in your code.

MillisecondsValue (com.exalead.config.bean.MillisecondsValue)

A value representing a number of milliseconds, in any SI Unit.

For example, you can use "2min" or "5s" as value, and still handle an amount of milliseconds in your code.

OptionalBoolean (com.exalead.config.bean.OptionalBoolean)

A value representing a tri-state Boolean value, with checked value (true, false or optional)

KeyValue (com.exalead.config.bean.KeyValue)

A value representing a pair of strings (key and a value).

Possible Setter exceptions

A setter may raise exceptions, such as NumberFormatException or IllegalArgumentException, but we strongly recommend using the following built-in exceptions.

Recommended exception

Description

ConfigurationException (com.exalead.config.bean.ConfigurationException)

Generic exception thrown when a configuration exception occurs.

IllegalValueException (com.exalead.config.bean.IllegalValueException)

Exception thrown when a setter encounters an illegal value.