02 LocationSets

Contents

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.

Any location may appear in more than one location sets. 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).

Figure 24 Elements in the LocationSets configuration

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 and will not influence the location order in, for instance,  the data viewer

sortingLocationAttributeId

You can specify an attribute that should be used for sorting the locations in the user interface. This is useful for list locations in for example a logical river order (upstream to downstream). The attribute should then contain a numbering. Note that the attributes are ordered as strings, so use 00001 instead of 1. Each location can only have 1 attribute which defines the sorting, this will automatically be the first defined in locationSets.xml. Sorting of locations with different sorting attributes will result in grouping locations with the same sorting attribute together.

Some best practices when using the <sortingLocationAttributeId>:

• Give the main locationSet based on the csvFile a sortingLocationAttributeId that makes sense (e.g. Name or logical river order). This will be the first locationSet found by FEWS, and therefore will dictate the sorting order used in the Filter (aka DataViewer, configured in Filters.xml). This is because by default locations sets use the sorting of the parent location set.
• Give all locationSets derived from the main locationSet a sortingOrder to overrule the sorting order defined in the main locationSet (based on the csvFile)
• Create separate locationSets for displaysGroups and Exports when the order in these two is different.

• Don't define numeric attributes as text attributes in your configuration. Don't use leading zeros for numeric attributes in your csv. Leading zeros and/or text attributes will significantly increase the memory usage and start-up time of FEWS.

• (General recommendation) After making these kind of changes to config, if you experience unexpected behaviour in Delft-FEWS after a refresh, restart Delft-FEWS to see if this behaviour is persistent.

Option is available since 2014.01

chainageLocationAttributeId

By configuring <chainageLocationAttributeId> all locations that have a value for this attribute will be contained in this location set. This attribute will automatically be used as sortingLocationAttributeId so the locations are in the order of ascending chainage value. The attribute must be of type numeric.

Referring to the chainage location set can only be done in combination with <readWriteMode>read only</readWriteMode> by configuring <chainageLocationSetId> in <timeSeriesSet>:

{code}
<timeSeriesSet>
        <moduleInstanceId>ExportRunMultipleTimeSeries</moduleInstanceId>
        <valueType>scalar</valueType>
        <parameterId>H.m</parameterId>
        <chainageLocationSetId>CHAINAGE_D</chainageLocationSetId>
        <timeSeriesType>external historical</timeSeriesType>
        <timeStep unit="day"/>
        <relativeViewPeriod unit="day" start="-7" end="0"/>
        <readWriteMode>read only</readWriteMode>
</timeSeriesSet>
{code}

description

Optional description of the location set. Used for reference purposes only.

locationId

Location ID configured to be a member of the locationSet. Multiple entries may exist.

locationSetId

LocationSet ID configured to be a member of the locationSet. Multiple entries may exist. This is useful to group locationSets together.

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.

See all detailed information at the next page

Label

It is possible to define a label that is presented in the map. For more information, see Explorer.