uws.job.parameters

Class StringParamController

java.lang.Object

uws.job.parameters.StringParamController

All Implemented Interfaces:

InputParamController

public class StringParamController
extends java.lang.Object
implements InputParamController

Let controlling a String parameter.

Version:

4.2 (06/2016)

Author:

Grégory Mantelet (CDS;ARI)

Constructor Summary

Constructors

Constructor and Description
StringParamController(java.lang.String paramName) Builds a controller of the specified String parameter.
StringParamController(java.lang.String paramName, java.lang.String defaultValue, java.lang.String[] possibleValues, boolean allowModif) Builds a controller of the specified String parameter and configures it.
StringParamController(java.lang.String paramName, java.lang.String defaultValue, java.lang.String regExp, boolean allowModif) Builds a controller of the specified String parameter and configures it.

Method Summary

Modifier and Type	Method and Description
boolean	allowModification() Tells whether the controlled parameter may be modified after initialization.
void	allowModification(boolean allowModif) Lets telling if the parameter can be modified after it 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.String	getDefaultValue() Gets the default value of the parameter.
protected java.lang.String	getExpectedFormat() Gets a string which lists all the allowed values.
java.lang.String[]	getPossibleValues() Gets the list of all allowed values.
java.lang.String	getRegExp() Gets the Regular Expression that all values of this parameter must match.
void	setDefaultValue(java.lang.String defaultValue) Sets the default value of the parameter.
void	setPossibleValues(java.lang.String[] possibleValues) Sets the list of all allowed values.
void	setRegExp(java.lang.String regExp) Sets the Regular Expression that all values of this parameter must match.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringParamController

public StringParamController(java.lang.String paramName)

Builds a controller of the specified String parameter.

Parameters:

paramName - Name of the controlled parameter.

See Also:

StringParamController(String, String, String[], boolean)

StringParamController

public StringParamController(java.lang.String paramName,
                             java.lang.String defaultValue,
                             java.lang.String[] possibleValues,
                             boolean allowModif)

Builds a controller of the specified String parameter and configures it.

Parameters:

paramName - Name of the controlled parameter.

defaultValue - Default value of this parameter. note: It may be NULL. If the next parameter is not NULL or empty, the default value must be one of its values.

possibleValues - List of all allowed values. note: It may be NULL or empty. In this case, any value is allowed.

allowModif - true to allow the modification of the specified parameter after its initialization, false otherwise.

StringParamController

public StringParamController(java.lang.String paramName,
                             java.lang.String defaultValue,
                             java.lang.String regExp,
                             boolean allowModif)

Builds a controller of the specified String parameter and configures it.

Parameters:

paramName - Name of the controlled parameter.

defaultValue - Default value of this parameter. note: It may be NULL. If the next parameter is not NULL or empty, the default value must be one of its values.

regExp - Regular Expression that any value of this parameter must match. note: It may be NULL or empty. In this case, any value is allowed.

allowModif - true to allow the modification of the specified parameter after its initialization, false otherwise.

Method Detail

getDefaultValue

public final java.lang.String getDefaultValue()

Gets the default value of the parameter.

Returns:

The default value. (MAY BE NULL)

setDefaultValue

public final void setDefaultValue(java.lang.String defaultValue)

Sets the default value of the parameter.

Parameters:

defaultValue - The new default value. (MAY BE NULL)

getRegExp

public final java.lang.String getRegExp()

Gets the Regular Expression that all values of this parameter must match.

Returns:

The current Regular Expression. (MAY BE NULL)

Since:

4.2

setRegExp

public final void setRegExp(java.lang.String regExp)

Sets the Regular Expression that all values of this parameter must match.

Warning: setting a non empty regular expression will set to null any list of allowed values eventually set in this controller.

Parameters:

regExp - The new Regular Expression. note: If NULL or empty, any value is allowed.

Since:

4.2

getPossibleValues

public final java.lang.String[] getPossibleValues()

Gets the list of all allowed values.

Returns:

The allowed values. note: If NULL or empty, any value is allowed.

setPossibleValues

public final void setPossibleValues(java.lang.String[] possibleValues)

Sets the list of all allowed values.

Warning: setting a non empty list of values will set to null any regular expression eventually set in this controller.

Parameters:

possibleValues - The new allowed values. note: If NULL or empty, any value is allowed.

allowModification

public final 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 final void allowModification(boolean allowModif)

Lets telling if the parameter can be modified after it initialization.

Parameters:

allowModif - true to allow its modification after initialization, 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.

getExpectedFormat

protected final java.lang.String getExpectedFormat()

Gets a string which lists all the allowed values.

Returns:

A string which describes the format expected by this controller.

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).