Package net.sf.basedb.core

Class DoubleParameterType

java.lang.Object

net.sf.basedb.core.ParameterType<Double>

net.sf.basedb.core.DoubleParameterType

public class DoubleParameterType
extends ParameterType<Double>

This class represent a parameter type that is a double. This type defines a lower limit and an upper limit for the range of allowed values.

Version:

2.0

Author:

Nicklas

Last modified

$Date: 2012-09-14 09:28:35 +0200 (fr, 14 sep 2012) $

Field Summary

Fields

Modifier and Type	Field	Description
private Double	lowerLimit	The lower limit of the parameter.
private Double	upperLimit	The upper limit of the parameter.

Constructor Summary

Constructors

Constructor	Description
DoubleParameterType()	Create a new double parameter type, without any limits and allowing null values.
DoubleParameterType(Double lowerLimit, Double upperLimit, Double defaultValue, boolean notNull)	Create a new double parameter type.
DoubleParameterType(Double lowerLimit, Double upperLimit, Double defaultValue, boolean notNull, int multiplicity, int width, int height, List<Double> items)	Create a new double parameter type with a list of allowed values.

Method Summary

Modifier and Type	Method	Description
Double	getLowerLimit()	Get the lowst valid value of the parameter.
Double	getUpperLimit()	Get the highest valid value of the parameter.
(package private) DoubleParameterValueData	newParameterValueData()	Create a new DoubleParameterValueData object.
String	toString()
(package private) void	validateValue(String name, Double value)	Checks if the value is within the range given by the upper and lower limits if those are given.

Methods inherited from class net.sf.basedb.core.ParameterType

getDefaultValue, getEnumeration, getHeight, getItems, getMultiplicity, getNotNull, getParameterClass, getValueType, getWidth, isEnumeration, isMasked, validate, validate

Methods inherited from class java.lang.Object

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

Field Details

lowerLimit

private final Double lowerLimit

The lower limit of the parameter.

upperLimit

private final Double upperLimit

The upper limit of the parameter.

Constructor Details

DoubleParameterType

public DoubleParameterType()

Create a new double parameter type, without any limits and allowing null values.

DoubleParameterType

public DoubleParameterType(Double lowerLimit,
Double upperLimit,
Double defaultValue,
boolean notNull)

Create a new double parameter type.

Parameters:

lowerLimit - The lowest allowed value, or null to have no limit

upperLimit - The highest allowed value, or null to have no limit

defaultValue - Default value for the parameter, or null.

notNull - FALSE if nulls values are allowed, TRUE otherwise

DoubleParameterType

public DoubleParameterType(Double lowerLimit,
Double upperLimit,
Double defaultValue,
boolean notNull,
int multiplicity,
int width,
int height,
List<Double> items)

Create a new double parameter type with a list of allowed values.

Parameters:

lowerLimit - The lowest allowed value, or null to have no limit.

upperLimit - The highest allowed value, or null to have no limit.

defaultValue - The default value of the parameter.

notNull - FALSE if nulls values are allowed, TRUE otherwise

multiplicity - Number of values that can be tied to this parameter, or null to have no limit.

width - Width of the input field for the parameter in the GUI.

height - Heigth of the input field for the parameter in the GUI.

items - List of allowed values..

Method Details

toString

public String toString()

Overrides:

toString in class Object

validateValue

void validateValue(String name,
Double value)
            throws InvalidDataException

Checks if the value is within the range given by the upper and lower limits if those are given.

Specified by:

validateValue in class ParameterType<Double>

Parameters:

value - The value to test

name - The name of the parameter, use the name if there is need to throw an exception

Throws:

InvalidDataException - If the value is outside the range of allowed values

newParameterValueData

DoubleParameterValueData newParameterValueData()

Create a new DoubleParameterValueData object.

Specified by:

newParameterValueData in class ParameterType<Double>

getLowerLimit

public Double getLowerLimit()

Get the lowst valid value of the parameter.

Returns:

Lowst valid value or null if none is set.

getUpperLimit

public Double getUpperLimit()

Get the highest valid value of the parameter.

Returns:

Highest valid value or null if none is set.