com.exalead.mercury.component.config

Interface CVComponentConfig

All Known Subinterfaces:

IntrospectionQuery, PushAPIFilterConfig

All Known Implementing Classes:

CheckConnectivity, CheckConnectivity.Answer, CheckEmbeddedCode, CheckEmbeddedCode.CompilationResult, ConfigUpdateChecker, ConfigUpdateChecker.Answer, ConnectorConfig, ContainerMultiThreadedConnectorConfig, CustomRTPublisherConfig, CustomScheduledPublisherConfig, CVComponentConfigNone, DatabaseConnectorConfig, DatabaseConnectorConfig.ConnectionProperty, DemoFileSystemConnectorConfig, DummySecuritySourceConfig, com.exalead.papi.connectors.filesystem.FilesystemConnectorConfig, FilesystemConnectorConfig, FullRescanConfig, GenericContainerMultiThreadedConnectorConfig, GenericMultiThreadedConnectorConfig, HashPushAPIFilterConfig, IsFetchOperationSupported, JDBCConnectorInfoRequest2, MetaBasedFilterConfig, MultiThreadedConnectorConfig, MyPushAPIFilterConfig, MyPushAPIFilterConfig, MyPushAPIFilterConfig, MyPushAPIFilterConfig, MyPushAPIFilterConfig, PushAPIFilterConfig.DefaultImpl, SampleCSVConnectorConfig, SecuritySourceConfig, SimpleXMLConnectorConfig, SuggestOption, SuggestOption.SuggestResult, UpgradeConfig, XMLConnectorConfig

public interface CVComponentConfig

Base interface for Cloudview components Config.

This is a simple bean used to contain the configuration of a CVComponent. To manage the configuration of your component, you have to extend this class. Your class must have a public constructor with no parameter.

To define a property of configuration, you have to add a setter method and a getter method to your inherited class.

Setters are public methods, taking exactly one argument and returning no argument. Setters names begins with "set" (in lowercase), followed by the property name. Getters names begins with "get" (in lowercase), have no argument, and should return the same argument as their setter equivalent.

Example:
public void setSize(int size) this.size = size;
public int getSize() return this.size;
public void setSubConfig(MyConfig config) this.config = config;
public MyConfig getSubConfig() return this.config;

The parameter (setters or getters) can be of the following types:

• java.lang.String
• byte, char, short, int, long, float, double, boolean
• any class embedding a "public static T valueOf(String value)" function (T must match the class type) ; this includes boxed base types (Integer, Boolean ..)
• any class embedding a "public (String value)" constructor with a matching "String toString()"
• any class embedding public setters
• any array (one dimension) of the previous types
• an array of Interface for dynamic types ; the default config getter shall return a list of types implementing this interface, with default values

In addition, setters (only setters) methods can be annotated using com.exalead.config.bean annotation classes:

• IsMandatory is the given property mandatory in the configuration

See Also:

PropertyDescription description ; used for GUI purpose,

PropertyLabel label,

IsHidden is the given property hidden ; allows to exclude a setter as if it was declared private (to remove a superclass setter, for example),

BeeKeyValueType the exa:KeyValue "type" argument,

An optional getDefaultForcedMeta() can be defined in classes embedding setters to order configuration fields (the default configuration will have their fields ordered using this method):
{@code public static exa.bee.KeyValue[] getDefaultForcedMeta();}