| scrollbar |
|---|
| Table of Contents |
|---|
...
| Section | ||||
|---|---|---|---|---|
| ||||
|
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
|
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
1.00 Version number
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 5 Elements in the Explorer configuration
4.2.1 System Information
This section contains some general information of the DELFT-FEWS configuration.
Figure 6 Elements in the System Information section of the Explorer configuration
description
An optional description of the configuration element. This is for reference purposes only and will not be used elsewhere.
systemCaption
The caption that will appear in the title bar of the FEWS Explorer window.
systemHelpFile
Reference to the file name and location of the help file
4.2.2 Explorer Options
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.
4.2.3 Zoom extents
The zoom extents is used to define the pre-configured zoom levels that can be selected from the main display.
Figure 8 Elements in the Explorer Options section of the Explorer configuration
zoomExtent
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.
left, right, top, bottom
Coordinates of the corners of the zoom extent (specified in the geoDatum selected below)
mnemonic
Optional definition of a letter in the title to use as shortcut.
4.2.4 Explorer Tasks
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.
Figure 9 Elements in the Explorer Tasks section of the Explorer configuration
explorerTask
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
iconFile
Reference to an icon file to be used in the toolbar. If left empty the name will be used to identify the task in the toolbar
Mnemonic
Optional definition of a letter in the title to use as shortcut.
taskExe
Command line for executable to run on initiating the task (the task may be either a call to an executable or to a Java class)
taskClass
Java class to run on initiating the task (the task may be either a call to an executable or to a Java class)
arguments
Optional argument string to be passed to the task
workDir
Optional working directory to start the task in.
Description
Optional description of the task (for reference only)
toolbarTask
Boolean flag to indicate if the task is to appear as a part of the toolbar
menubarTask
Boolean flag to indicate if the task is to appear in the tools menu
allowMultipleInstances
Boolean flag to indicate if multiple instances of task can be initiated concurrently
XXXXXXXXXXXXXXXXXXXXXXXXXX UUUUU
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
dateTimeFormat
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
defaultSelectFilterId
Defines the default filter to be selected on starting the fewsExplorer
geoDatum
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
dateTimeFormat
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)
- multiplier defines the number of units given above in a time step.
- divider same function as the multiplier, but defines fraction of units in time step.
timeZone
Defines the default time zone for the system. The default time zone is used for all times in user displays, unless locally overruled. This includes time series displays and the system time. The time zone used by the system should conform to a time zone that does not consider summer time. If this optional entry is not included then the timeZone is considered to be UTC+0:00 (or GMT). The time zone can be defined in two ways.
timeZoneOffset
The offset of the time zone with reference to UTC (equivalent to GMT). Entries should define the number of hours (or fraction of hours) offset. (e.g. +01:00)
timeZoneName
Enumeration of supported time zones. See appendix B for list of supported time zones.
1.2.7 logPanelConfig
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
clientFilter
Root element of a definition of filters (multiple entries may exist).
clientId
Definition of log filters for Operator client or for Stand alone system (both may be included).
logFilter
Root element for log filter definition
eventType
Filter applicable to System logger or to debug logger. Enumeration of "system"or "event".
Level
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
1.00 Version number
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
description
An optional description of the configuration. This is for reference purposes only and will not be used elsewhere.
1.3.1 General Display 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).
1.3.2 Default view period
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).
- start identifies the start time of the time span with reference to the T0 (in multiples of the unit defined).
- 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
Time series display markers are informative lines in the display. These may be defined to display vertical lines for times values of interest. The configuration of horizontal threshold lines is also included in this definition. Markers can be defined for three time values as well as for the thresholds;
- systemTime
- displayTime
- timeZero
- threshold
Figure 14 Elements in the TimeMarkersDisplay section of the TimeSeriesDisplay configuration
timeMarkerDisplayOptions
Root element of a definition time markers (multiple entries may exist).
Attributes;
- marker enumeration of the possible markers (see list above).
color
Colour of the time series marker line (see enumeration of colours in appendix ??).
lineStyle
Line style of time series marker line. Enumeration of "solid", "none", "bar", "dashdot", "dashed", "dotted".
1.3.4 Parameters display configuration
In this section of the time series display, default attributes of lines plotted for parameters can be allocated. These defaults will be used when plotting lines for these parameters in the time series displays and in the reports. Note that for allocation of the colour only the preferred colour can be identified. When the line is plotted this colour will be used only if there is no other line with the same colour. If this is the case then the next colour in the colour palette will be used.
Figure 15 Elements in the ParameterDisplayConfig section of the TimeSeriesDisplay configuration
PreferredColor
The preferred colour for the line and markers. This colour will only be used if it is not yet available in the current graph. If it is, then the next colour in the template order will be selected.
lineStyle
Line style of time series line. Enumeration of "solid", "none", "bar", "dashdot", "dashed", "dotted".
markerStyle
Marker style for markers plotted on the vertices of the line. Enumeration of "none", "+", "x", "circle", "square", "rectangle", "diamond", "triangleup" , "triangledown".
markerSize
Size of the marker in points
Precision
Decimal precision with which values are given in the table.
min
Minimum of the y-scale to be used as a default for all displays of this parameter. The minimum is used, unless a value in the time series is lower than this minimum, in which case that is used. The minimum defined here can also be overruled in individual template definition in the DisplayGroups (see below).
max
Maximum of the y-scale to be used as a default for all displays of this parameter. This maximum is used, unless a value in the time series is higher than this maximum, in which case that is used. The maximum defined here can also be overruled in individual template definition in the DisplayGroups (see below).
1.3.5 Module instance mapping
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
moduleInstanceMapping
Root element for each mapping to be defined.
Attributes;
- id ModuleInstanceId to be replaced
description
String to replace the module instance id in the legends
1.4 Display Groups
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
1.00 Version number
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
description
A description of the display groups configuration. Used for referencing onlu.
displayGroup
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)
display
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
subplot
Root element for each subplot. Multiple sub-plots may be defined per display.
timeSeriesSet
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
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
...
|