Package nl.rrd.wool.model.command

Class WoolActionCommand

java.lang.Object

nl.rrd.wool.model.command.WoolCommand

nl.rrd.wool.model.command.WoolAttributesCommand

nl.rrd.wool.model.command.WoolActionCommand

public class WoolActionCommand
extends WoolAttributesCommand

This command models the <<action ...>> command in WOOL. It specifies an action that should be performed along with a statement. It can be part of a WoolNodeBody (along with an agent statement) or a WoolReply (to be performed when the user chooses the reply). Three different action commands are supported:

• image
• video
• generic

Field Summary

Fields

Modifier and Type	Field	Description
static String	TYPE_GENERIC
static String	TYPE_IMAGE
static String	TYPE_VIDEO

Constructor Summary

Constructors

Constructor	Description
WoolActionCommand(String type, WoolVariableString value)	Creates an instance of a WoolActionCommand with given type and value.

Method Summary

Modifier and Type	Method	Description
void	addParameter(String name, WoolVariableString value)
void	executeBodyCommand(Map<String,Object> variables, WoolNodeBody processedBody)	This method is called if this command occurs in a statement body.
WoolReply	findReplyById(int replyId)	Tries to find a reply with the specified ID within this command.
void	getNodePointers(Set<WoolNodePointer> pointers)	Retrieves all node pointers that occur in this command and adds them to the specified list.
Map<String,WoolVariableString>	getParameters()
void	getReadVariableNames(Set<String> varNames)	Retrieves all variable names that are read in this command and adds them to the specified set.
String	getType()	Returns the type of this WoolActionCommand as a String.
WoolVariableString	getValue()
void	getWriteVariableNames(Set<String> varNames)	Retrieves all variable names that are written in this command and adds them to the specified set.
static WoolActionCommand	parse(WoolBodyToken cmdStartToken, CurrentIterator<WoolBodyToken> tokens, WoolNodeState nodeState)
void	setParameters(Map<String,WoolVariableString> parameters)
void	setType(String type)	Sets the type of this WoolActionCommand, which should be one of "image", "video", or "generic".
void	setValue(WoolVariableString value)
String	toString()

Methods inherited from class nl.rrd.wool.model.command.WoolAttributesCommand

parseAttributesCommand, readAttr, readIntAttr, readPlainTextAttr, readVariableAttr

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_IMAGE

public static final String TYPE_IMAGE

See Also:

Constant Field Values

TYPE_VIDEO

public static final String TYPE_VIDEO

See Also:

Constant Field Values

TYPE_GENERIC

public static final String TYPE_GENERIC

See Also:

Constant Field Values

Constructor Detail

WoolActionCommand

public WoolActionCommand(String type,
                         WoolVariableString value)

Creates an instance of a WoolActionCommand with given type and value.

Parameters:

type - the type of this WoolActionCommand as a String, which should be one of "image", "video", or "generic".

value - the value of this command

Method Detail

getType

public String getType()

Returns the type of this WoolActionCommand as a String.

Returns:

the type of this WoolActionCommand as a String.

setType

public void setType(String type)

Sets the type of this WoolActionCommand, which should be one of "image", "video", or "generic".

Parameters:

type - the type of this WoolActionCommand.

getValue

public WoolVariableString getValue()

setValue

public void setValue(WoolVariableString value)

getParameters

public Map<String,WoolVariableString> getParameters()

setParameters

public void setParameters(Map<String,WoolVariableString> parameters)

addParameter

public void addParameter(String name,
                         WoolVariableString value)

findReplyById

public WoolReply findReplyById(int replyId)

Description copied from class: WoolCommand

Tries to find a reply with the specified ID within this command. If no such reply is found, this method returns null.

Specified by:

findReplyById in class WoolCommand

Parameters:

replyId - the reply ID

Returns:

the reply or null

getReadVariableNames

public void getReadVariableNames(Set<String> varNames)

Description copied from class: WoolCommand

Retrieves all variable names that are read in this command and adds them to the specified set.

Specified by:

getReadVariableNames in class WoolCommand

Parameters:

varNames - the set to which the variable names are added

getWriteVariableNames

public void getWriteVariableNames(Set<String> varNames)

Description copied from class: WoolCommand

Retrieves all variable names that are written in this command and adds them to the specified set.

Specified by:

getWriteVariableNames in class WoolCommand

Parameters:

varNames - the set to which the variable names are added

getNodePointers

public void getNodePointers(Set<WoolNodePointer> pointers)

Description copied from class: WoolCommand

Retrieves all node pointers that occur in this command and adds them to the specified list.

Specified by:

getNodePointers in class WoolCommand

Parameters:

pointers - the list to which the node pointers are added

executeBodyCommand

public void executeBodyCommand(Map<String,Object> variables,
                               WoolNodeBody processedBody)
                        throws EvaluationException

Description copied from class: WoolCommand

This method is called if this command occurs in a statement body. It executes the command with respect to the specified variable map. Any body content that should be sent to the client, is added to "processedBody". This content can be text or client commands, with all variables resolved.

Specified by:

executeBodyCommand in class WoolCommand

Parameters:

variables - the variable map

processedBody - the processed body

Throws:

EvaluationException - if an expression cannot be evaluated

toString

public String toString()

Overrides:

toString in class Object

parse

public static WoolActionCommand parse(WoolBodyToken cmdStartToken,
                                      CurrentIterator<WoolBodyToken> tokens,
                                      WoolNodeState nodeState)
                               throws LineNumberParseException

Throws:

LineNumberParseException