com.prosyst.mprm.commands.composite

Class ConditionalCommand

java.lang.Object

com.prosyst.mprm.commands.composite.ConditionalCommand

All Implemented Interfaces:

Command, Externalizable

public class ConditionalCommand
extends java.lang.Object
implements Command

Conditional commands combine a command and control unit filter defining conditional filtering of the control units over which the command to be executed.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONDITIONAL_TYPE

Fields inherited from interface com.prosyst.mprm.commands.Command

COMMAND_TYPE_BATCH_COMMAND, COMMAND_TYPE_CONDITIONAL, COMMAND_TYPE_CU, COMMAND_TYPE_CU_INSTANCE, COMMAND_TYPE_SCRIPT, COMMAND_TYPE_SERIALIZED_COMMAND

Constructor Summary

Constructors

Constructor and Description
ConditionalCommand() Empty constructor.
ConditionalCommand(Command command, ControlUnitFilter parsedFilter) Constructs a ConditionalCommand with given command and parsed filter.
ConditionalCommand(Command command, java.lang.String filter) Constructs a ConditionalCommand with given command and filter.

Method Summary

Modifier and Type	Method and Description
Command	getCommand() Returns the command that is to be executed on the control units satisfying the filtering conditions.
java.lang.String	getFilter() Returns filter specifying the condition which should be satisfied by the target control units.
ControlUnitFilter	getParsedFilter() Returns the control units filter in a parsed appearance
java.lang.String	getType() Returns CONDITIONAL_TYPE constant.
void	readObject(java.io.InputStream in) Method used for serialization
ControlUnitFilter	setFilter(ControlUnitFilter controlUnitFilter) Sets the control units filter for this conditional command in a parsed mode.
java.lang.String	setFilter(java.lang.String filter) Sets the control units filter for this conditional command.
java.lang.String	toString()
void	writeObject(java.io.OutputStream out) Method used for serialization

Methods inherited from class java.lang.Object

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

Field Detail

CONDITIONAL_TYPE

public static final java.lang.String CONDITIONAL_TYPE

See Also:

Constant Field Values

Constructor Detail

ConditionalCommand

public ConditionalCommand()

Empty constructor.

ConditionalCommand

public ConditionalCommand(Command command,
                          java.lang.String filter)

Constructs a ConditionalCommand with given command and filter.

Parameters:

command - command object which will be executed over control units which conform to condition specified by filter.

filter - filter in mPRM Script lexical form defining a criteria for filtering the set of control units over which the command to be executed.

ConditionalCommand

public ConditionalCommand(Command command,
                          ControlUnitFilter parsedFilter)

Constructs a ConditionalCommand with given command and parsed filter.

Parameters:

command - command object which will be executed over control units which conform to condition specified by filter.

parsedFilter - parsed mPRM Script filter.

Method Detail

getType

public java.lang.String getType()

Returns CONDITIONAL_TYPE constant.

Specified by:

getType in interface Command

Returns:

the type of the command object which is defined with CONDITIONAL_TYPE constant.

getFilter

public java.lang.String getFilter()

Returns filter specifying the condition which should be satisfied by the target control units.

Returns:

the filter.

getParsedFilter

public ControlUnitFilter getParsedFilter()

Returns the control units filter in a parsed appearance

Returns:

the control units filter in a parsed appearance

setFilter

public ControlUnitFilter setFilter(ControlUnitFilter controlUnitFilter)

Sets the control units filter for this conditional command in a parsed mode.

setFilter

public java.lang.String setFilter(java.lang.String filter)

Sets the control units filter for this conditional command.

getCommand

public Command getCommand()

Returns the command that is to be executed on the control units satisfying the filtering conditions.

Returns:

the command that is to be executed on the control units satisfying the filtering conditions.

readObject

public void readObject(java.io.InputStream in)
                throws java.lang.Exception

Method used for serialization

Specified by:

readObject in interface Externalizable

Throws:

java.lang.Exception

writeObject

public void writeObject(java.io.OutputStream out)
                 throws java.lang.Exception

Method used for serialization

Specified by:

writeObject in interface Externalizable

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object