uk.ac.starlink.ttools.task
Class ConnectionParameter

java.lang.Object
  extended by uk.ac.starlink.task.Parameter<Connection>
      extended by uk.ac.starlink.ttools.task.ConnectionParameter

public class ConnectionParameter
extends Parameter<Connection>

Parameter for acquiring a connection to a database using JDBC.

Since:
15 Aug 2007
Author:
Mark Taylor

Field Summary
 
Fields inherited from class uk.ac.starlink.task.Parameter
BY_NAME
 
Constructor Summary
ConnectionParameter(String name)
          Constructor.
 
Method Summary
 Parameter[] getAssociatedParameters()
          Returns parameters associated with this.
 String objectToString(Environment env, Connection connection)
          Takes a typed value of this parameter and formats it as a string which may be used for presentation to the user.
 Connection stringToObject(Environment env, String stringValue)
          Takes a non-blank string, as supplied by the execution environment, and turns it into a typed value for this parameter.
 
Methods inherited from class uk.ac.starlink.task.Parameter
clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getUsage, getValueClass, isNullPermitted, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setUsage, setValue, setValueFromObject, setValueFromString, stringValue, toArray, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ConnectionParameter

public ConnectionParameter(String name)
Constructor.

Parameters:
name - parameter name
Method Detail

getAssociatedParameters

public Parameter[] getAssociatedParameters()
Returns parameters associated with this.

Returns:
array containing user and password parameters

stringToObject

public Connection stringToObject(Environment env,
                                 String stringValue)
                          throws TaskException
Description copied from class: Parameter
Takes a non-blank string, as supplied by the execution environment, and turns it into a typed value for this parameter. This method also performs validation, so if the string value is unacceptable in any way, a ParameterValueException should be thrown.

It is an error to supply a null or empty string value.

If this method fails (throws a ParameterValueException) and if allowClassnameValue is set, then a subsequent attempt will be made to interpret the stringVal as the classname of a suitable class with a no-arg constructor.

Specified by:
stringToObject in class Parameter<Connection>
Parameters:
env - execution environment; in most cases this is not required but for some purposes environment-specific characteristics may influence the result
stringValue - non-null, non-empty string value
Returns:
typed value
Throws:
TaskException

objectToString

public String objectToString(Environment env,
                             Connection connection)
Description copied from class: Parameter
Takes a typed value of this parameter and formats it as a string which may be used for presentation to the user. Ideally, round-tripping between this method and stringToObject should be possible, but that is not in general required/guaranteed.

The default implementation uses the value's toString method, but subclasses can override this for smarter behaviour.

Overrides:
objectToString in class Parameter<Connection>
Parameters:
env - execution environment
connection - typed parameter value
Returns:
string value for presentation


Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.