|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.task.LineEnvironment
uk.ac.starlink.ttools.task.LineTableEnvironment
public class LineTableEnvironment
Execution environment suitable for use with the TTOOLS package.
This inherits most of its behaviour from
LineEnvironment
but also impelements
the additional methods of the TableEnvironment
interface.
Field Summary |
---|
Fields inherited from class uk.ac.starlink.task.LineEnvironment |
---|
INDIRECTION_CHAR, NUM_TRIES |
Constructor Summary | |
---|---|
LineTableEnvironment()
|
Method Summary | |
---|---|
JDBCAuthenticator |
getJdbcAuthenticator()
Returns a JDBC authenticator suitable for use in this environment. |
static JDBCAuthenticator |
getJdbcAuthenticator(Environment env)
Returns a suitable JDBC authenticator for a given environment. |
String |
getParamHelp(Parameter param)
Returns the help string for a given parameter. |
static StoragePolicy |
getStoragePolicy(Environment env)
Returns a suitable storage policy for a given environment. |
StarTableFactory |
getTableFactory()
Returns a table factory suitable for use in this environment. |
static StarTableFactory |
getTableFactory(Environment env)
Returns a suitable table factory for a given environment. |
StarTableOutput |
getTableOutput()
Returns a table output marshaller suitable for use in this environment. |
static StarTableOutput |
getTableOutput(Environment env)
Returns a suitable table output marshaller for a given environment. |
boolean |
isDebug()
Indicates whether we are running in debug mode. |
boolean |
isHidden(Parameter param)
Determines whether a parameter is "hidden", that is its value should not be revealed to prying eyes. |
boolean |
isStrictVotable()
Determines whether votables are to be parsed in strict mode. |
static boolean |
isStrictVotable(Environment env)
Determines whether votables are to be parsed in strict mode. |
static String |
normaliseName(String name)
Normalises a given name. |
boolean |
paramNameMatches(String envName,
Parameter param)
Uses normaliseName(java.lang.String) . |
void |
setDebug(boolean debug)
Sets whether we are running in debug mode. |
void |
setStrictVotable(boolean strict)
Sets whether votables should be parsed in strict mode. |
Methods inherited from class uk.ac.starlink.task.LineEnvironment |
---|
acquireValue, checkParameters, clearValue, getAssignments, getErrorStream, getInteractive, getNames, getOutputStream, getPromptAll, getUnused, setErrorStream, setInteractive, setOutputStream, setPromptAll, setWords |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface uk.ac.starlink.task.Environment |
---|
acquireValue, clearValue, getErrorStream, getNames, getOutputStream |
Constructor Detail |
---|
public LineTableEnvironment()
Method Detail |
---|
public boolean isHidden(Parameter param)
LineEnvironment
isHidden
in class LineEnvironment
param
- param
public String getParamHelp(Parameter param)
LineEnvironment
getParamHelp
in class LineEnvironment
param
- parameter
param
public StarTableFactory getTableFactory()
getTableFactory
in interface TableEnvironment
public StarTableOutput getTableOutput()
getTableOutput
in interface TableEnvironment
public JDBCAuthenticator getJdbcAuthenticator()
getJdbcAuthenticator
in interface TableEnvironment
public boolean isDebug()
isDebug
in interface TableEnvironment
public void setDebug(boolean debug)
setDebug
in interface TableEnvironment
debug
- set true if you want debugging messagespublic boolean isStrictVotable()
isStrictVotable
in interface TableEnvironment
public void setStrictVotable(boolean strict)
setStrictVotable
in interface TableEnvironment
strict
- true if VOTables should be interpreted
strictly in accordance with the standardpublic boolean paramNameMatches(String envName, Parameter param)
normaliseName(java.lang.String)
.
paramNameMatches
in class LineEnvironment
envName
- parameter name from environmentparam
- parameter
envName
is considered to name
param
public static String normaliseName(String name)
name
- input name
public static StarTableFactory getTableFactory(Environment env)
env
is a TableEnvironement then env
's
factory is returned, otherwise a default one is returned.
env
- execution environment
public static StarTableOutput getTableOutput(Environment env)
env
is a TableEnvironment then env
's
outputter is returned, otherwise a default one is returned.
env
- execution environment
public static JDBCAuthenticator getJdbcAuthenticator(Environment env)
env
is a TableEnvironment then env
's
authenticator is returned, otherwise a new one is returned.
env
- execution environment
public static StoragePolicy getStoragePolicy(Environment env)
env
- execution environment
public static boolean isStrictVotable(Environment env)
env
- execution environment
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |