Module descriptors file

This page is the generated field list for ModuleDescriptors.xml — the file that tells FEWS which Java class implements each module type (General Adapter, Import, Export, Transformation, and so on).

At a glance

Purpose : Registers a module type’s id against the class that runs it. A module instance later refers to one of these ids by using the matching root element in its Config/ModuleConfigFiles/ config file (e.g. a file whose root is <generalAdapterRun> is handled by the GeneralAdapter descriptor).

Folder : Config/RegionConfigFiles/

Root element : <moduleDescriptors> (version="1.0", required)

References : Nothing config-side — it points at a Java class on the FEWS classpath.

Note

A standard Delft-FEWS installation ships with ModuleDescriptors.xml already populated for every built-in module. You’ll typically only touch this file when adding a custom plugin module — and even then, copy the entry from a working installation rather than typing the class name from memory; it’s version- and build-specific.

Minimal example

Config/RegionConfigFiles/ModuleDescriptors.xml

<?xml version="1.0" encoding="UTF-8"?>
<moduleDescriptors xmlns="http://www.wldelft.nl/fews" version="1.0">
  <moduleDescriptor id="GeneralAdapter">
    <description>Bridges FEWS to an external model executable</description>
    <className>nl.wldelft.fews.system.plugin.adapter.GeneralAdapterModule</className>
  </moduleDescriptor>
</moduleDescriptors>

Field reference

Auto-generated from moduleDescriptors.xsd. Descriptions are the schema's own annotations.

Element <moduleDescriptors>

Attributes

Attribute	Use	Notes
version	required	fixed: 1.0.

Elements

Element	Type	Cardinality	Description
moduleDescriptor	ModuleDescriptorComplexType	required · repeats

ModuleDescriptorComplexType

Attributes

Attribute	Use	Notes
id	required
name	optional

Elements

Element	Type	Cardinality	Description
description	string	optional
className	string	required

See also

• Reference: Module instance descriptors file
• Task guide: Run a model (General Adapter)
• Schema: moduleDescriptors.xsd