org.jgap.data.config

Interface ConfigurationHandler

All Known Implementing Classes:

RootConfigurationHandler

public interface ConfigurationHandler

The interface for the GUI to retrieve the information about what a Configurable looks like and how it must be rendered.

Since:

2.3

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CVS_REVISION String containing the CVS revision.

Method Summary

Modifier and Type	Method and Description
java.util.List	getConfigProperties() Return the information to generate the GUI for configuring this class.
java.lang.String	getName() Return the name of this Configuration Object to be used in the properties file.
java.lang.String	getNS() Get the namespace to be used in the config file for the Configurable this ConfigurationHandler belongs to.
void	readConfig() Method that will populate a Configurable with the properties in the config file.
void	setConfigurable(Configurable a_configurable) Set the Configurable to which this ConfigurationHandler belongs.

Field Detail

CVS_REVISION

static final java.lang.String CVS_REVISION

String containing the CVS revision. Read out via reflection!

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Return the name of this Configuration Object to be used in the properties file.

Returns:

name of this config Object (name of what you are configuring)

getConfigProperties

java.util.List getConfigProperties()

Return the information to generate the GUI for configuring this class.

Returns:

a list of ConfigProperty objects

readConfig

void readConfig()
         throws ConfigException,
                InvalidConfigurationException

Method that will populate a Configurable with the properties in the config file.

Throws:

ConfigException

InvalidConfigurationException

Since:

2.3

getNS

java.lang.String getNS()

Get the namespace to be used in the config file for the Configurable this ConfigurationHandler belongs to.

Returns:

namepsace of the Configurable

Since:

2.3

setConfigurable

void setConfigurable(Configurable a_configurable)

Set the Configurable to which this ConfigurationHandler belongs.

Parameters:

a_configurable - The Configurable to which this ConfigurationHandler belongs.

Since:

2.3