org.gvsig.fmap.dal

Interface DataParameterDescriptor

public interface DataParameterDescriptor

This interface describes the properties of a parameter. It is useful for any component that needs to know how to edit or visualize it.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHOICE Accepts a single value from a value set
static int	RANGE Accepts a range of values defined with a minimum and a maximum value
static int	SINGLE Accepts a single value

Method Summary

Methods

Modifier and Type	Method and Description
Object[]	getAvailableValues() Returns an array containing the available values accepted by the parameter.
int	getAvailableValuesType() Returns one of the available values type.
int	getDataType() Returns the parameter's data type.
Object	getDefaultValue() Returns the parameter's default value.
String	getDescription() Returns the parameter's description
Object	getMaxValue() Returns the maximum value when the parameter accepts a range of values.
Object	getMinValue() Returns the minimum value when the parameter accepts a range of values.
String	getName() Returns the parameter's name

Field Detail

SINGLE

static final int SINGLE

Accepts a single value

See Also:

Constant Field Values

CHOICE

static final int CHOICE

Accepts a single value from a value set

See Also:

Constant Field Values

RANGE

static final int RANGE

Accepts a range of values defined with a minimum and a maximum value

See Also:

Constant Field Values

Method Detail

getName

String getName()

Returns the parameter's name

Returns:

String containing the parameter's name

getDescription

String getDescription()

Returns the parameter's description

Returns:

String containing the parameter's description.

getDataType

int getDataType()

Returns the parameter's data type.

Returns:

parameter's data type.

See Also:

DataTypes

getDefaultValue

Object getDefaultValue()

Returns the parameter's default value.

Returns:

an Object containing the default value. Use the data type to cast.

getAvailableValuesType

int getAvailableValuesType()

Returns one of the available values type.

Returns:

an int with one of the available values type.

See Also:

SINGLE, CHOICE, RANGE

getAvailableValues

Object[] getAvailableValues()

Returns an array containing the available values accepted by the parameter.

Returns:

array of Object containing the available values accepted by the parameter. Use the data type to cast.

getMinValue

Object getMinValue()

Returns the minimum value when the parameter accepts a range of values.

Returns:

range's minimum value

getMaxValue

Object getMaxValue()

Returns the maximum value when the parameter accepts a range of values.

Returns:

range's maximum value.