alma.acs.commandcenter.engine.ToolManager Class Reference

List of all members.

Static Public Member Functions
static void	readExtraTools (Reader f) throws Exception
static AcsCommandCenterTools	getExtraTools () throws Exception
static String	getDefaultExtraToolsName ()
static void	readDefaultExtraTools () throws Exception
static void	readBuiltinTools (Reader f) throws Exception
static Tool	getBuiltinTool (String caption) throws IllegalArgumentException, Exception
static String	getDefaultBuiltinToolsName ()
static void	readDefaultBuiltinTools () throws Exception
static String	generateCommand (Tool tool, RunModel runModel) throws Exception
static String	generateCommand (Tool tool, RunModel runModel, Map< String, Object > input) throws Exception
Static Protected Member Functions
static String[]	collectInsertions (Tool tool, RunModel runModel, Map< String, Object > input) throws Exception
static String	readFromModel (RunModel runModel, String name, String fallback) throws Exception
static String	readFromInput (Map< String, Object > input, String name, String fallback)
Static Protected Attributes
static AcsCommandCenterTools	extraTools
static HashMap< String, Tool >	builtinTools
Static Package Functions
	[static initializer]

---

Detailed Description

Author:

mschilli

---

Member Function Documentation

alma.acs.commandcenter.engine.ToolManager.[static initializer]

(

)

[static, package]

Initializes the builtinTools map with hardcoded definitions

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

References alma.acs.commandcenter.engine.ToolManager.readFromInput(), and alma.acs.commandcenter.engine.ToolManager.readFromModel().

Referenced by alma.acs.commandcenter.engine.ToolManager.generateCommand().

static String alma.acs.commandcenter.engine.ToolManager.generateCommand	(	Tool	tool,
		RunModel	runModel
	)			throws Exception [static]

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

References alma.acs.commandcenter.engine.ToolManager.collectInsertions(), and alma.acs.commandcenter.util.PreparedString.toString().

static Tool alma.acs.commandcenter.engine.ToolManager.getBuiltinTool

(

String

caption

)

throws IllegalArgumentException, Exception [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

• readDefaultBuiltinTools()
• readBuiltinTools(Reader)

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

References alma.acs.commandcenter.engine.ToolManager.builtinTools.

static String alma.acs.commandcenter.engine.ToolManager.getDefaultBuiltinToolsName

(

)

[static]

Referenced by alma.acs.commandcenter.engine.ToolManager.readDefaultBuiltinTools().

static String alma.acs.commandcenter.engine.ToolManager.getDefaultExtraToolsName

(

)

[static]

Referenced by alma.acs.commandcenter.engine.ToolManager.readDefaultExtraTools().

static AcsCommandCenterTools alma.acs.commandcenter.engine.ToolManager.getExtraTools

(

)

throws Exception [static]

References alma.acs.commandcenter.engine.ToolManager.extraTools.

static void alma.acs.commandcenter.engine.ToolManager.readBuiltinTools

(

Reader

f

)

throws Exception [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.

References alma.acs.commandcenter.engine.ToolManager.builtinTools.

Referenced by alma.acs.commandcenter.engine.ToolManager.readDefaultBuiltinTools().

static void alma.acs.commandcenter.engine.ToolManager.readDefaultBuiltinTools

(

)

throws Exception [static]

References alma.acs.commandcenter.engine.ToolManager.getDefaultBuiltinToolsName(), and alma.acs.commandcenter.engine.ToolManager.readBuiltinTools().

static void alma.acs.commandcenter.engine.ToolManager.readDefaultExtraTools

(

)

throws Exception [static]

References alma.acs.commandcenter.engine.ToolManager.getDefaultExtraToolsName(), and alma.acs.commandcenter.engine.ToolManager.readExtraTools().

static void alma.acs.commandcenter.engine.ToolManager.readExtraTools

(

Reader

f

)

throws Exception [static]

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

References alma.acs.commandcenter.engine.ToolManager.extraTools.

Referenced by alma.acs.commandcenter.engine.ToolManager.readDefaultExtraTools().

static String alma.acs.commandcenter.engine.ToolManager.readFromInput	(	Map< String, Object >	input,
		String	name,
		String	fallback
	)			[static, protected]

Referenced by alma.acs.commandcenter.engine.ToolManager.collectInsertions().

static String alma.acs.commandcenter.engine.ToolManager.readFromModel	(	RunModel	runModel,
		String	name,
		String	fallback
	)			throws Exception [static, protected]

Referenced by alma.acs.commandcenter.engine.ToolManager.collectInsertions().

---

Member Data Documentation

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

Referenced by alma.acs.commandcenter.engine.ToolManager.getBuiltinTool(), and alma.acs.commandcenter.engine.ToolManager.readBuiltinTools().

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

Referenced by alma.acs.commandcenter.engine.ToolManager.getExtraTools(), and alma.acs.commandcenter.engine.ToolManager.readExtraTools().

---

The documentation for this class was generated from the following file:

• ToolManager.java