org.universAAL.tools.ucc.configuration.model

Class ConfigurationOption

java.lang.Object

org.universAAL.tools.ucc.configuration.model.ConfigurationOption

All Implemented Interfaces:

Comparable<ConfigurationOption>

Direct Known Subclasses:

MapConfigurationOption, SimpleConfigurationOption

public abstract class ConfigurationOption
extends Object
implements Comparable<ConfigurationOption>

This class is an abstraction of the configuration items in XML configuration definition file. It holds the configuration definition of the item, the validators and some other logic.

Author:

Sebastian.Schoebinge

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigItem	configItem
protected List<Value>	values

Constructor Summary

Constructors

Constructor and Description
ConfigurationOption(ConfigItem configItem, Category category, ConfigOptionRegistry configOptionRegistry) Load validators and on configuration changed listeners.

Method Summary

Modifier and Type	Method and Description
void	addExternalListener(OnConfigurationChangedListener listener)
void	addListener(OnConfigurationChangedListener listener)
void	addValidator(String key, ConfigurationValidator validator)
void	checkDependencies() If the configuration option has dependencies then this method checks all configuration options on which this configuration option depends and if they are valid then this configuration option will be activated.
int	compareTo(ConfigurationOption o)
void	doDeepValidation() Executes the validators and if an error accrues the ValidationException will be thrown.
Category	getCategory()
ConfigOption	getConfigOption()
String	getDescription()
String	getId()
String	getLabel()
int	getOrder()
String	getValue()
List<Value>	getValues()
int	getValuesCount()
boolean	hasValue()
boolean	isActive()
boolean	isRequired()
boolean	isValid() The configuration option is valid if all validators valid and if it is required it also needs a value.
void	removeExternalListener(OnConfigurationChangedListener listener)
void	removeListener(OnConfigurationChangedListener listener)
void	removeValidator(ConfigurationValidator validator)
void	setCardinality(Cardinality cardinality)
void	setIsActive(boolean active)
void	setValue(List<Value> configValues) Set value for multiple selection.
void	setValue(Value value) Set the value, execute validators and update the listeners.
protected void	updateExternalListeners()
protected void	updateListeners()
void	updateValidatorAttributesForId(String name, String[] attributes)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configItem

protected ConfigItem configItem

values

protected List<Value> values

Constructor Detail

ConfigurationOption

public ConfigurationOption(ConfigItem configItem,
                           Category category,
                           ConfigOptionRegistry configOptionRegistry)

Load validators and on configuration changed listeners. Resister at the configuration option registry

Parameters:

configItem -

category -

configOptionRegistry -

Method Detail

setValue

public void setValue(Value value)
              throws ValidationException

Set the value, execute validators and update the listeners.

Parameters:

value -

Throws:

ValidationException

setValue

public void setValue(List<Value> configValues)
              throws ValidationException

Set value for multiple selection.

Parameters:

configValues -

Throws:

ValidationException

getValue

public String getValue()

getValuesCount

public int getValuesCount()

doDeepValidation

public void doDeepValidation()
                      throws ValidationException

Executes the validators and if an error accrues the ValidationException will be thrown.

Throws:

ValidationException

addListener

public void addListener(OnConfigurationChangedListener listener)

addExternalListener

public void addExternalListener(OnConfigurationChangedListener listener)

isActive

public boolean isActive()

getValues

public List<Value> getValues()

isRequired

public boolean isRequired()

getId

public String getId()

isValid

public boolean isValid()

The configuration option is valid if all validators valid and if it is required it also needs a value.

Returns:

hasValue

public boolean hasValue()

getCategory

public Category getCategory()

setCardinality

public void setCardinality(Cardinality cardinality)

getConfigOption

public ConfigOption getConfigOption()

addValidator

public void addValidator(String key,
                         ConfigurationValidator validator)

updateListeners

protected void updateListeners()

updateExternalListeners

protected void updateExternalListeners()

checkDependencies

public void checkDependencies()

If the configuration option has dependencies then this method checks all configuration options on which this configuration option depends and if they are valid then this configuration option will be activated. If not it will be disabled.

getOrder

public int getOrder()

getDescription

public String getDescription()

getLabel

public String getLabel()

compareTo

public int compareTo(ConfigurationOption o)

Specified by:

compareTo in interface Comparable<ConfigurationOption>

removeListener

public void removeListener(OnConfigurationChangedListener listener)

setIsActive

public void setIsActive(boolean active)

removeValidator

public void removeValidator(ConfigurationValidator validator)

updateValidatorAttributesForId

public void updateValidatorAttributesForId(String name,
                                           String[] attributes)

removeExternalListener

public void removeExternalListener(OnConfigurationChangedListener listener)