Package nl.rrd.wool.model.command

Class WoolCommand

java.lang.Object

nl.rrd.wool.model.command.WoolCommand

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

WoolAttributesCommand, WoolExpressionCommand

public abstract class WoolCommand
extends Object
implements Cloneable

Base class for commands that are specified with <<...>> in Wool statements and replies.

Constructor Summary

Constructors

Constructor	Description
WoolCommand()

Method Summary

Modifier and Type	Method	Description
abstract WoolCommand	clone()	Returns a deep copy of this command.
abstract void	executeBodyCommand(Map<String,Object> variables, WoolNodeBody processedBody)	This method is called if this command occurs in a statement body.
abstract WoolReply	findReplyById(int replyId)	Tries to find a reply with the specified ID within this command.
abstract void	getNodePointers(Set<WoolNodePointer> pointers)	Retrieves all node pointers that occur in this command and adds them to the specified list.
abstract void	getReadVariableNames(Set<String> varNames)	Retrieves all variable names that are read in this command and adds them to the specified set.
abstract void	getWriteVariableNames(Set<String> varNames)	Retrieves all variable names that are written in this command and adds them to the specified set.

Methods inherited from class java.lang.Object

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

Constructor Detail

WoolCommand

public WoolCommand()

Method Detail

findReplyById

public abstract WoolReply findReplyById(int replyId)

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

Parameters:

replyId - the reply ID

Returns:

the reply or null

getReadVariableNames

public abstract void getReadVariableNames(Set<String> varNames)

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

Parameters:

varNames - the set to which the variable names are added

getWriteVariableNames

public abstract void getWriteVariableNames(Set<String> varNames)

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

Parameters:

varNames - the set to which the variable names are added

getNodePointers

public abstract void getNodePointers(Set<WoolNodePointer> pointers)

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

Parameters:

pointers - the list to which the node pointers are added

executeBodyCommand

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

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.

Parameters:

variables - the variable map

processedBody - the processed body

Throws:

EvaluationException - if an expression cannot be evaluated

clone

public abstract WoolCommand clone()

Returns a deep copy of this command.

Overrides:

clone in class Object

Returns:

a deep copy of this command