rankAlternativesValues

Version

1.1

Provider

RXMCDA

SOAP service’s name

rankAlternativesValues-RXMCDA (see SOAP requests for details)

Description

Calculates the rank of alternatives via their overall values. A parameter named maxMin allows to determine if the best value is the highest or the lowest one (by default, the lowest value is ranked first).

Contact: Patrick Meyer (patrick.meyer@telecom-bretagne.eu)

Inputs

(For outputs, see below)

alternatives

A list of alternatives. Alternatives can be activated or desactivated via the <active> tag (true or false). By default (no <active> tag), alternatives are considered as active.

The input value should be a valid XMCDA document whose main tag is <alternatives>. It must have the following form:

<alternatives>
    <alternative>
        <active>[...]</active>
        [...]
    </alternative>
    [...]
</alternatives>

overallValues

A list of <alternativeValue> in an <alternativesValues> containing the overall value of each alternative. The <value> should be a numeric value.

The input value should be a valid XMCDA document whose main tag is <alternativesValues>.


maxMin (optional)

The parameter which says if the highest or lowest value is to be ranked first.

The input value should be a valid XMCDA document whose main tag is <methodParameters>. It must have the following form:

<methodParameters>
    <parameter
         name="maxMin"> <!-- REQUIRED  -->
        <value>
            <label>%1</label>
        </value>
    </parameter>
</methodParameters>

where:

  • %1 is a parameter named “maxMin”. It can have the following values:

    • min: The lowest value is ranked first

    • max: The highest value is ranked first

    The default value is min.


Outputs

alternativesRanks

A list of <alternativeValue> in an <alternativesValues> containing the rank of each alternative.

The returned value is a XMCDA document whose main tag is <alternativesValues>. It has the following form:

<alternativesValues mcdaConcept="alternativesRanks">
    <alternativeValue>
        [...]
    </alternativeValue>
    [...]
</alternativesValues>

messages

A list of messages generated by the algorithm.

The returned value is a XMCDA document whose main tag is <methodMessages>.


Original xml description