MapEnvironment (Starlink-UK API)

java.lang.Object
- uk.ac.starlink.ttools.task.MapEnvironment

All Implemented Interfaces:

Environment, TableEnvironment
```
public class MapEnvironment
extends Object
implements TableEnvironment
```
Environment which allows use of ttools tasks from an in-memory context. Input StarTables can be set as values of parameters and output ones can be extracted.

Author:

Mark Taylor

Constructor Summary

Constructors
Constructor and Description
`MapEnvironment()` Constructs a new environment with no values.
`MapEnvironment(Map<String,Object> map)` Constructs a new environment with a map of parameter name->value pairs.
`MapEnvironment(MapEnvironment env)` Clone constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acquireValue(Parameter<?> param)` Obtains a legal value for a given parameter from the environment and sets the parameter's value accordingly.
`void`	`clearValue(Parameter<?> param)` Clears a value for a given parameter.
`String[]`	`getErrorLines()` Returns the error output written by the task so far, in an array one line per element.
`PrintStream`	`getErrorStream()` Returns an output stream into which error or logging output from a task can be written.
`String`	`getErrorText()` Returns a string which contains all the error output written by the task so far.
`JDBCAuthenticator`	`getJdbcAuthenticator()` Returns a JDBC authenticator suitable for use in this environment.
`Map<String,Object>`	`getMap()` Returns the map object that contains the data for this environment.
`String[]`	`getNames()` Returns an array of parameter names which have been specified.
`String[]`	`getOutputLines()` Returns the output written by the task so far, in an array one line per element.
`PrintStream`	`getOutputStream()` Returns an output stream into which text output from a task can be written.
`StarTable`	`getOutputTable(String paramName)` If the task which has been executed in this environment has created an output table which has not been otherwise disposed of, you can get it from here.
`String`	`getOutputText()` Returns a string which contains all the output written by the task so far.
`StarTableFactory`	`getTableFactory()` Returns a table factory suitable for use in this environment.
`StarTableOutput`	`getTableOutput()` Returns a table output marshaller suitable for use in this environment.
`String[]`	`getUnused()` Returns an array containing any words of the input argument list which were never queried by the application to find their value.
`boolean`	`isDebug()` Indicates whether we are running in debug mode.
`boolean`	`isStrictVotable()` Determines whether votables are to be parsed in strict mode.
`void`	`setDebug(boolean debug)` Sets whether we are running in debug mode.
`MapEnvironment`	`setResourceBase(Class<?> clazz)` Sets the class which defines the context for resource discovery.
`void`	`setStrictVotable(boolean strict)` Sets whether votables should be parsed in strict mode.
`MapEnvironment`	`setValue(String paramName, Object value)` Sets the value of a parameter.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MapEnvironment
```
public MapEnvironment()
```
    Constructs a new environment with no values.
  - MapEnvironment
```
public MapEnvironment(Map<String,Object> map)
```
    Constructs a new environment with a map of parameter name->value pairs.
    
    Parameters:
    
    map - parameter map
  - MapEnvironment
```
public MapEnvironment(MapEnvironment env)
```
    Clone constructor.
    
    Parameters:
    
    env - environment to copy
- Method Detail
  - getOutputStream
```
public PrintStream getOutputStream()
```
    Description copied from interface: Environment
    
    Returns an output stream into which text output from a task can be written. This would correspond to standard output for a terminal-based application.
    
    Specified by:
    
    getOutputStream in interface Environment
    
    Returns:
    
    a stream for text output
  - getErrorStream
```
public PrintStream getErrorStream()
```
    Description copied from interface: Environment
    
    Returns an output stream into which error or logging output from a task can be written. This would correspodnd to standard error for a terminal-based application.
    
    Specified by:
    
    getErrorStream in interface Environment
    
    Returns:
    
    a stream for error output
  - clearValue
```
public void clearValue(Parameter<?> param)
```
    Description copied from interface: Environment
    
    Clears a value for a given parameter.
    
    Specified by:
    
    clearValue in interface Environment
    
    Parameters:
    
    param - the Parameter whose value is to be cleared
  - getNames
```
public String[] getNames()
```
    Description copied from interface: Environment
    
    Returns an array of parameter names which have been specified. The result is not necessarily an exhaustive list of all parameters whose values can be retrieved from this environment, since an interactive environment may be able to prompt the user for values, but it can give a list of values provided explicitly or without interactive prompts.
    
    Specified by:
    
    getNames in interface Environment
    
    Returns:
    
    array of names of known supplied parameters
  - getMap
```
public Map<String,Object> getMap()
```
    Returns the map object that contains the data for this environment. Modify it at your own risk.
    
    Returns:
    
    content map
  - getOutputText
```
public String getOutputText()
```
    Returns a string which contains all the output written by the task so far.
    
    Returns:
    
    output text
  - getOutputLines
```
public String[] getOutputLines()
```
    Returns the output written by the task so far, in an array one line per element.
    
    Returns:
    
    output text
  - getErrorText
```
public String getErrorText()
```
    Returns a string which contains all the error output written by the task so far.
    
    Returns:
    
    error text
  - getErrorLines
```
public String[] getErrorLines()
```
    Returns the error output written by the task so far, in an array one line per element.
    
    Returns:
    
    error text
  - setValue
```
public MapEnvironment setValue(String paramName,
                               Object value)
