uk.ac.sheffield.vtts.model

Class Scenario

java.lang.Object

uk.ac.sheffield.vtts.model.Element

uk.ac.sheffield.vtts.model.Named

uk.ac.sheffield.vtts.model.Event

uk.ac.sheffield.vtts.model.Scenario

public class Scenario
extends Event

Scenario represents one branching path through a single operation. An Operation consists of one or more Scenarios, each of which takes a distinct logical path.

Version:

Broker@Cloud 1.0

Author:

Anthony J H Simons

Field Summary

Fields inherited from class uk.ac.sheffield.vtts.model.Named

name

Constructor Summary

Constructors

Constructor and Description
Scenario() Creates a default Scenario.
Scenario(java.lang.String name) Creates a named Scenario.

Method Summary

Methods

Modifier and Type	Method and Description
Scenario	addBinding(Binding binding) Adds a Binding of initial Expressions to Variables to this Scenario.
Scenario	addCondition(Condition condition) Adds the guard Condition for this Scenario.
Scenario	addEffect(Effect effect) Adds the Effect,the updated binding of Expressions to Parameters.
boolean	execute() Conditionally executes this Scenario.
Binding	getBinding() Returns the Binding of Expressions to Variables in this Scenario.
Condition	getCondition() Returns the guard Condition for this Scenario.
Binding	getEffect() Returns the Effect, the updated binding of Expressions to Parameters.
java.util.Set<Predicate>	getPartitions() Returns the set of all possible atomic predicates and their negations that can be derived from this Scenario's Condition.
boolean	isEnabled() Reports whether this Scenario is enabled in the current Memory state.
Scenario	resolve(Scope scope) Causes this Scenario to resolve its global/local Parameter references.

Methods inherited from class uk.ac.sheffield.vtts.model.Event

requestName, responseName, validate

Methods inherited from class uk.ac.sheffield.vtts.model.Named

equals, getName, hashCode, setName, setName, toString

Methods inherited from class uk.ac.sheffield.vtts.model.Element

safeEquals, safeHashCode, semanticError

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Scenario

public Scenario()

Creates a default Scenario.

Scenario

public Scenario(java.lang.String name)

Creates a named Scenario.

Parameters:

name - the name of this Scenario.

Method Detail

addBinding

public Scenario addBinding(Binding binding)

Adds a Binding of initial Expressions to Variables to this Scenario.

Parameters:

binding - the Binding to add.

Returns:

this Memory.

getBinding

public Binding getBinding()

Returns the Binding of Expressions to Variables in this Scenario.

Returns:

the initial Binding.

addCondition

public Scenario addCondition(Condition condition)

Adds the guard Condition for this Scenario.

Parameters:

condition - the condition to add.

Returns:

this response.

getCondition

public Condition getCondition()

Returns the guard Condition for this Scenario.

Returns:

the guard Condition.

getPartitions

public java.util.Set<Predicate> getPartitions()

Returns the set of all possible atomic predicates and their negations that can be derived from this Scenario's Condition. The returned set is not structured in any way. The structuring of partitions is performed by Operation. Returns an empty set if this Scenario has no Condition.

Returns:

a set of Predicates.

addEffect

public Scenario addEffect(Effect effect)

Adds the Effect,the updated binding of Expressions to Parameters.

Parameters:

effect - the side-effect.

Returns:

this Response.

getEffect

public Binding getEffect()

Returns the Effect, the updated binding of Expressions to Parameters.

Returns:

the side-effect.

resolve

public Scenario resolve(Scope scope)

Causes this Scenario to resolve its global/local Parameter references. The Scope is a table of Parameters constructed from global Memory and the owning local Operation. Delegates to the initial Binding, guard Condition and final Effect, where present, causing these to resolve their global/local Parameter references.

Parameters:

scope - a Scope containing global and local Parameters.

Returns:

this Scenario.

isEnabled

public boolean isEnabled()

Reports whether this Scenario is enabled in the current Memory state. If a Binding is provided, binds any Inputs. If a Condition is provided, tests the guard Condition, which may refer to Inputs and Variables from the Memory. If the guard Condition is satisfied, returns true.

Returns:

true, if this Scenario is enabled.

execute

public boolean execute()

Conditionally executes this Scenario. If a Binding is provided, binds any Inputs. If a Condition is provided, tests the guard Condition, which may refer to Inputs and Variables from the Memory. If the guard Condition is satisfied and an Effect is provided, executes the Effect.

Returns:

true, if the Condition was satisfied, otherwise false.