uws.job.parameters

Class NumericParamController

java.lang.Object

uws.job.parameters.NumericParamController

All Implemented Interfaces:

java.io.Serializable, InputParamController

Direct Known Subclasses:

DurationParamController

public class NumericParamController
extends java.lang.Object
implements InputParamController, java.io.Serializable

Let controlling a numeric parameter. Thus it is possible to set a default but also a minimum and a maximum value. Moreover you can indicate whether the value of the parameter can be modified by the user or not after initialization.

Here is the logic applied by this controller for a numeric parameter:

• If no value is specified by the UWS client, the default value is returned. But if no default value is returned, null will then be returned.
• If the given value is smaller than the minimum (if any is set), the minimum value is returned.
• If the given value is bigger than the maximum (if any is set), the maximum value is returned.

This implementation aims to be generic enough to support most of the numeric parameters, but if the logic presented above is not enough or does not fit your needs, you are free to extend it and thus benefit of the implementation of most of the functions and attributes of this controller.

Since:

4.2

Version:

4.2 (06/2016)

Author:

Grégory Mantelet (CDS;ARI)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowModification Indicates whether the parameter can be modified.
protected java.lang.Number	defaultValue The default value.
protected java.lang.Number	maxValue The maximum value.
protected java.lang.Number	minValue The maximum value.

Constructor Summary

Constructors

Constructor and Description
NumericParamController() Create a numeric controller with no restriction.
NumericParamController(java.lang.Number defaultValue, java.lang.Number minValue, java.lang.Number maxValue, boolean allowModification) Create a controller for a numeric parameter.

Method Summary

Modifier and Type	Method and Description
boolean	allowModification() Tells whether the controlled parameter may be modified after initialization.
void	allowModification(boolean allowModification) Lets indicating whether the value of the parameter can be modified after initialization.
java.lang.Object	check(java.lang.Object value) Checks the value of the controlled parameter and builds a new object from this value.
java.lang.Object	getDefault() Returns the default value of the controlled parameter.
java.lang.Number	getMaximum() Gets the maximum value of this parameter.
java.lang.Number	getMinimum() Gets the minimum value of this parameter.
void	reset(java.lang.Number defaultVal, java.lang.Number minVal, java.lang.Number maxVal) Reset all fields in the same time.
void	setDefault(java.lang.Number newDefaultValue) Set the default value that the parameter must have if none is specified by the user.
void	setMaximum(java.lang.Number newMaxValue) Sets the maximum value of this parameter.
void	setMinimum(java.lang.Number newMinValue) Sets the minimum value of this parameter.

Methods inherited from class java.lang.Object

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

Field Detail

minValue

protected java.lang.Number minValue

The maximum value.

defaultValue

protected java.lang.Number defaultValue

The default value. MUST be between minValue and maxValue

maxValue

protected java.lang.Number maxValue

The maximum value.

allowModification

protected boolean allowModification

Indicates whether the parameter can be modified.

Constructor Detail

NumericParamController

public NumericParamController()

Create a numeric controller with no restriction.

A default, minimum and/or maximum value can be set after creation using setDefault(Number), setMinimum(Number) and setMaximum(Number). By default this parameter can always be modified, but it can be forbidden using allowModification(boolean).

NumericParamController

public NumericParamController(java.lang.Number defaultValue,
                              java.lang.Number minValue,
                              java.lang.Number maxValue,
                              boolean allowModification)

Create a controller for a numeric parameter. The default and the maximum value are initialized with the given parameters. The third parameter allows also to forbid the modification of the parameter value by the user, if set to false.

A default and/or maximum value can be modified after creation using setDefault(Number) and setMaximum(Number). The flag telling whether this parameter can be modified by the user can be changed using allowModification(boolean).

Parameters:

defaultValue - Value set by default to the parameter, when none is specified.

minValue - Minimum value that can be set. If a smaller value is provided by the user, an exception will be thrown by check(Object).

maxValue - Maximum value that can be set. If a bigger value is provided by the user, an exception will be thrown by check(Object).

allowModification - true to allow the user to modify this value when creating a job, false otherwise.

Method Detail

getMinimum

public final java.lang.Number getMinimum()

Gets the minimum value of this parameter.

Returns:

The minimum value or null if none has been specified.

setMinimum

public void setMinimum(java.lang.Number newMinValue)

Sets the minimum value of this parameter.

Warning !: If the given value is bigger than the maximum value, the minimum will be set automatically to the maximum value ; the given one will then be ignored.

Warning 2: If the default value is smaller than the new minimum value, the default will be set automatically to the new minimum value.

Parameters:

newMinValue - The new minimum value. null is allowed ; it will remove the constraint on the minimum

getMaximum

public final java.lang.Number getMaximum()

Gets the maximum value of this parameter.

Returns:

The maximum value or null if none has been specified.

setMaximum

public void setMaximum(java.lang.Number newMaxValue)

Sets the maximum value of this parameter.

Warning 1: If the given value is smaller than the minimum value, the maximum will be set automatically to the minimum value ; the given one will then be ignored.

Warning 2: If the default value is bigger than the new maximum value, the default will be set automatically to the new maximum value.

Parameters:

newMaxValue - The new maximum value. null is allowed ; it will remove the constraint on the maximum

getDefault

public java.lang.Object getDefault()

Description copied from interface: InputParamController

Returns the default value of the controlled parameter.

Specified by:

getDefault in interface InputParamController

Returns:

Default value (null is allowed).

setDefault

public void setDefault(java.lang.Number newDefaultValue)

Set the default value that the parameter must have if none is specified by the user.

Warning: If the given value is not between the minimum and the maximum of this controller, the default value will be automatically set to the minimum value.

Parameters:

newDefaultValue - The new default value for this controller. null allowed ; null will then be returned if a given parameter is not set by the user

reset

public void reset(java.lang.Number defaultVal,
                  java.lang.Number minVal,
                  java.lang.Number maxVal)

Reset all fields in the same time.

Parameters:

defaultVal - Value set by default to the parameter, when none is specified.

minVal - Minimum value that can be set. If a smaller value is provided by the user, an exception will be thrown by check(Object).

maxVal - Maximum value that can be set. If a bigger value is provided by the user, an exception will be thrown by check(Object).

allowModification

public boolean allowModification()

Description copied from interface: InputParamController

Tells whether the controlled parameter may be modified after initialization.

Specified by:

allowModification in interface InputParamController

Returns:

true to allow the modification, false otherwise.

allowModification

public void allowModification(boolean allowModification)

Lets indicating whether the value of the parameter can be modified after initialization.

Parameters:

allowModification - true if the parameter value can be modified, false otherwise.

check

public java.lang.Object check(java.lang.Object value)
                       throws UWSException

Description copied from interface: InputParamController

Checks the value of the controlled parameter and builds a new object from this value.

Specified by:

check in interface InputParamController

Parameters:

value - Parameter value to check.

Returns:

The same value or a new object built from the given value.

Throws:

UWSException - If the given value is strongly incorrect.