4.1 Introduction
The system configuration items form a primary part of the configuration of DELFT-FEWS as a system. It includes definition of the functional elements DELFT-FEWS has available (both GUI plug-ins and Module plug-ins). The layout of the main GUI (the FEWS Explorer) and the Time Series display are also defined.
The system configuration items include;
- Explorer configuration of the FEWS Explorer (the main GUI)
- ModuleDescriptors Configurations of the plug-in modules available to DELFT-FEWS
- DisplayDescriptors Configuration of the plug-in displays available to DELFT-FEWS
- DisplayInstanceDescriptors Definition of the plug-in displays used.
- TimeSeriesDisplayConfig Configuration of the time series display.
- DisplayGroups Configuration of the shortcuts to display templates available in the time series display.
- LocationIcons Definition of the icons used in the FEWS Explorer layout for locations.
For each of the configuration items listed above only one configuration is active (or default) at any one time. Each item is defined in an XML file with a unique name.
Many of the configuration items required will include references to strings. To avoid duplication, a tag can be defined in the global.properties file in the root configuration and the tag name used in the XML file.
To use a tag, add this in the global.properties file.
To reference a tag include the sting $TAG_NAME$, where TAG_NAME is the tag to be used.
1.5 Location Icons
Configuration of location icons can be used to help identify the different types of locations on the map display. This is an optional configuration item. If it is not available then the default location icon will be used to all locations. When available on the file system, the name of the XML file is for example:
LocationIcons 1.00 default.xml
LocationIcons Fixed file name for the location icon configuration
1.00 Version number
default Flag to indicate the version is the default configuration (otherwise omitted).
Figure 20 Elements in the LocationIcons configuration
rootDir
This is the directory where the icons referred to are stored. By convention this directory is the <REGION>\Icons directory. The directory can be given relative to the <REGION> directory. If the convention is followed then only "Icons" needs to be entered.
locationIcon
Root element of a location icon definition. Multiple entries may be defined.
description
Description of the group of locations for which an icon is defined (for reference in the configuration only).
iconID
ID of the icon to be used in the display for this group of locations. This id is the same as the name of the icon file, without the ".gif" file extension.
locationId/locationSetId
The locationId is a reference to the location for which icon is used. Either one or more locationId's may be defined, or a single locationSetId.
1.6 Module Descriptors
The module descriptors is used to register module plug-ins that can be used in workflows. The module descriptors define the name of the module and the associated Java class to call. This class must implement the module plug-in interface for it to work within DELFT-FEWS. All modules that are included in the distribution of DELFT-FEWS are registered in the Module Descriptors. When available on the file system, the name of the XML file is for example:
ModuleDescrtiptors 1.00 default.xml
ModuleDescrtiptors Fixed file name for the module descriptors configuration
1.00 Version number
default Flag to indicate the version is the default configuration (otherwise omitted).
Figure 21 Elements in the ModuleDescriptors configuration
moduleDescriptor
Root element of the module descriptor configuration. One entry is required for each module defined.
Attributes;
- Id: Id or Name of the module
description
Optional description of the module. This is used for reference only.
className
Java class called when running the module as referenced by its Id. NOTE; this class must implement the DELFT-FEWS module plug-in interface.
1.7 Display Descriptors
The display descriptors is used to register display plug-ins that can be called from the DELFT-FEWS GUI. The display descriptors define the name of the display and the associated Java class to call. This class must implement the display plug-in interface for it to work within DELFT-FEWS. All displays that are included in the distribution of DELFT-FEWS are registered in the Display Descriptors. When available on the file system, the name of the XML file is for example:
DisplayDescriptors 1.00 default.xml
DisplayDescriptors Fixed file name for the display descriptors configuration
1.00 Version number
default Flag to indicate the version is the default configuration (otherwise omitted).
Figure 22 Elements in the DisplayDescriptors configuration
displayDescriptor
Root element of the display descriptor configuration. One entry is required for each display defined.
Attributes;
- Id: Id or Name of the display
description
Optional description of the display. This is used for reference only.
className
Java class called when running the display as referenced by its Id. NOTE; this class must implement the DELFT-FEWS display plug-in interface.
