public abstract class CommandPromptTool extends Object
Modifier and Type | Field and Description |
---|---|
String[] |
_args |
Hashtable |
arguments |
String |
directory |
ArrayList |
metaVariables |
String |
runtimeDir |
XDATTool |
tool |
URL |
url |
Hashtable |
variables |
Constructor and Description |
---|
CommandPromptTool(String[] args) |
Modifier and Type | Method and Description |
---|---|
void |
_getPossibleVariables() |
void |
_process() |
void |
_service() |
void |
addPossibleVariable(String name,
String description) |
void |
addPossibleVariable(String name,
String description,
ArrayList identifiers) |
void |
addPossibleVariable(String name,
String description,
ArrayList identifiers,
boolean required) |
void |
addPossibleVariable(String name,
String description,
boolean required) |
void |
addPossibleVariable(String name,
String description,
String identifier) |
void |
addPossibleVariable(String name,
String description,
String[] identifiers) |
void |
addPossibleVariable(String name,
String description,
String[] identifiers,
boolean required) |
void |
addPossibleVariable(String name,
String description,
String[] identifiers,
boolean required,
boolean multiples) |
void |
addPossibleVariable(String name,
String description,
String identifier,
boolean required) |
abstract void |
definePossibleVariables()
Add any possible variables using the addPossibleVariable() methods.
|
abstract String |
getAdditionalUsageInfo() |
abstract String |
getDescription() |
String |
getDirectory() |
String |
getHostURL() |
abstract String |
getName() |
String |
getService() |
String |
getServiceURL() |
String |
getSettingsDirectory() |
String |
getSiteURL() |
XDATUser |
getUser() |
String |
getWorkingDirectory() |
abstract void |
process()
This is where your custom code should be placed.
|
boolean |
requireLogin() |
void |
run() |
void |
service() |
void |
showUsage() |
public Hashtable variables
public Hashtable arguments
public String[] _args
public ArrayList metaVariables
public String directory
public String runtimeDir
public XDATTool tool
public URL url
public CommandPromptTool(String[] args)
public String getService()
public String getHostURL()
public String getSiteURL()
public String getServiceURL()
public void run() throws DBPoolException, SQLException, XDATUser.FailedLoginException, Exception
public void _service() throws DBPoolException, SQLException, XDATUser.FailedLoginException, Exception
public void service() throws DBPoolException, SQLException, XDATUser.FailedLoginException, Exception
public void _process() throws DBPoolException, SQLException, XDATUser.FailedLoginException, Exception
public String getDirectory()
public void _getPossibleVariables()
public void showUsage()
public abstract String getName()
public abstract String getDescription()
public abstract String getAdditionalUsageInfo()
public abstract void process()
public void addPossibleVariable(String name, String description, String identifier)
public void addPossibleVariable(String name, String description, ArrayList identifiers)
public void addPossibleVariable(String name, String description, String[] identifiers)
public void addPossibleVariable(String name, String description, boolean required)
public void addPossibleVariable(String name, String description, String identifier, boolean required)
public void addPossibleVariable(String name, String description, ArrayList identifiers, boolean required)
public void addPossibleVariable(String name, String description, String[] identifiers, boolean required)
public void addPossibleVariable(String name, String description, String[] identifiers, boolean required, boolean multiples)
public abstract void definePossibleVariables()
public boolean requireLogin()
public String getWorkingDirectory()
public String getSettingsDirectory()
public XDATUser getUser()
Copyright © 2015 Neuroinformatics Research Group. All rights reserved.