com.motivewave.platform.sdk.common.desc

Class ValueDescriptor

java.lang.Object

com.motivewave.platform.sdk.common.desc.ValueDescriptor

public class ValueDescriptor
extends java.lang.Object

Identifies and describes values that are generated by a study.

Author:

Tony

Constructor Summary

Constructors

Constructor and Description
ValueDescriptor(java.lang.Object key, Enums.ValueType type, java.lang.String label, java.lang.String[] labelValues) Constructor
ValueDescriptor(java.lang.Object key, java.lang.Object[] choices, java.lang.String label, java.lang.String[] labelValues)
ValueDescriptor(java.lang.Object key, java.lang.String label, java.lang.String[] labelValues) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.Object>	getChoices()
java.lang.Object	getKey()
java.lang.String	getKeyAsString()
java.lang.String	getLabel()
java.lang.String	getLabel(Settings settings)
java.util.List<java.lang.String>	getLabelValues() These values are used to generate the label displayed in the cursor data window.
Enums.ValueType	getType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ValueDescriptor

public ValueDescriptor(java.lang.Object key,
               java.lang.String label,
               java.lang.String[] labelValues)

Constructor

Parameters:

key -

label -

labelValues -

ValueDescriptor

public ValueDescriptor(java.lang.Object key,
               Enums.ValueType type,
               java.lang.String label,
               java.lang.String[] labelValues)

Constructor

Parameters:

key -

type -

label -

labelValues -

ValueDescriptor

public ValueDescriptor(java.lang.Object key,
               java.lang.Object[] choices,
               java.lang.String label,
               java.lang.String[] labelValues)

Method Detail

getKey

public java.lang.Object getKey()

Returns:

the key that may be used to retrieve a value in the data series.

getKeyAsString

public java.lang.String getKeyAsString()

getLabel

public java.lang.String getLabel()

getLabel

public java.lang.String getLabel(Settings settings)

getLabelValues

public java.util.List<java.lang.String> getLabelValues()

These values are used to generate the label displayed in the cursor data window. Each of the strings in this list must map to a valid setting.

getType

public Enums.ValueType getType()

getChoices

public java.util.List<java.lang.Object> getChoices()