```
    Sets the value of a parameter. A string value is OK; in some cases other parameter types are catered for. For convenience, this method returns this object (cf. StringBuffer).
    
    Parameters:
    
    paramName - name
    
    value - string or other value
    
    Returns:
    
    this
  - setResourceBase
```
public MapEnvironment setResourceBase(Class<?> clazz)
```
    Sets the class which defines the context for resource discovery.
    
    Parameters:
    
    clazz - resource base class
    
    Returns:
    
    this
    
    See Also:
    
    Class.getResource(java.lang.String)
  - getOutputTable
```
public StarTable getOutputTable(String paramName)
```
    If the task which has been executed in this environment has created an output table which has not been otherwise disposed of, you can get it from here.
    
    Parameters:
    
    paramName - name of a TableConsumerParameter
    
    Returns:
    
    output table stored under name
  - acquireValue
```
public void acquireValue(Parameter<?> param)
                  throws TaskException
```
    Description copied from interface: Environment
    
    Obtains a legal value for a given parameter from the environment and sets the parameter's value accordingly.
    This environment should obtain a value for the parameter par in whatever way it sees fit, and must then call par's Parameter.setValueFromString(uk.ac.starlink.task.Environment, java.lang.String) method so that the parameter knows what its new value is. If the setValueFromString call throws a ParameterValueException the environment may try to get another value (for instance by re-prompting the user) or may give up and re-throw the exception.
    
    Specified by:
    
    acquireValue in interface Environment
    
    Parameters:
    
    param - the Parameter whose value is to be obtained and set
    
    Throws:
    
    TaskException
  - getTableFactory
```
public StarTableFactory getTableFactory()
```
    Description copied from interface: TableEnvironment
    
    Returns a table factory suitable for use in this environment.
    
    Specified by:
    
    getTableFactory in interface TableEnvironment
    
    Returns:
    
    table factory
  - getTableOutput
```
public StarTableOutput getTableOutput()
```
    Description copied from interface: TableEnvironment
    
    Returns a table output marshaller suitable for use in this environment.
    
    Specified by:
    
    getTableOutput in interface TableEnvironment
    
    Returns:
    
    table output
  - getJdbcAuthenticator
```
public JDBCAuthenticator getJdbcAuthenticator()
```
    Description copied from interface: TableEnvironment
    
    Returns a JDBC authenticator suitable for use in this environment.
    
    Specified by:
    
    getJdbcAuthenticator in interface TableEnvironment
    
    Returns:
    
    JDBC authenticator
  - isDebug
```
public boolean isDebug()
```
    Description copied from interface: TableEnvironment
    
    Indicates whether we are running in debug mode.
    
    Specified by:
    
    isDebug in interface TableEnvironment
    
    Returns:
    
    true iff debugging output is required
  - setDebug
```
public void setDebug(boolean debug)
```
    Description copied from interface: TableEnvironment
    
    Sets whether we are running in debug mode.
    
    Specified by:
    
    setDebug in interface TableEnvironment
    
    Parameters:
    
    debug - set true if you want debugging messages
  - isStrictVotable
```
public boolean isStrictVotable()
```
    Description copied from interface: TableEnvironment
    
    Determines whether votables are to be parsed in strict mode.
    
    Specified by:
    
    isStrictVotable in interface TableEnvironment
    
    Returns:
    
    true if VOTables will be interpreted strictly in accordance with the standard
  - setStrictVotable
```
public void setStrictVotable(boolean strict)
```
    Description copied from interface: TableEnvironment
    
    Sets whether votables should be parsed in strict mode.
    
    Specified by:
    
    setStrictVotable in interface TableEnvironment
    
    Parameters:
    
    strict - true if VOTables should be interpreted strictly in accordance with the standard
  - getUnused
```
public String[] getUnused()
```
    Returns an array containing any words of the input argument list which were never queried by the application to find their value. Such unused words probably merit a warning, since they may for instance be misspelled versions of real parameters.
    
    Returns:
    
    array of unused words

Class MapEnvironment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MapEnvironment

MapEnvironment

MapEnvironment

Method Detail

getOutputStream

getErrorStream

clearValue

getNames

getMap

getOutputText

getOutputLines

getErrorText

getErrorLines

setValue

setResourceBase

getOutputTable

acquireValue

getTableFactory

getTableOutput

getJdbcAuthenticator

isDebug

setDebug

isStrictVotable

setStrictVotable

getUnused