alma.acs.commandcenter.engine

Class ToolManager

java.lang.Object

alma.acs.commandcenter.engine.ToolManager

public class ToolManager
extends java.lang.Object

Author:

mschilli

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.HashMap<java.lang.String,Tool>	builtinTools
protected static AcsCommandCenterTools	extraTools

Constructor Summary

Constructors

Constructor and Description
ToolManager()

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String[]	collectInsertions(Tool tool, RunModel runModel, java.util.Map<java.lang.String,java.lang.Object> input)
static java.lang.String	generateCommand(Tool tool, RunModel runModel)
static java.lang.String	generateCommand(Tool tool, RunModel runModel, java.util.Map<java.lang.String,java.lang.Object> input)
static Tool	getBuiltinTool(java.lang.String caption) Returns the builtin tool with the specified name.
static java.lang.String	getDefaultBuiltinToolsName()
static java.lang.String	getDefaultExtraToolsName()
static AcsCommandCenterTools	getExtraTools()
static void	readBuiltinTools(java.io.Reader f) Reads the tool definition from the specified reader.
static void	readDefaultBuiltinTools()
static void	readDefaultExtraTools()
static void	readExtraTools(java.io.Reader f) Reads the tool definitions from the specified reader.
protected static java.lang.String	readFromInput(java.util.Map<java.lang.String,java.lang.Object> input, java.lang.String name, java.lang.String fallback)
protected static java.lang.String	readFromModel(RunModel runModel, java.lang.String name, java.lang.String fallback)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

extraTools

protected static AcsCommandCenterTools extraTools

builtinTools

protected static java.util.HashMap<java.lang.String,Tool> builtinTools

Constructor Detail

ToolManager

public ToolManager()

Method Detail

readExtraTools

public static void readExtraTools(java.io.Reader f)
                           throws java.lang.Exception

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

Throws:

java.lang.Exception

getExtraTools

public static AcsCommandCenterTools getExtraTools()
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getDefaultExtraToolsName

public static java.lang.String getDefaultExtraToolsName()

readDefaultExtraTools

public static void readDefaultExtraTools()
                                  throws java.lang.Exception

Throws:

java.lang.Exception

readBuiltinTools

public static void readBuiltinTools(java.io.Reader f)
                             throws java.lang.Exception

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.

Throws:

java.lang.Exception

getBuiltinTool

public static Tool getBuiltinTool(java.lang.String caption)
                           throws java.lang.IllegalArgumentException,
                                  java.lang.Exception

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

• readDefaultBuiltinTools()
• readBuiltinTools(Reader)

before using this method.

Parameters:

caption - the name of a tool

Returns:

a tool descriptor as defined in the tools definition

Throws:

java.lang.IllegalArgumentException - if non-defined tool is requested

java.lang.Exception - if no tool defined yet, and loading of default definition fails

getDefaultBuiltinToolsName

public static java.lang.String getDefaultBuiltinToolsName()

readDefaultBuiltinTools

public static void readDefaultBuiltinTools()
                                    throws java.lang.Exception

Throws:

java.lang.Exception

generateCommand

public static java.lang.String generateCommand(Tool tool,
                                               RunModel runModel)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

generateCommand

public static java.lang.String generateCommand(Tool tool,
                                               RunModel runModel,
                                               java.util.Map<java.lang.String,java.lang.Object> input)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

collectInsertions

protected static java.lang.String[] collectInsertions(Tool tool,
                                                      RunModel runModel,
                                                      java.util.Map<java.lang.String,java.lang.Object> input)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

readFromModel

protected static java.lang.String readFromModel(RunModel runModel,
                                                java.lang.String name,
                                                java.lang.String fallback)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

readFromInput

protected static java.lang.String readFromInput(java.util.Map<java.lang.String,java.lang.Object> input,
                                                java.lang.String name,
                                                java.lang.String fallback)