Versions Compared

Old Version 8

changes.mady.by.user Unknown User (shawn)

Saved on

compared with

New Version 9

changes.mady.by.user Unknown User (shawn)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
     <custom-script>scripts/ogrescript-bridgeFunc.xml</custom-script>

...

<groups>

Groups are used to associate like <parameter> elements together. There are two <group-name> elements which have special meaning to the framework.

  • Required
  • Advanced - Any <parameters> elements which are associated with the Advanced group will not be shown by default.

Attributes

This element has no attributes.

Elements

NAME

REQUIRED

CARDINALITY

DESCRIPTION

<group-name>

(required)

1-many

Group to which the parameters can be associated.

Text

This element has no text.

Example

Code Block
Code Block

<analysis-description id="ncsa.analysis.maeviz.BridgeFunctionality">
    <groups>
        <group-name>Required</group-name>
    </groups>
</analysis-description>

...

<parameter>
Attributes
NAME
TYPE
DEFAULT VALUE
DESCRIPTION
group
java.lang.Object
(required)
a string which must match a member of <groups> above
formatjava.lang.String
(required)
the type of the parameter, currently supports string or dataset
cardinality
java.lang.String
(required)
how many of this type, currently supports single or multiple
key
java.lang.String
(required)
name of property for which value should be added
friendly-name
{(required)
name of property for which value should be added
Elements
NAME
REQUIRED
CARDINALITY
DESCRIPTION
<types>
(optional)
0-many
A list of types that are accepted by this <parameter>.
Text
This element has no text.
Example
 Code Block

<parameter group="Required" format="dataset" cardinality="single" key="functionalityTable" friendly-name="Functionality Table">
    <types>
        <type>bridgeFunctionality</type>
    </types>
</parameter>

<output>
An <output> of type dataset requires two <property> elements.
  • base-dataset-key - The key of the <parameter> which is the base for this new Dataset
  • schema - The id of the schema that this Dataset implements.
Attributes
NAME
DEFAULT VALUE
DESCRIPTION
format
(required)
the type of the parameter, currently supports string or dataset
key
(required)
name of property for which value should be added
friendly-name
{
java.lang.String
(required)
name of property for which value should be added
Elements
NAME
REQUIRED
CARDINALITY
DESCRIPTION
<property>
(optional)
0-many
a ncsa.tools.common.Property object. Additional properties required by the <output>.
Text
This element has no text.
Example
 Code Block

<output friendly-name="Bridge Functionality" key="bridgeFunctionality" format="dataset">
    <property name="base-dataset-key" value="bridgeDamage" /> 
    <property name="schema" value="ncsa.maeviz.schemas.bridgeFunctionalityResults.v1.0" />
</output>