uno.informatics.data

Interface Scale

All Superinterfaces:

Entity, SimpleEntity

public interface Scale
extends Entity

Method Summary

Modifier and Type	Method and Description
DataType	getDataType() Gets the data type for this scale.
Number	getMaximumValue() Gets the maximum value in the scale.
Number	getMinimumValue() Gets the minimum value in the scale.
ScaleType	getScaleType() Gets the scale type for this scale.
List<Object>	getValues() Gets all possible values for this scale.
int	indexOf(Object value) Get the index of a value in the list of possible values.
void	setDataType(DataType type)
void	setMaximumValue(Number maximum)
void	setMinimumValue(Number minimum)
void	setScaleType(ScaleType type)
void	setValues(List<? extends Object> values)

Methods inherited from interface uno.informatics.data.Entity

getAbbreviation, getDescription, getType

Methods inherited from interface uno.informatics.data.SimpleEntity

getName, getUniqueIdentifier

Method Detail

getMaximumValue

Number getMaximumValue()

Gets the maximum value in the scale.

Returns:

the maximum value in the scale, or null if the maximum value is not applicable, e.g. for nominal scales

setMaximumValue

void setMaximumValue(Number maximum)

getMinimumValue

Number getMinimumValue()

Gets the minimum value in the scale.

Returns:

the minimum value in the scale, or null if the maximum value is not applicable, e.g. for nominal scales

setMinimumValue

void setMinimumValue(Number minimum)

getValues

List<Object> getValues()

Gets all possible values for this scale. Values can not be repeated. The order of the values is important for ordinal scales.

Returns:

all possible values for this scale, or null the number of possible values is large or infinite, e.g. for ratio and interval scales

setValues

void setValues(List<? extends Object> values)

indexOf

int indexOf(Object value)

Get the index of a value in the list of possible values. Should be faster than calling indexOf on the list of values as returned by getValues(). Especially useful for ordinal scales where the order of values is important.

Parameters:

value - one of the values in the list obtained with getValues()

Returns:

index of the given value, or -1 if an unknown value is given or if the number of possible values is large or infinite, e.g. for ratio and interval scales

getDataType

DataType getDataType()

Gets the data type for this scale.

Returns:

the data type for this scale

setDataType

void setDataType(DataType type)

getScaleType

ScaleType getScaleType()

Gets the scale type for this scale.

Returns:

the scale type for this scale

setScaleType

void setScaleType(ScaleType type)