at.srfg.miner.clientlib

Class Action

Object

at.srfg.miner.clientlib.Action

public class Action
extends Object

A MINER Action is a part of the Scenario specification. The action is a child element of the Task, which in turn is a child element of the Scenario. A MINER action is a central building block of a MINER scenario. An action defines which tool to use, how to configure the tool, on which ToolProxies the tool has to be executed, which results a tool has to produce etc. The following table lists the required and optional properties of an action.

Required?	Name	Description	Quantity
yes	proxy	The Toolproxies on which the action runs	1..N
yes	tool	The fully qualified name of the Tool	1
yes	toolconfig	The XML configuration for the Tool	1
no	name	The name of the action	0..1
no	description	The description of the action	0..1
no	deltaStart	Start offset of the action w.r.t its parent task	0..1
no	duration	The duration of the action	0..1
no	keyword	The keywords of the action	0..N
no	resultHandle	A resultHandle is created for each result that the action's tool must produce, see produce(String) and produce(String, String)	0..N
no	condition	The condition associated with a resultHandle	0..N

Constructor Summary

Constructors

Constructor and Description
Action() Default Constructor.
Action(String name) Creates a new action and sets its name.

Method Summary

Methods

Modifier and Type	Method and Description
void	addActivationEvent(Event... events) Adds events that activate this action.
Condition	addCondition(Condition condition) Set a condition to the action.
Condition	addCondition(String operator) Creates a new condition with the given logical operator and adds it to this action.
void	addDeactivationEvent(Event... events) Sets the events that deactivate this action.
void	addKeyword(String keyword) Adds a keyword for this action.
void	addProxies(String... proxyNames)
Proxy	addProxy(String name) Adds a ToolProxy on which this action is executed.
List<Event>	getActivationEvents() Gets the list of events that activate this action.
Collection<Condition>	getConditions() Gets the conditions that are set for this action.
Date	getCreated() Gets the date when the action was initially created.
List<Event>	getDeactivationEvents() Gets the list of events that deactivate this action.
double	getDeltaStart() Gets the offset in [s] between the start time of the parent task and this action.
String	getDescription() Gets the description of the action.
double	getDuration() Gets the duration in [s] of this action.
int	getID() Gets the identifier that identifies the action at the MINER core.
List<String>	getKeywords() Gets the keywords of this action.
Date	getModified() Gets the date when the action was last modified.
String	getName() Gets the name of the Action.
Collection<Proxy>	getProxies() Gets the list of ToolProxies on which this action is executed.
Proxy	getProxy(String proxyName) Gets a proxy instance.
ResultHandle	getResultHandle(String name) Gets the handle for a result called name.
ResultHandle	getResultHandle(String name, String selector) Gets the handle for a result called name with a given selector.
Collection<ResultHandle>	getResultHandles() Gets all result handles that have been created by previous produce calls.
String	getTool() Gets the name of the Tool used in this action.
org.w3c.dom.Element	getToolconfig() Gets the XML configuration of the Tool.
ResultHandle	produce(String name) Defines that the action's tool must produce the result called name.
ResultHandle	produce(String name, String selector) Defines that the action's tool must produce the result called name with selector selector.
void	setDeltaStart(double deltaStart) Specifies that the action should start deltaStart [s] later than its parent task.
void	setDescription(String description) Sets the description of the Action.
void	setDuration(double duration) Sets the duration of this action in [s].
void	setName(String name) Sets the name of the Action.
void	setTool(String toolName) Sets the Tool which is used for this action.
void	setToolconfig(org.w3c.dom.Document toolConfig) Sets the XML configuration of the Tool via a Document.
void	setToolconfig(org.w3c.dom.Element toolConfig) Sets the XML configuration of the Tool via an Element.
void	setToolconfig(java.io.File file) Sets the XML configuration of the Tool via a File.
void	setToolconfig(String config) Sets the XML configuration of the Tool via a String.

Methods inherited from class Object

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

Constructor Detail

Action

public Action()

Default Constructor.

Action

public Action(String name)

Creates a new action and sets its name.

Parameters:

name - the name

Method Detail

addProxies

public void addProxies(String... proxyNames)

addProxy

public Proxy addProxy(String name)

Adds a ToolProxy on which this action is executed.

Parameters:

name - the name of the ToolProxy

getProxies

public Collection<Proxy> getProxies()

Gets the list of ToolProxies on which this action is executed.

Returns:

a list of ToolProxy names

getProxy

public Proxy getProxy(String proxyName)

Gets a proxy instance.

Parameters:

proxyName - the name of the requested proxy.

Returns:

a proxy or null if it there is no proxy with such a name

setTool

public void setTool(String toolName)

Sets the Tool which is used for this action.
Example:
action.setToolName("at.srfg.miner.tool.SampleTool.SampleTool");

Parameters:

toolName - the fully qualified classname of a Tool

getTool

public String getTool()

Gets the name of the Tool used in this action.

Returns:

the name of the Tool

setToolconfig

public void setToolconfig(org.w3c.dom.Document toolConfig)

Sets the XML configuration of the Tool via a Document.

Parameters:

toolConfig - the configuration document

