01 Locations

What	Locations.xml
Required	yes
Description	Definitions of all locations
schema location	http://fews.wldelft.nl/schemas/version1.0/locations.xsd

DELFT-FEWS is a location oriented system. All time series data must be referenced to a (geographic) location. This location must be identified by its geographic coordinates within the coordinate system used. When available on the file system, the name of the XML file is for example:

Locations 1.00 default.xml

Locations	Fixed file name for the locations configuration
1.00	Version number
default	Flag to indicate the version is the default configuration (otherwise omitted)

Figure 23 Elements in the Locations configuration

timeZone (available since build 25437)

Optional time zone for dates and times defined in the locations configuration file. If no time zone is defined, then dates and times are in GMT.

geoDatum

Definition of the geoDatum used in defining the locations. This may be different than the geoDatum used in the displays. For enumeration of geoDatums, see Appendix B.

location

Root element for the definition of each individual location. Multiple entries may be defined.

Attributes;

id: id of the location. This must be unique
name: name of the location used in displays and reports

description

Optional description of the location. This description will appear as a tool-tip when hovering over the location in the map display.

shortName

Optional short name for the location. This string when available will replace the name in the time series display legend.

label

optional element to customize the location label in the main map display.
You can use the following tags:
%ID%, %NAME%, %DESCRIPTION%, %LAST_VALUE%, %LAST_VALUE_TIME%,
%FORECAST_START_TIME%, %MAXIMUM_VALUE%, %MAXIMUM_VALUE_TIME%, %MINIMUM_VALUE%, %MINIMUM_VALUE_TIME%

An example:

<label>%NAME%  %LAST_VALUE%   %LAST_VALUE_TIME%</label>

or

<label>%NAME%   max:%MAXIMUM_VALUE%  min: %MINIMUM_VALUE% </label>

optional element to customize the tooltip shown when hovering over a location in the main map display.

You can use use \n or CDATA or HTML when you need multiple lines. Beside tags defined in the global.properties file you can use the following tags:

%ID%, %NAME%, %DESCRIPTION%, %LAST_VALUE%, %LAST_VALUE_TIME%,
%FORECAST_START_TIME%, %MAXIMUM_VALUE%, %MAXIMUM_VALUE_TIME%, %MINIMUM_VALUE%, %MINIMUM_VALUE_TIME%

The tooltip supports html including images and hyperlinks. The url in the hyper link can be an internet url, an executable file, a document file, or a folder.Use the CDATA xml tag to include html in a xml file. Check the available HTML functionalities here.

By default (if not defined) the following tool tip is used.

Name: %NAME%\n
Desc: %DESCRIPTION%\n
Last value \[%LAST_VALUE%\] Time \[%LAST_VALUE_TIME%\]\n
Forecast Start Time \[%FORECAST_START_TIME%\]\n
Maximum \[%MAXIMUM_VALUE%\] Time \[%MAXIMUM_VALUE_TIME%\]

A more advanced example is, using HTML (use the <BR> tag to start new line):

<toolTip><![CDATA[<html>
    <table id="details">
      <tr>
	<td width="50" valign="top">ID</td>
	<td width="5" valign="top">:</td>
	<td width="200" valign="top">%ID%</td>
      </tr>
      <tr>
	<td width="50" valign="top">Naam</td>
	<td width="5" valign="top">:</td>
	<td width="200" valign="top">%NAME%</td>
      </tr>
      <tr>
	<td width="50" valign="top">Type</td>
	<td width="5" valign="top">:</td>
	<td width="200" valign="top">%DESCRIPTION%</td>
      </tr>
      <tr>
	<td width="50" valign="top">Foto</td>
	<td width="5" valign="top">:</td>
	<td width="200" valign="top">
	   <a href="file:/$FOTOSDIR$/%ID%.jpg" >
		<img src="file:/$FOTOSDIR$/thumbs/%ID%.jpg" border="0">
	   </a>
	</td>
      </tr>
      <tr>
	<td width="50" valign="top">Documentatie</td>
	<td width="5" valign="top">:</td>
	<td width="200" valign="top">
	   <a href="file:/$PDFDIR$/%ID%.pdf">%ID%.pdf</a>
	</td>
      </tr>
    </table>
</html>
  ]]></toolTip>

parentLocationId

Optional Id of a location that functions as a parent. In the filters child locations (locations that refer to a parent) are normally invisible. However, they are displayed in the graphs whenever a parent is selected.

visibilityPeriod (available since build 25437)

Optional. This is the period for which a location is visible in the user interface. The start and the end of the period are inclusive. If no visibilityPeriod is defined for a location, then the location is visible for all times. Currently the visibility period is used in the map (explorer) window, the time series display and the spatial display.

startDateTime: the date and time of the start of the visibility period. The start of the period is inclusive. If startDateTime is not defined, then the location is visible for all times before endDateTime.
endDateTime: the date and time of the end of the visibility period. The end of the period is inclusive. If endDateTime is not defined, then the location is visible for all times after startDateTime.

Remark: the datetime pattern should be added to the locationSet definition!

x

Geographic coordinate of the location (Easting)

y

Geographic coordinate of the location (Northing)

z

Optional elevation of the location above the global reference.

The elevation defined will be used for converting a parameter supporting local and/or global datum. By convention the data stored in the DELFT-FEWS database is at the local datum. The elevation defined here is added when displaying/converting to a global datum.

The value defined for the elevation should be the gauge zero for river gauges where an exact level is important.

When using transformations and the datum needs to be converted and also a multiplier, divider and/or incrementer are defined in the time series set of the data, then the following equations are used.
When reading data from the database the calculation is:
value = (stored_value + z) * multiplier / divider + incrementer
When writing data to the database the multiplier, divider and incrementer of the time series set are not used, so the calculation is:
stored_value = value - z

All time series data in DELFT-FEWS must be referenced to a location. This is the case for all data types (scalar, longitudinal, grids & polygons).

For Grids and Longitudinal profiles, additional information may be required and defined in the grids and branches configurations respectively. For scalar and polygon time series no additional information is required.

Page tree