You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 20 Next »

This document is a guide to the various types of parameter widgets available, and the syntax for creating them.

String types

Parameters that have a string value should be of the phylum string

Freeform strings

Freeform strings do not need to specify any other specific format or type information.

<parameter phylum="string" cardinality="single" key="result"
              friendly-name="Result Name" />

String selection

To select a particular string from a list, the format should be specified as select, and a set of values should be included.

<parameter phylum="string" format="select"
              cardinality="single" key="test" friendly-name="Test" >
      <values>
         <value>choice1</value>
         <value>choice2</value>
         <value>choice3</value>
      </values>
</parameter>

Extension point string selection

To select an extension point to be returned as a string (selected by name, value returned by tag), use format extension-point, and an extension element must be specified:

<parameter phylum="string" format="extension-point" cardinality="single" key="extpt" friendly-name="Ext pt">
	<extension point="ncsa.gis.ui.initFileActions"/>
</parameter>

Multiple String selection

String lists can be defined using cardinality="multiple"
Choices can be set in the same method as string selection.

<parameter group="Required" phylum="string" format="select" cardinality="multiple" key="list" friendly-name="Field Select">
    <dependent-param>bridgeDamage</dependent-param>
    <values source="parameter" sourcekey="bridgeDamage" sourcetype="fields"/>
</parameter>

String maps

Any sort of data that, at it's lowest level, is a map of Strings to Strings should use the stringmap phylum.

Keys based on a separate dataset parameter

To create a string map widget that has keys based off of certain records or fields from a separate dataset parameter, use format parameter-keys.

Also, the dependent-param element must be specified to indicate a field that this field is dependent on.

Keys based on fields of a dataset, values one of a set of hardcoded choices.

<parameter  phylum="dataset" format="shapefile"
             cardinality="single" key="bridges" friendly-name="Bridges">

<parameter phylum="stringmap" format="parameter-keys" cardinality="single" key="map" friendly-name="Agg Type">
   <dependant-param>bridges</dependant-param>
   <keys source="parameter" sourcekey="bridges" sourcetype="fields"/>
   <values source="values">
      <value default="true">min</value>
      <value>max</value>
      <value>sum</value>
   </values>
</parameter>

Boolean values

All boolean values should be specific by phylum boolean.

Checkboxes

Checkboxes are the default widget for boolean values.

<parameter phylum="boolean" cardinality="single" key="choice"
              friendly-name="Check Me"   />

Dataset values

Parameters should use the phylum dataset for dataset values.

Specified by schema type

To select a dataset specified by one or more schema type, you can omit a format,
and just specify the types desired.

<parameter  phylum="dataset"
             cardinality="single" key="bridges" friendly-name="Bridges">
      <types>
         <type>bridge</type>
      </types>
   </parameter>

By format of dataset (feature dataset, fragility dataset, etc)

In this case, types should be omitted, and the format should be specified.
The format should match the string returned by getDatasetFormat() in the various dataset types.

Important note: Feature datasets use the key shapefile, whether or not they are backed by a shapefile.

<parameter phylum="dataset" format="mapping"
             cardinality="single" key="mapping" friendly-name="Fragility Mapping">
   </parameter>

By feature dataset's geometry type

In this case, types should be omitted, and the format should be specified as shapefile.
Instead of types, geometry-types should be specified.

<parameter  phylum="dataset" format="shapefile"
             cardinality="single" key="polygon" friendly-name="Polygon ">
   <geometry-types>
      <geometry-type>Polygon</geometry-type>
   </geometry-types>
</parameter>

Multiple datasets

Any of these dataset types can be set to use multiple datasets by setting cardinality to multiple.

<parameter cardinality="multiple"
              phylum="dataset" key="hazard" friendly-name="Hazard">
   <types>
      <type>hazardRaster</type>
      <type>deterministicHazardRaster</type>
   </types>
</parameter>
  • No labels