...
Location sets may be used to define logical groups of locations. Often an action may need to be taken on a whole set of locations (e.g. validation). By creating a LocationSet the action need only be defined once .on a location set and not on individual locations. Any location may appear in more than one location setsset. Internally a location set is simply evaluated as a list of locations.
When available on the file system, the name of the XML file is for example:
LocationSets 1.00 default.xml
LocationSets Fixed file name for the locationSets configuration
1.00 Version number
default Flag to indicate the version is the default configuration (otherwise omitted).
The location set configuration file is included in the RegionConfigFiles\ folder: LocationSets.xml
EsriShapeFile and CSV file
It is possible to define locationSets with locations that are automatically generated (so NOT defined in the locations.xml) from an ESRI Shape (dbf) file or from a CSV table. See all detailed information at the next page
Database Table
It is also possible to define locationSets with locations that are read directly from a database. The contents of the database table are on the fly read and converted to a DBZ file. This DBZ file will be used by FEWS. This is for backup purpose in case the database is not available any more, like in stand-alone test environments. See all detailed information at the next page
LocationSet XML file elements
locationSet
Root element for the definition of a location set. Multiple entries may exist. The Id of the location set must be unique.
Figure 24 Elements in the LocationSets configuration
allowEmptyLocationSets
Optional element available since 2018.01. By default this element is set to true and FEWS will log a debug message when an empty locationSet is created. If set to false, FEWS will log a config error instead. When separate locationSets xml-files are used, each file can have its own <allowEmptyLocationSets> element, which will only apply for the location sets listed in that file.
locationSet
Root element for the definition of a location set. Multiple entries may exist.
Attributes;
- id: Id of the location set. This must be unique
sortByName
Sorts the locations in this set by name. When false the order of the specified location ids or the order in the esri shape file is used. Note that this only applies to the sorting of locations within a locationSets. This will have effect on e.g. sorting of locations in export files, or within a plot. Sorting of locations in filters and displaygroups is configured in their respective configuration files.
...
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?>
<locations xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.wldelft.nl/fews" xsi:schemaLocation="http://www.wldelft.nl/fews http://fews.wldelft.nl/schemas/version1.0/locations.xsd"
xmlns:textAttribute="http://www.wldelft.nl/fews/textAttribute"
xmlns:numberAttribute="http://www.wldelft.nl/fews/numberAttribute"
xmlns:booleanAttribute="http://www.wldelft.nl/fews/booleanAttribute"
version="1.1">
<geoDatum>WGS 1984</geoDatum>
<location id="LocA" name="LocA">
<x>4.5</x>
<y>53.5</y>
<z>0</z>
<textAttribute:AddLabel>This is region Europe</textAttribute:AddLabel>
</location>
<location id="LocB" name="LocB">
<x>4.1</x>
<y>53.1</y>
<z>0</z>
</location>
</locations> |
In this example, both location A and B will appear on the longitudinal plot, but only location A will have a station line drawn (with label text "This is region Europe"). It is also possible to use this option with CSV or esriShape files.
description
Optional description of the location set. Used for reference purposes only.
...
LocationSet ID configured to be a member of the locationSet. Multiple entries may exist. This is useful to group locationSets together.
subLocationSetIdFunction
e.g. Meteo_@catchment@. A an extra sub location set for every catchment.
esriShapeFile and CSV file
It is possible to define locationSets with locations that are automatically generated (so NOT defined in the locations.xml) from an ESRI Shape file or from a CSV table. See all detailed information at the next page
table
It is also possible to define locationSets with locations that are read directly from a database. The contents of the database table are on the fly read and converted to a DBZ file. This DBZ file will be used by FEWS. This is for backup purpose in case the database is not available any more, like in stand-alone test environments.
...
This element can be used to generate multiple locationsets from location attributes; these are normally invluded for locations in dbf or CSV files. In the example below a locationSet is created Warrington_Fluvial_Catchments_PDM from locationSet UK_Fluvial_Catchments_PDM where the location attribute Centre contains Warrington. By using the subLocationSetIdFunction, multiple locationSets are generated as well for all river_segments that can be found in the locationattribute @River_Segment@.
Code Block | ||||
---|---|---|---|---|
| ||||
<locationSet id="Warrington_Fluvial_Catchments_PDM">
<subLocationSetIdFunction>@River_Segment@_Warrington_Model_PDM</subLocationSetIdFunction>
<locationSetId>UK_Fluvial_Catchments_PDM</locationSetId>
<constraints>
<attributeTextContains id="Centre" contains="Warrington"/>
</constraints>
</locationSet> |
With the XML example above, 2 river segment locationSets will be generated: Darwen_Warrington_Model_PDM (with 2 locations) and Dee_ISIS_Warrington_Model_PDM (with 3 locations).
LocationId | Name | River_Segment |
---|---|---|
713119 713120 67008 67015 67021 | Harrison Street PDM Ewood Blackburn PDM Pont Y Capel PDM Manley Hall PDM Lea Hall PDM | Darwen Darwen Dee_ISIS Dee_ISIS Dee_ISIS |
Label
It is possible to define a label that is presented in the map. For more information, see Explorer.