Package nl.rrd.wool.model.command

Class WoolInputSetCommand

java.lang.Object

nl.rrd.wool.model.command.WoolCommand

nl.rrd.wool.model.command.WoolAttributesCommand

nl.rrd.wool.model.command.WoolInputCommand

nl.rrd.wool.model.command.WoolInputSetCommand

All Implemented Interfaces:

Cloneable

public class WoolInputSetCommand
extends WoolInputCommand

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WoolInputSetCommand.Option

Field Summary

Fields inherited from class nl.rrd.wool.model.command.WoolInputCommand

TYPE_NUMERIC, TYPE_SET, TYPE_TEXT, TYPE_TIME

Constructor Summary

Constructors

Constructor	Description
WoolInputSetCommand()
WoolInputSetCommand(WoolInputSetCommand other)

Method Summary

Modifier and Type	Method	Description
WoolInputSetCommand	clone()	Returns a deep copy of this command.
void	executeBodyCommand(Map<String,Object> variables, WoolNodeBody processedBody)	This method is called if this command occurs in a statement body.
List<WoolInputSetCommand.Option>	getOptions()
Map<String,?>	getParameters()	Returns the parameters for this input command to send to the client.
void	getReadVariableNames(Set<String> varNames)	Retrieves all variable names that are read in this command and adds them to the specified set.
String	getStatementLog(WoolVariableStore varStore)	Returns the string to use in the user statement log in place of this input command.
void	getWriteVariableNames(Set<String> varNames)	Retrieves all variable names that are written in this command and adds them to the specified set.
static WoolInputSetCommand	parse(WoolBodyToken cmdStartToken, Map<String,WoolBodyToken> attrs)
void	setOptions(List<WoolInputSetCommand.Option> options)
String	toString()

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

findReplyById, getNodePointers, getType, parse, setType

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

parseAttributesCommand, readAttr, readIntAttr, readPlainTextAttr, readVariableAttr

Methods inherited from class java.lang.Object

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

Constructor Detail

WoolInputSetCommand

public WoolInputSetCommand()

WoolInputSetCommand

public WoolInputSetCommand(WoolInputSetCommand other)

Method Detail

getOptions

public List<WoolInputSetCommand.Option> getOptions()

setOptions

public void setOptions(List<WoolInputSetCommand.Option> options)

getParameters

public Map<String,?> getParameters()

Description copied from class: WoolInputCommand

Returns the parameters for this input command to send to the client. This is a map from parameter names to values. A value can be any JSON type. This method should only be called on a command that has already been executed with executeBodyCommand(). This means that any variables in parameter values have already been resolved.

Specified by:

getParameters in class WoolInputCommand

Returns:

the parameters for this input command to send to the client

getStatementLog

public String getStatementLog(WoolVariableStore varStore)

Description copied from class: WoolInputCommand

Returns the string to use in the user statement log in place of this input command. It can use variable values from the specified variable store. This method should only be called on a command that has already been executed with executeBodyCommand(). This means that any variables in parameter values have already been resolved.

Specified by:

getStatementLog in class WoolInputCommand

Parameters:

varStore - the variable store

Returns:

the statement log

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

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

clone

public WoolInputSetCommand clone()

Description copied from class: WoolCommand

Returns a deep copy of this command.

Specified by:

clone in class WoolCommand

Returns:

a deep copy of this command

parse

public static WoolInputSetCommand parse(WoolBodyToken cmdStartToken,
                                        Map<String,WoolBodyToken> attrs)
                                 throws LineNumberParseException

Throws:

LineNumberParseException