Package com.motivewave.platform.sdk.common.desc

Class ValueDescriptor

java.lang.Object

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

public class ValueDescriptor
extends Object

Identifies and describes values that are generated by a study.

Author:

Tony

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
List<Object>	getChoices()
Object	getKey()
String	getKeyAsString()
String	getLabel()
String	getLabel(Settings settings)
List<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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ValueDescriptor

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

Constructor

Parameters:

key -

label -

labelValues -

ValueDescriptor

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

Constructor

Parameters:

key -

type -

label -

labelValues -

ValueDescriptor

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

Method Details

getKey

public Object getKey()

Returns:

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

getKeyAsString

public String getKeyAsString()

getLabel

public String getLabel()

getLabel

public String getLabel(Settings settings)

getLabelValues

public List<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 List<Object> getChoices()

equals

public boolean equals(Object o)

Overrides:

equals in class Object