Analysis Framework Developer's Guide

Analysis Description

The Analysis Description file provides detailed information about the various sections of an Analysis.

`analysis-description`

Attributes

NAME	DEFAULT VALUE	DESCRIPTION
id	(required)	This id MUST match the id given to the Analysis in the `ncsa.analysis.newAnalyses` extension point.

Elements

NAME	REQUIRED	CARDINALITY
<analysis-type>	(required)	1
<custom-script>	(optional)	0-1
<groups>	(required)	1
<parameter>	(optional)	0-many
<output>	(optional)	0-many

Each description MAY define a location for a custom OgreScript to use instead of auto-generating one. The format for this script will be defined on a separate page.

<analysis-description id="ncsa.analysis.maeviz.BridgeFunctionality">
     <custom-script>scripts/ogrescript-bridgeFunc.xml</custom-script>
</analysis-description>

The description MUST have a list of groups to which the parameters can be associated.

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

The description MAY (although not having any <parameters> doesn't make much sense) have a list of parameters.

Attributes

NAME	TYPE	DEFAULT VALUE	DESCRIPTION
group	`java.lang.Object`	(required)	a string which must match a member of `<groups>` above
format	`java.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	`java.lang.String`	(required)	name of property for which value should be added