uws.job.parameters

Class DurationParamController

java.lang.Object

uws.job.parameters.NumericParamController

uws.job.parameters.DurationParamController

All Implemented Interfaces:

java.io.Serializable, InputParamController

public class DurationParamController
extends NumericParamController

Let controlling a duration 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.

This controller behaves like a NumericParamController EXCEPT on two points:

• Every given value is casted into a long value. This implies that any Double or Float values will be truncated/rounded.
• It is possible to check a String expressing the duration in a different unit. This string must be prefixed by a unit. See parseDuration(String) (and its reverse operation toString(Long)) for more details.

Since:

4.2

Version:

4.2 (06/2016)

Author:

Grégory Mantelet (ARI)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	MULT_DAYS Multiplication factor between milliseconds and days.
protected static long	MULT_HOURS Multiplication factor between milliseconds and hours.
protected static long	MULT_MIN Multiplication factor between milliseconds and minutes.
protected static long	MULT_MONTHS Multiplication factor between milliseconds and months.
protected static long	MULT_SEC Multiplication factor between milliseconds and seconds.
protected static long	MULT_WEEKS Multiplication factor between milliseconds and weeks.
protected static long	MULT_YEARS Multiplication factor between milliseconds and years.
protected static java.util.regex.Pattern	PATTERN_DURATION Pattern created with the Regular Expression of a valid duration string.
protected static java.lang.String	REGEXP_DAYS Regular Expression of all string allowed to mean DAYS.
protected static java.lang.String	REGEXP_HOURS Regular Expression of all string allowed to mean HOURS.
protected static java.lang.String	REGEXP_MIN Regular Expression of all string allowed to mean MINUTES.
protected static java.lang.String	REGEXP_MONTHS Regular Expression of all string allowed to mean MONTHS.
protected static java.lang.String	REGEXP_MS Regular Expression of all string allowed to mean MILLISECONDS.
protected static java.lang.String	REGEXP_SEC Regular Expression of all string allowed to mean SECONDS.
protected static java.lang.String	REGEXP_WEEKS Regular Expression of all string allowed to mean WEEKS.
protected static java.lang.String	REGEXP_YEARS Regular Expression of all string allowed to mean YEARS.

Fields inherited from class uws.job.parameters.NumericParamController

allowModification, defaultValue, maxValue, minValue

Constructor Summary

Constructors

Constructor and Description
DurationParamController() Create a parameter controller for duration value with no restriction.
DurationParamController(java.lang.Long defaultValue, java.lang.Long minValue, java.lang.Long maxValue, boolean allowModification) Create a controller for a parameter expressing a duration.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	check(java.lang.Object value) Checks the value of the controlled parameter and builds a new object from this value.
long	parseDuration(java.lang.String duration) Parse the given duration string.
void	setDefault(java.lang.Number newDefaultValue) Cast the given value as a long value and call NumericParamController.setDefault(Number).
void	setMaximum(java.lang.Number newMaxValue) Cast the given value as a long value and call NumericParamController.setMaximum(Number).
void	setMinimum(java.lang.Number newMinValue) Cast the given value as a long value and call NumericParamController.setMinimum(Number).
java.lang.String	toString(java.lang.Long duration) Convert a duration value (expressed in milliseconds) into the best human readable unit value.

Methods inherited from class uws.job.parameters.NumericParamController

allowModification, allowModification, getDefault, getMaximum, getMinimum, reset

Methods inherited from class java.lang.Object

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

Field Detail

MULT_SEC

protected static final long MULT_SEC

Multiplication factor between milliseconds and seconds.

A second is here defined as 1000 milliseconds. So the value is computed as follows: 1000.

See Also:

Constant Field Values

MULT_MIN

protected static final long MULT_MIN

Multiplication factor between milliseconds and minutes.

A minute is here defined as 60 seconds. So the value is computed as follows: MULT_SEC*60.

See Also:

Constant Field Values

MULT_HOURS

protected static final long MULT_HOURS

Multiplication factor between milliseconds and hours.

An hour is here defined as 60 minutes. So the value is computed as follows: MULT_MIN*60.

See Also:

Constant Field Values

MULT_DAYS

protected static final long MULT_DAYS

Multiplication factor between milliseconds and days.

A day is here defined as 24 hours. So the value is computed as follows: MULT_HOURS*24.

See Also:

Constant Field Values

MULT_WEEKS

protected static final long MULT_WEEKS

Multiplication factor between milliseconds and weeks.

A week is here defined as 7 days. So the value is computed as follows: MULT_DAYS*7.

See Also:

Constant Field Values

MULT_MONTHS

protected static final long MULT_MONTHS

Multiplication factor between milliseconds and months.

A month is here defined as 30 days. So the value is computed as follows: MULT_DAYS*30.

See Also:

Constant Field Values

MULT_YEARS

protected static final long MULT_YEARS

Multiplication factor between milliseconds and years.

A year is here defined as 365 days. So the value is computed as follows: MULT_DAYS*365.

See Also:

Constant Field Values

REGEXP_MS

protected static java.lang.String REGEXP_MS

