Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

alma::acs::commandcenter::engine::ToolManager Class Reference

List of all members.

Static Public Member Functions

void readExtraTools (Reader f) throws Exception
AcsCommandCenterTools getExtraTools () throws Exception
String getDefaultExtraToolsName ()
void readDefaultExtraTools () throws Exception
void readBuiltinTools (Reader f) throws Exception
Tool getBuiltinTool (String caption) throws IllegalArgumentException, Exception
String getDefaultBuiltinToolsName ()
void readDefaultBuiltinTools () throws Exception
String generateCommand (Tool tool, RunModel runModel) throws Exception
String generateCommand (Tool tool, RunModel runModel, Map< String, Object > input) throws Exception

Static Protected Member Functions

String[] collectInsertions (Tool tool, RunModel runModel, Map< String, Object > input) throws Exception
String readFromModel (RunModel runModel, String name, String fallback) throws Exception
String readFromInput (Map< String, Object > input, String name, String fallback)

Static Protected Attributes

AcsCommandCenterTools extraTools
HashMap< String, Tool > builtinTools

Static Package Functions

 [static initializer]

Static Private Attributes

Logger log = MiscUtils.getPackageLogger(ToolManager.class)
HashMap< String, Object > emptyMap = new HashMap<StringObject>()

Detailed Description

Author:
mschilli


Member Function Documentation

alma::acs::commandcenter::engine::ToolManager::[static initializer]  )  [inline, static, package]
 

Initializes the builtinTools map with hardcoded definitions

String [] alma::acs::commandcenter::engine::ToolManager::collectInsertions Tool  tool,
RunModel  runModel,
Map< String, Object >  input
throws Exception [inline, static, protected]
 

String alma::acs::commandcenter::engine::ToolManager::generateCommand Tool  tool,
RunModel  runModel,
Map< String, Object >  input
throws Exception [inline, static]
 

String alma::acs::commandcenter::engine::ToolManager::generateCommand Tool  tool,
RunModel  runModel
throws Exception [inline, static]
 

Tool alma::acs::commandcenter::engine::ToolManager::getBuiltinTool String  caption  )  throws IllegalArgumentException, Exception [inline, static]
 

Returns the builtin tool with the specified name.

If no builtin-tool definition has yet been read in, this will try to read the default tools definition file (see getDefaultBuiltinToolsName()). If an exception occurs during that, it will be passed to the caller. To avoid this lazy attempy to read the default definitions, invoke one of

before using this method.

Parameters:
caption the name of a tool
Returns:
a tool descriptor as defined in the tools definition
Exceptions:
IllegalArgumentException if non-defined tool is requested
Exception if no tool defined yet, and loading of default definition fails

String alma::acs::commandcenter::engine::ToolManager::getDefaultBuiltinToolsName  )  [inline, static]
 

String alma::acs::commandcenter::engine::ToolManager::getDefaultExtraToolsName  )  [inline, static]
 

AcsCommandCenterTools alma::acs::commandcenter::engine::ToolManager::getExtraTools  )  throws Exception [inline, static]
 

void alma::acs::commandcenter::engine::ToolManager::readBuiltinTools Reader  f  )  throws Exception [inline, static]
 

Reads the tool definition from the specified reader. They are ADDED to an internal map that uses toolnames as it keys. This implies that if a read-in tool has a name that - after trim() - doesn't exactly match the required name , it will have no effect.

void alma::acs::commandcenter::engine::ToolManager::readDefaultBuiltinTools  )  throws Exception [inline, static]
 

void alma::acs::commandcenter::engine::ToolManager::readDefaultExtraTools  )  throws Exception [inline, static]
 

void alma::acs::commandcenter::engine::ToolManager::readExtraTools Reader  f  )  throws Exception [inline, static]
 

Reads the tool definitions from the specified reader. The tool definitions that were in place before will be REPLACED by this.

String alma::acs::commandcenter::engine::ToolManager::readFromInput Map< String, Object >  input,
String  name,
String  fallback
[inline, static, protected]
 

String alma::acs::commandcenter::engine::ToolManager::readFromModel RunModel  runModel,
String  name,
String  fallback
throws Exception [inline, static, protected]
 


Member Data Documentation

HashMap<String, Tool> alma::acs::commandcenter::engine::ToolManager::builtinTools [static, protected]
 

HashMap<String,Object> alma::acs::commandcenter::engine::ToolManager::emptyMap = new HashMap<StringObject>() [static, private]
 

AcsCommandCenterTools alma::acs::commandcenter::engine::ToolManager::extraTools [static, protected]
 

Logger alma::acs::commandcenter::engine::ToolManager::log = MiscUtils.getPackageLogger(ToolManager.class) [static, private]
 


The documentation for this class was generated from the following file:
Generated on Thu Apr 30 02:51:32 2009 for ACS Java API by doxygen 1.3.8