...
| Table of Contents |
|---|
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.
| Info |
|---|
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. |
4.2 FEWS
...
Explorer
The layout of the FEWS Explorer is configured in an XML file in the SystemConfigurations section. When available on the file system, the name of the XML file is for example:
Explorer 1.00 default.xml
Explorer Fixed file name for the explorer settings
...
default Flag to indicate the version is the default configuration (otherwise omitted).
Figure5 shows the main elements of the Explorer configuration, These are divided into a number of sections, each of which will be discussed individually (these are indicated with a + sign).
description
An optional description of the configuration. This is for reference purposes only and will not be used elsewhere.
...
Figure 7 Elements in the Explorer Options section of the Explorer configuration
The explorer options define whether a number of items are visible on the main display when started. Each of these may either have the value "true" or "false". The items listed in Figure 7 lists all the items. The names are self-explanatory.
1.2.3 Zoom extents
The zoom extents is used to define the pre-configured zoom levels that can be selected from the main display.
Figure8 Elements in the Explorer Options section of the Explorer configuration
...
Main element of each zoomExtent defined. Note that multiple zoom extents may exist, with the elements below to be defined for each.
Attributes:
- title name of the zoom extent in the list of extents.
...
The explorer tasks define the tasks that can be carried out from the explorer. These tasks are for example the initiation of plug-ins such as the time series display.
NOTE: These settings should be amended only by expert users.
Figure9 Elements in the Explorer Tasks section of the Explorer configuration
...
Main element of each explorer Task. Note that multiple tasks may exist, with the elements below to be defined for each.
Attributes;
- name name of the task
...
Boolean flag to indicate if multiple instances of task can be initiated concurrently
1.2.5 statusBar
The status Bar settings define the format of the time string displayed in the status bar
Figure10 Elements in the Status bar section of the Explorer configuration
...
String defining the time format for time displayed in the status bar. For example HH:mm:ss will display time as 10:43:26.
1.2.6 restSettings
This section includes additional settings for the FEWS Explorer.
Figure11 Elements in the Rest Settings section of the Explorer configuration
...
Default definition of the geographic datum. This is an enumeration of geographic datums supported. As further geographic datums are supported, the list will be expanded;
For the enumeration of geoDatums suppoted, see Appendix B
...
Format definition for time strings in displays (e.g. yyyy-MM-dd HH:mm:ss is resolved to 2004-07-03 10:43:26)
cardinalTimeStep
Default cardinal time step for the system. The system time will be rounded down to the actual time to the closest cardinal time step.
Attributes;
- unit (enumeration of: second, minute, hour, day, week)
...
Configuration of the log panel at bottom of the main display. This can be configured to show all messages (DEBUG level and up), or filtered from a defined level. Two types of log message can be displayed; those generated by the DEBUG logger and those by the EVENT logger. In normal use the latter is defined to show messages from a level of INFO or above. The former is not normally used except for configuration in the stand alone when additional information may be useful. Different settings are available for stand alone clients and for operator clients
Figure12 Elements in the Log Panel section of the Explorer configuration
...
Level of log message below which messages are not displayed. Enumeration of DEBUG, INFO, WARN, ERROR, FATAL ERROR
1.3 Time Series Display Configuration
The layout of the time series display is configured in an XML file in the SystemConfigurations section. When available on the file system, the name of the XML file is for example:
TimeSeriesDisplayConfig 1.00 default.xml
TimeSeriesDisplayConfig Fixed file name for the explorer settings
...
default Flag to indicate the version is the default configuration (otherwise omitted).
Figure5 shows the main elements of the TimeSeriesDisplay configuration, These are divided into a number of sections, each of which will be discussed individually (these are indicated with a + sign).
Figure13 Elements in the TimeSeriesDisplay configuration
...
This includes global setting for the time series display. Currently only one setting is available.
convertDatum
This optional Boolean setting can be used to start the time series display showing levels against the global reference level. The default is that levels are displayed against the local reference level. The difference between local and global reference is defined in the locations definition (see regional settings).
...
The default view period can be used to define the time span of data displayed in the time series display (unless overruled by the user).
Parameters
- unit identifies the time unit with which the time span is defined (enumeration of second, minute, hour, day, week).
...
- end identifies the start time of the time span with reference to the T0 (in multiples of the unit defined).
1.3.3 Time Markers Display Configuration
...
- timeZero
- threshold
Figure 14 Elements in the TimeMarkersDisplay section of the TimeSeriesDisplay configuration
...
Root element of a definition time markers (multiple entries may exist).
Attributes;
- marker enumeration of the possible markers (see list above).
...
The module instance mapping allows user defined strings to be defined which will display the moduleInstanceID in the legends of the time series display. This can help shorten legends, or add additional information.
Figure 16 Elements in the Log Panel section of the Explorer configuration
...
Root element for each mapping to be defined.
Attributes;
- id ModuleInstanceId to be replaced
...
A list of pre-configured displays can be configured in the Display groups. When available on the file system, the name of the XML file is for example:
DisplayGroups 1.00 default.xml
DisplayGroups Fixed file name for the explorer settings
...
default Flag to indicate the version is the default configuration (otherwise omitted).
The pre-configured displays are organised in a tree view in the time series display (see example in Figure 17). Each pre-configured display is identified by its name, and may include one or more subplots, each with one or more time series lines.
Figure 17 Example of time series display, showing two sub-plots and tree-view of pre-configured displays
Figure18 Root element of the display groups definition
...
Root element for each displayGroup. A display group forms one of the main nodes in the tree view and may contain multiple displays. Multiple display groups may be defined.
Attributes;
- name: name of the display group (used in the tree view)
...
Definition of a pre-configured display. Each display may contain multiple sub-plots. Multiple displays may be defined per display group.
Attributes;
- name: name of the display (used in the tree view)
Figure 19 Elements in the Display section of the DisplayGroups configuration
...
Definition of the time series set to be displayed. See section 3.3 for a description of the time series set definition.
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
...
default Flag to indicate the version is the default configuration (otherwise omitted).
Figure 20 Elements in the LocationIcons configuration
...
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
...
Root element of the module descriptor configuration. One entry is required for each module defined.
Attributes;
- Id: Id or Name of the module
...
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
...
Root element of the display descriptor configuration. One entry is required for each display defined.
Attributes;
- Id: Id or Name of the display
...
Java class called when running the display as referenced by its Id. NOTE; this class must implement the DELFT-FEWS display plug-in interface.