Package org.bigraphs.framework.core.reactivesystem

Class AbstractReactionRule<B extends Bigraph<? extends Signature<?>>>

java.lang.Object

org.bigraphs.framework.core.reactivesystem.AbstractReactionRule<B>

Type Parameters:

B - type of the bigraph

All Implemented Interfaces:

HasLabel, HasPriority, ReactionRule<B>

Direct Known Subclasses:

AbstractReactionRule.ReactiveSystemBoundReactionRule, GroundReactionRule, ParametricReactionRule

public abstract class AbstractReactionRule<B extends Bigraph<? extends Signature<?>>>
extends Object
implements ReactionRule<B>

This base class represents an immutable data structure for all kinds of reaction rules. It contains the redex, reactum and an instantiation map.

The signature is inferred from the redex since both redex and reactum must have the same signature, otherwise an exception is thrown when instantiating a concrete reaction rule.

Other checks are also performed checking the reaction rule for conformity: Interfaces and "simpleness".

A rule is said to be linear when they do not duplicate or delete parameters.

Author:

Dominik Grzelak

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractReactionRule.ReactiveSystemBoundReactionRule<B extends Bigraph<? extends Signature<?>>>

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	canReverse
protected InstantiationMap	instantiationMap
protected String	label
protected long	priority
protected ReactiveSystem<B>	reactiveSystemAffili
protected final B	reactum
protected final B	redex
protected final Signature<?>	signature
protected TrackingMap	trackingMap

Constructor Summary

Constructors

Constructor	Description
AbstractReactionRule(B redex, B reactum)
AbstractReactionRule(B redex, B reactum, boolean isReversible)
AbstractReactionRule(B redex, B reactum, InstantiationMap instantiationMap)
AbstractReactionRule(B redex, B reactum, InstantiationMap instantiationMap, boolean isReversible)
AbstractReactionRule(ReactiveSystem delegate, AbstractReactionRule rule)

Method Summary

Modifier and Type	Method	Description
protected void	assertInstantiationMapIsWellDefined()
protected void	assertIsProperParametricRule()
protected void	assertRedexIsSimple()
InstantiationMap	getInstantationMap()	Return the instantiation map of the parametric reaction rule
String	getLabel()
long	getPriority()
B	getReactum()	Return the reactum of the reaction rule
B	getRedex()	Return the redex of the reaction rule
Signature<?>	getSignature()
TrackingMap	getTrackingMap()	Returns the tracking map if one was specified for the rule.
boolean	isReversible()	A flag that indicates whether the rule can be also executed in reverse.
AbstractReactionRule<B>	withInstantiationMap(InstantiationMap instantiationMap)
<T extends AbstractReactionRule<B>> T	withLabel(String label)
<T extends AbstractReactionRule<B>> T	withPriority(long priority)
AbstractReactionRule.ReactiveSystemBoundReactionRule<B>	withReactiveSystem(ReactiveSystem<B> reactiveSystem)
AbstractReactionRule<B>	withTrackingMap(TrackingMap trackingMap)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bigraphs.framework.core.reactivesystem.HasLabel

isDefined

Methods inherited from interface org.bigraphs.framework.core.reactivesystem.ReactionRule

isParametricRule, isProperParametricRule, isRedexSimple

Field Details

signature

protected final Signature<?> signature

redex

protected final B extends Bigraph<? extends Signature<?>> redex

reactum

protected final B extends Bigraph<? extends Signature<?>> reactum

canReverse

protected boolean canReverse

instantiationMap

protected InstantiationMap instantiationMap

reactiveSystemAffili

protected ReactiveSystem<B extends Bigraph<? extends Signature<?>>> reactiveSystemAffili

label

protected String label

priority

protected long priority

trackingMap

protected TrackingMap trackingMap

Constructor Details

AbstractReactionRule

public AbstractReactionRule(B redex,
 B reactum)
                     throws InvalidReactionRuleException

Throws:

InvalidReactionRuleException

AbstractReactionRule

public AbstractReactionRule(B redex,
 B reactum,
 InstantiationMap instantiationMap)
                     throws InvalidReactionRuleException

Throws:

InvalidReactionRuleException

AbstractReactionRule

public AbstractReactionRule(B redex,
 B reactum,
 boolean isReversible)
                     throws InvalidReactionRuleException

Throws:

InvalidReactionRuleException

AbstractReactionRule

public AbstractReactionRule(B redex,
 B reactum,
 InstantiationMap instantiationMap,
 boolean isReversible)
                     throws InvalidReactionRuleException

Throws:

InvalidReactionRuleException

AbstractReactionRule

public AbstractReactionRule(ReactiveSystem delegate,
 AbstractReactionRule rule)
                     throws InvalidReactionRuleException

Throws:

InvalidReactionRuleException

Method Details

withReactiveSystem

public AbstractReactionRule.ReactiveSystemBoundReactionRule<B> withReactiveSystem(ReactiveSystem<B> reactiveSystem)

getLabel

public String getLabel()

Specified by:

getLabel in interface HasLabel

withLabel

public <T extends AbstractReactionRule<B>> T withLabel(String label)

getPriority

public long getPriority()

Specified by:

getPriority in interface HasPriority

withPriority

public <T extends AbstractReactionRule<B>> T withPriority(long priority)

assertRedexIsSimple

protected void assertRedexIsSimple()
                            throws RedexIsNotSimpleException

Throws:

RedexIsNotSimpleException

assertIsProperParametricRule

protected void assertIsProperParametricRule()
                                     throws ParametricReactionRuleIsNotWellDefined

Throws:

ParametricReactionRuleIsNotWellDefined

assertInstantiationMapIsWellDefined

protected void assertInstantiationMapIsWellDefined()
                                            throws InstantiationMapIsNotWellDefined

Throws:

InstantiationMapIsNotWellDefined

getInstantationMap

public InstantiationMap getInstantationMap()

Description copied from interface: ReactionRule

Return the instantiation map of the parametric reaction rule

Specified by:

getInstantationMap in interface ReactionRule<B extends Bigraph<? extends Signature<?>>>

Returns:

the instantiation map of the parametric reaction rule

isReversible

public boolean isReversible()

Description copied from interface: ReactionRule

A flag that indicates whether the rule can be also executed in reverse. For a rule R -> R' it means that R' -> R can also be used.

This flag is usually evaluated in a reactive system class.

Specified by:

isReversible in interface ReactionRule<B extends Bigraph<? extends Signature<?>>>

Returns:

true, if the rule can also be used reversely, otherwise false

getRedex

public B getRedex()

Description copied from interface: ReactionRule

Return the redex of the reaction rule

Specified by:

getRedex in interface ReactionRule<B extends Bigraph<? extends Signature<?>>>

Returns:

the redex of the reaction rule

getReactum

public B getReactum()

Description copied from interface: ReactionRule

Return the reactum of the reaction rule

Specified by:

getReactum in interface ReactionRule<B extends Bigraph<? extends Signature<?>>>

Returns:

the reactum of the reaction rule

getSignature

public Signature<?> getSignature()

withTrackingMap

public AbstractReactionRule<B> withTrackingMap(TrackingMap trackingMap)

withInstantiationMap

public AbstractReactionRule<B> withInstantiationMap(InstantiationMap instantiationMap)

getTrackingMap

public TrackingMap getTrackingMap()

Description copied from interface: ReactionRule

Returns the tracking map if one was specified for the rule. A tracking map helps to trace node and link identities through reactions.

Specified by:

getTrackingMap in interface ReactionRule<B extends Bigraph<? extends Signature<?>>>

Returns:

the tracking map of the rule