setToolconfig

public void setToolconfig(org.w3c.dom.Element toolConfig)

Sets the XML configuration of the Tool via an Element.

Parameters:

toolConfig - the configuration element

setToolconfig

public void setToolconfig(String config)
                   throws javax.xml.parsers.ParserConfigurationException,
                          org.xml.sax.SAXException,
                          java.io.IOException

Sets the XML configuration of the Tool via a String. The String must contain well-formed XML.

Parameters:

config - the configuration string in XML format

Throws:

java.io.IOException

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException

Exception - if the string is not well-formed XML

setToolconfig

public void setToolconfig(java.io.File file)
                   throws javax.xml.parsers.ParserConfigurationException,
                          org.xml.sax.SAXException,
                          java.io.IOException

Sets the XML configuration of the Tool via a File. The File must contain well-formed XML.

Parameters:

file - the configuration file in XML format

Throws:

java.io.IOException

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException

Exception - if the file can't be openend or if it's not a well-formed XML file

getToolconfig

public org.w3c.dom.Element getToolconfig()

Gets the XML configuration of the Tool.

Returns:

the configuration

setName

public void setName(String name)

Sets the name of the Action.

Parameters:

name - the name

getName

public String getName()

Gets the name of the Action.

Returns:

the name

setDescription

public void setDescription(String description)

Sets the description of the Action.

Parameters:

description - the description

getDescription

public String getDescription()

Gets the description of the action.

Returns:

the description

setDeltaStart

public void setDeltaStart(double deltaStart)

Specifies that the action should start deltaStart [s] later than its parent task. If this method is not used (or if deltaStart==0) the parent task and this action start at the same time.

Parameters:

deltaStart - the offset in seconds

getDeltaStart

public double getDeltaStart()

Gets the offset in [s] between the start time of the parent task and this action.

Returns:

the offset in seconds

setDuration

public void setDuration(double duration)

Sets the duration of this action in [s]. If no duration is set (or if duration==0) then the action runs as long as its parent task.

Parameters:

duration - the duration in seconds

getDuration

public double getDuration()

Gets the duration in [s] of this action.

Returns:

the duration in seconds

addKeyword

public void addKeyword(String keyword)

Adds a keyword for this action.

Parameters:

keyword - the keyword

getKeywords

public List<String> getKeywords()

Gets the keywords of this action.

Returns:

a list of keywords

produce

public ResultHandle produce(String name)

Defines that the action's tool must produce the result called name. If this method is called more than once for the same name, an IllegalArgumentException will be thrown.

Parameters:

name - the result name

Returns:

a ResultHandle which is needed to query result instances, see the Execution and Query classes.

Throws:

IllegalArgumentException - if produce has been called before with the same name argument.

produce

public ResultHandle produce(String name,
                   String selector)

Defines that the action's tool must produce the result called name with selector selector. If this method is called more than once for the same name and selector, an IllegalArgumentException will be thrown.

Parameters:

name - the result name

selector - the selector

Returns:

a ResultHandle which is needed to query result instances, see the Execution and Query classes.

Throws:

IllegalArgumentException - if produce has been called before with the same name and selector argument.

getResultHandles

public Collection<ResultHandle> getResultHandles()

Gets all result handles that have been created by previous produce calls.

Returns:

a collection of ResultHandles

getResultHandle

public ResultHandle getResultHandle(String name)

Gets the handle for a result called name. Note that if there are multiple result handles with the same name but varying selectors, then one of these result handles is returned.

Parameters:

name - the name of the Tool's ResultResource

Returns:

the result handle

getResultHandle

public ResultHandle getResultHandle(String name,
                           String selector)

Gets the handle for a result called name with a given selector.

Parameters:

name - the name of the Tool's ResultResource

selector - the selector for the result handle

Returns:

the result handle

addCondition

public Condition addCondition(String operator)

Creates a new condition with the given logical operator and adds it to this action.

Parameters:

operator - the logical operator, see Condition.ALL and Condition.ANY

Returns:

the newly created condition

addCondition

public Condition addCondition(Condition condition)

Set a condition to the action.

Parameters:

condition - the condition

Returns:

the input parameter condition

getConditions

public Collection<Condition> getConditions()

Gets the conditions that are set for this action.

Returns:

the conditions

getCreated

public Date getCreated()

Gets the date when the action was initially created.

Returns:

the date

getModified

public Date getModified()

Gets the date when the action was last modified.

Returns:

the date

getID

public int getID()

Gets the identifier that identifies the action at the MINER core.

Returns:

the identifier

addActivationEvent

public void addActivationEvent(Event... events)

Adds events that activate this action.

Parameters:

events -

Since:

3.0.0

getActivationEvents

public List<Event> getActivationEvents()

Gets the list of events that activate this action.

Returns:

the activation events

Since:

3.0.0

addDeactivationEvent

public void addDeactivationEvent(Event... events)

Sets the events that deactivate this action.

Parameters:

events -

Since:

3.0.0

getDeactivationEvents

public List<Event> getDeactivationEvents()

Gets the list of events that deactivate this action.

Returns:

the activation events

Since:

3.0.0