Regular Expression of all string allowed to mean MILLISECONDS.

Important: opening and closing brackets are omitted here for a better integration in the duration string's regular expression (see PATTERN_DURATION ).

REGEXP_SEC

protected static java.lang.String REGEXP_SEC

Regular Expression of all string allowed to mean SECONDS.

Important: opening and closing brackets are omitted here for a better integration in the duration string's regular expression (see PATTERN_DURATION ).

REGEXP_MIN

protected static java.lang.String REGEXP_MIN

Regular Expression of all string allowed to mean MINUTES.

Important: opening and closing brackets are omitted here for a better integration in the duration string's regular expression (see PATTERN_DURATION ).

REGEXP_HOURS

protected static java.lang.String REGEXP_HOURS

Regular Expression of all string allowed to mean HOURS.

Important: opening and closing brackets are omitted here for a better integration in the duration string's regular expression (see PATTERN_DURATION ).

REGEXP_DAYS

protected static java.lang.String REGEXP_DAYS

Regular Expression of all string allowed to mean DAYS.

Important: opening and closing brackets are omitted here for a better integration in the duration string's regular expression (see PATTERN_DURATION ).

REGEXP_WEEKS

protected static java.lang.String REGEXP_WEEKS

Regular Expression of all string allowed to mean WEEKS.

Important: opening and closing brackets are omitted here for a better integration in the duration string's regular expression (see PATTERN_DURATION ).

REGEXP_MONTHS

protected static java.lang.String REGEXP_MONTHS

Regular Expression of all string allowed to mean MONTHS.

Important: opening and closing brackets are omitted here for a better integration in the duration string's regular expression (see PATTERN_DURATION ).

REGEXP_YEARS

protected static java.lang.String REGEXP_YEARS

Regular Expression of all string allowed to mean YEARS.

Important: opening and closing brackets are omitted here for a better integration in the duration string's regular expression (see PATTERN_DURATION ).

PATTERN_DURATION

protected static java.util.regex.Pattern PATTERN_DURATION

Pattern created with the Regular Expression of a valid duration string.

Such string MUST be a positive integer/long value eventually suffixed by a unit. Allowed unit strings are the following:

• milliseconds, ms
• seconds, sec, s
• minutes, min, m
• hours, h
• days, D
• weeks, W
• months, M
• years, Y

Important: Units are case sensitive!

Note: Space characters are ignored only if leading or trailing the whole string, or if between the duration and its unit.

Constructor Detail

DurationParamController

public DurationParamController()

Create a parameter controller for duration value 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 NumericParamController.allowModification(boolean).

DurationParamController

public DurationParamController(java.lang.Long defaultValue,
                               java.lang.Long minValue,
                               java.lang.Long maxValue,
                               boolean allowModification)

Create a controller for a parameter expressing a duration. The default and the maximum value are initialized with the given parameters (expressed in milliseconds). 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 NumericParamController.allowModification(boolean).

Important note: Values given in this constructor MUST be expressed in milliseconds.

Parameters:

defaultValue - Value (in ms) set by default to the parameter, when none is specified.

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

maxValue - Maximum value (in ms) 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

setDefault

public void setDefault(java.lang.Number newDefaultValue)

Cast the given value as a long value and call NumericParamController.setDefault(Number).

Overrides:

setDefault in class NumericParamController

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

See Also:

NumericParamController.setMinimum(java.lang.Number)

setMinimum

public void setMinimum(java.lang.Number newMinValue)

Cast the given value as a long value and call NumericParamController.setMinimum(Number).

Overrides:

setMinimum in class NumericParamController

Parameters:

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

See Also:

NumericParamController.setMinimum(java.lang.Number)

setMaximum

public void setMaximum(java.lang.Number newMaxValue)

Cast the given value as a long value and call NumericParamController.setMaximum(Number).

Overrides:

setMaximum in class NumericParamController

Parameters:

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

See Also:

NumericParamController.setMinimum(java.lang.Number)

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

Overrides:

check in class NumericParamController

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.

parseDuration

public long parseDuration(java.lang.String duration)
                   throws java.text.ParseException

Parse the given duration string.

Such string MUST be a positive integer/long value eventually suffixed by a unit. Allowed unit strings are the following:

• milliseconds, ms
• seconds, sec, s
• minutes, min, m
• hours, h
• days, D
• weeks, W
• months, M
• years, Y

Important: Units are case sensitive!

Note: Space characters are ignored only if leading or trailing the whole string, or if between the duration and its unit.

Parameters:

duration - The duration string.

Returns:

The parsed duration converted into milliseconds, or -1 if the given string is null or negative.

Throws:

java.text.ParseException - If the given string is using an unknown unit string, or if the string does not start digits.

See Also:

toString(Long)

toString

public java.lang.String toString(java.lang.Long duration)

Convert a duration value (expressed in milliseconds) into the best human readable unit value.

Parameters:

duration - A duration in milliseconds.

Returns:

An empty string if the given duration is null, or a string expressing the given duration in the best integer value with a unit suffix.

See Also:

parseDuration(String)