org.eclipse.viatra.transformation.evm.api

Class RuleBase

java.lang.Object

org.eclipse.viatra.transformation.evm.api.RuleBase

Direct Known Subclasses:

AdaptableRuleBase, DseEvmRuleBase

public class RuleBase
extends java.lang.Object

An RuleBase is associated to an EventRealm and it is responsible for creating, managing and disposing rules in the Rule Engine. It provides an unmodifiable view for the collection of applicable activations.

Field Summary

Fields

Modifier and Type	Field and Description
protected Agenda	agenda
protected EventRealm	eventRealm
protected org.apache.log4j.Logger	logger
protected com.google.common.collect.Table<RuleSpecification<?>,EventFilter<?>,RuleInstance<?>>	ruleInstanceTable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RuleBase(EventRealm eventRealm, Agenda agenda) Instantiates a new RuleBase instance with the given EventRealm and Agenda.

Method Summary

Modifier and Type	Method and Description
ScopedConflictSet	createScopedConflictSet(ConflictResolver conflictResolver, com.google.common.collect.Multimap<RuleSpecification<?>,EventFilter<?>> specifications) Creates a scoped conflict set of the enabled activations of the provided rule specifications and filters using the given conflict resolver.
protected void	dispose() Disposes of each rule instance managed by the agenda.
protected <EventAtom> RuleInstance<EventAtom>	findInstance(RuleSpecification<EventAtom> specification, EventFilter<? super EventAtom> filter)
Agenda	getAgenda()
EventRealm	getEventRealm()
<EventAtom> RuleInstance<EventAtom>	getInstance(RuleSpecification<EventAtom> specification, EventFilter<? super EventAtom> filter) Returns the filtered instance managed by the RuleBase for the given specification.
org.apache.log4j.Logger	getLogger()
java.util.Set<RuleInstance<?>>	getRuleInstances()
com.google.common.collect.Multimap<RuleSpecification<?>,EventFilter<?>>	getRuleSpecificationMultimap()
protected <EventAtom> RuleInstance<EventAtom>	instantiateRule(RuleSpecification<EventAtom> specification, EventFilter<? super EventAtom> filter) Instantiates the given specification over the EventRealm of the RuleBase.
protected <EventAtom> boolean	removeRule(RuleInstance<EventAtom> instance) Removes and disposes of a rule instance.
protected <EventAtom> boolean	removeRule(RuleSpecification<EventAtom> specification, EventFilter<? super EventAtom> filter) Removes and disposes of a rule instance with the given specification.

Methods inherited from class java.lang.Object

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

Field Detail

eventRealm

protected final EventRealm eventRealm

ruleInstanceTable

protected final com.google.common.collect.Table<RuleSpecification<?>,EventFilter<?>,RuleInstance<?>> ruleInstanceTable

agenda

protected final Agenda agenda

logger

protected final org.apache.log4j.Logger logger

Constructor Detail

RuleBase

protected RuleBase(EventRealm eventRealm,
                   Agenda agenda)

Instantiates a new RuleBase instance with the given EventRealm and Agenda.

Parameters:

eventRealm - the EventRealm instance

agenda - the Agenda instance

Method Detail

instantiateRule

protected <EventAtom> RuleInstance<EventAtom> instantiateRule(RuleSpecification<EventAtom> specification,
                                                              EventFilter<? super EventAtom> filter)

Instantiates the given specification over the EventRealm of the RuleBase. If the specification was already instantiated, the existing instance is returned.

Parameters:

specification - the rule to be instantiated

Returns:

the created or existing rule instance

removeRule

protected <EventAtom> boolean removeRule(RuleInstance<EventAtom> instance)

Removes and disposes of a rule instance.

Parameters:

instance -

Returns:

true, if the instance was part of the RuleBase

removeRule

protected <EventAtom> boolean removeRule(RuleSpecification<EventAtom> specification,
                                         EventFilter<? super EventAtom> filter)

Removes and disposes of a rule instance with the given specification.

Parameters:

specification -

filter - the partial match used as filter

Returns:

true, if the specification had an instance in the RuleBase

dispose

protected void dispose()

Disposes of each rule instance managed by the agenda.

getEventRealm

public EventRealm getEventRealm()

getRuleSpecificationMultimap

public com.google.common.collect.Multimap<RuleSpecification<?>,EventFilter<?>> getRuleSpecificationMultimap()

getRuleInstances

public java.util.Set<RuleInstance<?>> getRuleInstances()

Returns:

an immutable copy of the set of rule instances

getInstance

public <EventAtom> RuleInstance<EventAtom> getInstance(RuleSpecification<EventAtom> specification,
                                                       EventFilter<? super EventAtom> filter)

Returns the filtered instance managed by the RuleBase for the given specification.

Parameters:

specification -

filter - the partial match to be used as filter

Returns:

the instance, if it exists, null otherwise

findInstance

protected <EventAtom> RuleInstance<EventAtom> findInstance(RuleSpecification<EventAtom> specification,
                                                           EventFilter<? super EventAtom> filter)

createScopedConflictSet

public ScopedConflictSet createScopedConflictSet(ConflictResolver conflictResolver,
                                                 com.google.common.collect.Multimap<RuleSpecification<?>,EventFilter<?>> specifications)

Creates a scoped conflict set of the enabled activations of the provided rule specifications and filters using the given conflict resolver. The set will be incrementally updated until disposed.

Parameters:

conflictResolver -

specifications -

getAgenda

public Agenda getAgenda()

getLogger

public org.apache.log4j.Logger getLogger()