uk.ac.starlink.ttools.task
Class TableFactoryParameter

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

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

Parameter whose value is a StarTableFactory.

Author:
Mark Taylor

Constructor Summary
TableFactoryParameter(String name)
          Constructor.
 
Method Summary
static uk.ac.starlink.table.StarTableFactory createTableFactory(String sval)
          Decodes a string value which represents a particular prescription for resolving table names to table data, returning a functioning StarTableFactory object which embodies this behaviour.
 uk.ac.starlink.table.StarTableFactory factoryValue(uk.ac.starlink.task.Environment env)
          Returns the value of this parameter as a StarTableFactory.
 void setValueFromString(uk.ac.starlink.task.Environment env, String sval)
           
 
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

TableFactoryParameter

public TableFactoryParameter(String name)
Constructor.

Parameters:
name - parameter name
Method Detail

setValueFromString

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

factoryValue

public uk.ac.starlink.table.StarTableFactory factoryValue(uk.ac.starlink.task.Environment env)
                                                   throws uk.ac.starlink.task.TaskException
Returns the value of this parameter as a StarTableFactory.

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

createTableFactory

public static uk.ac.starlink.table.StarTableFactory createTableFactory(String sval)
                                                                throws uk.ac.starlink.task.UsageException
Decodes a string value which represents a particular prescription for resolving table names to table data, returning a functioning StarTableFactory object which embodies this behaviour.

Parameters:
sval - string representation of behaviour
Returns:
table factory
Throws:
uk.ac.starlink.task.UsageException - if the string value cannot be decoded


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