uk.ac.starlink.ttools.task
Class ConnectionParameter

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

public class ConnectionParameter
extends uk.ac.starlink.task.Parameter

Parameter for acquiring a connection to a database using JDBC.

Since:
15 Aug 2007
Author:
Mark Taylor

Constructor Summary
ConnectionParameter(String name)
          Constructor.
 
Method Summary
 Connection connectionValue(uk.ac.starlink.task.Environment env)
          Returns the value of this parameter as a connection.
 uk.ac.starlink.task.Parameter[] getAssociatedParameters()
          Returns parameters associated with this.
 void setValueFromConnection(Connection connection)
          Sets the value of this parameter from a Connection object.
 void setValueFromString(uk.ac.starlink.task.Environment env, String stringValue)
           
 
Methods inherited from class uk.ac.starlink.task.Parameter
checkGotValue, clearValue, getDefault, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getUsage, isNullPermitted, setDefault, setDescription, setDescription, setGotValue, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringValue, setUsage, stringValue, 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 uk.ac.starlink.task.Parameter[] getAssociatedParameters()
Returns parameters associated with this.

Returns:
array containing user and password parameters

connectionValue

public Connection connectionValue(uk.ac.starlink.task.Environment env)
                           throws uk.ac.starlink.task.TaskException
Returns the value of this parameter as a connection.

Parameters:
env - execution environment
Returns:
connection
Throws:
uk.ac.starlink.task.TaskException

setValueFromConnection

public void setValueFromConnection(Connection connection)
                            throws SQLException
Sets the value of this parameter from a Connection object.

Parameters:
connection - connection
Throws:
SQLException

setValueFromString

public void setValueFromString(uk.ac.starlink.task.Environment env,
                               String stringValue)
                        throws uk.ac.starlink.task.TaskException
Overrides:
setValueFromString in class uk.ac.starlink.task.Parameter
Throws:
uk.ac.starlink.task.TaskException


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