Package uk.ac.starlink.ttools.task

Class ConnectionParameter

  • public class ConnectionParameter
extends uk.ac.starlink.task.Parameter<java.sql.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

      Constructors 
      Constructor Description
      ConnectionParameter​(java.lang.String name)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      uk.ac.starlink.task.Parameter<?>[] getAssociatedParameters()
      Returns parameters associated with this.
      java.lang.String objectToString​(uk.ac.starlink.task.Environment env, java.sql.Connection connection)  
      java.sql.Connection stringToObject​(uk.ac.starlink.task.Environment env, java.lang.String stringValue)  

      • 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​(java.lang.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

      • stringToObject

        public java.sql.Connection stringToObject​(uk.ac.starlink.task.Environment env,
                                          java.lang.String stringValue)
                                   throws uk.ac.starlink.task.TaskException
        Specified by:
        stringToObject in class uk.ac.starlink.task.Parameter<java.sql.Connection>
        Throws:
        uk.ac.starlink.task.TaskException

      • objectToString

        public java.lang.String objectToString​(uk.ac.starlink.task.Environment env,
                                       java.sql.Connection connection)
        Overrides:
        objectToString in class uk.ac.starlink.task.Parameter<java.sql.Connection>