com.goldencode.p2j.ui

Class TriggerManager

java.lang.Object

com.goldencode.p2j.ui.TriggerManager

public class TriggerManager
extends java.lang.Object

This class organizes triggers registration into multiple scopes of LIFO stacks.

Registrations are kept in a scoped dictionary. Every top level block creates a new scope for triggers in scopeStart method. The registry inside the scope is a LinkedList of EventList objects. The list is stored as the scope extra object, so the dictionary is not in use. The scope's registry works as a FIFO stack for EventLists. The most recent registration is added to the list head. Deregistration may require full removal of one or more EventList objects or editing their contents. Editing happens when only some events for a widget have to be deregistered, but some others remain active.

Field Summary

Fields

Modifier and Type	Field and Description
private static CentralLogger	LOG logger

Constructor Summary

Constructors

Constructor and Description
TriggerManager()

Method Summary

Modifier and Type	Method and Description
private static void	collectRowDisplayEvents(EventList list, org.roaringbitmap.RoaringBitmap triggers) Collect trigger IDs for row display events in an event list.
static void	deregister(ScopedDictionary<?,?> registry, EventList el) Deregisters a trigger for specified events and widgets.
private static java.lang.String	dumpRegistry(ScopedDictionary<?,?> registry) Renders the registry as text.
private static java.lang.String	dumpScope(java.util.LinkedList<EventList> scope, java.lang.String descriptor) Renders the given scope as text.
static EventList	mergeTriggerRegistry(ScopedDictionary<?,?> registry) Merges all trigger registry entries of all scopes and produces a EventList instance that represents all sensitive widgets with all event codes they are sensitive to.
static void	register(ScopedDictionary<?,?> registry, EventList events, int tid) Registers a trigger within the current scope.
private static boolean	scopeFinished(java.util.LinkedList<EventList> source, java.util.LinkedList<EventList> target) Process a notification that a scope is about to be exited.
static boolean	scopeFinished(ScopedDictionary<?,?> registry) Process a notification that a scope is about to be exited.
static void	scopeStart(ScopedDictionary<?,?> registry) Process a notification that a new block scope is about to be entered.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final CentralLogger LOG

logger

Constructor Detail

TriggerManager

public TriggerManager()

Method Detail

scopeStart

public static void scopeStart(ScopedDictionary<?,?> registry)

Process a notification that a new block scope is about to be entered.

Parameters:

registry - ScopedDictionary that keeps track of trigger registrations for this session.

scopeFinished

public static boolean scopeFinished(ScopedDictionary<?,?> registry)

Process a notification that a scope is about to be exited.

All non-persistent triggers registered in the scope are deregistered.

All persistent triggers registered in this scope are moved to the previous scope.

Parameters:

registry - ScopedDictionary that keeps track of trigger registrations for this session.

Returns:

true if there were any events in the current scope.

register

public static void register(ScopedDictionary<?,?> registry,
                            EventList events,
                            int tid)

Registers a trigger within the current scope. If this is a persistent trigger, all prior persistent triggers defined for the same events (on any scope) will be removed.

Parameters:

registry - Tracks trigger registrations for this session.

events - Defines the events and widgets on which to execute this trigger.

tid - The trigger ID.

deregister

public static void deregister(ScopedDictionary<?,?> registry,
                              EventList el)

Deregisters a trigger for specified events and widgets.

In Progress, requests to deregister (REVERT) the very first trigger definition for a pair of {event, widget} are silently ignored.

Triggers are deregistered only from the current scope. If there are definitions of this trigger in previous scopes (or if this is an ANYWHERE trigger), then all definitions are removed; otherwise, all are removed but one.

Trigger deregistration is complicated. Triggers are registered for a list of set pairs like: {(event1, event2) (widget1, widget2)} // item 1 {(event1, event2) (widget1, widget2, widget3)} // item 2 ... A deregistration request may come, for example, for event2 of widget1 and event1 of widget2 and event10 of widget1000. Deregistration should be made for the first encountered match {event, widget} and the remaining registrations should be kept. So, in that case: {(event1) (widget1)} // item 1.1 {(event2) (widget2)} // item 1.2 {(event1, event2) (widget1, widget2, widget3)} // item 2 ... is the result.

Parameters:

registry - ScopedDictionary that keeps track of trigger registrations for this session.

el - EventList object, encoding events and widgets this request has come for

mergeTriggerRegistry

public static EventList mergeTriggerRegistry(ScopedDictionary<?,?> registry)

Merges all trigger registry entries of all scopes and produces a EventList instance that represents all sensitive widgets with all event codes they are sensitive to.

Parameters:

registry - ScopedDictionary that keeps track of trigger registrations for this session.

Returns:

a merged EventList of all registry entries.

dumpRegistry

private static java.lang.String dumpRegistry(ScopedDictionary<?,?> registry)

Renders the registry as text.

Parameters:

registry - ScopedDictionary that keeps track of trigger registrations for this session.

Returns:

The text representation of the registry.

dumpScope

private static java.lang.String dumpScope(java.util.LinkedList<EventList> scope,
                                          java.lang.String descriptor)

Renders the given scope as text.

Parameters:

scope - The scope to dump.

descriptor - The dump descriptor, human-readable

Returns:

The text representation of the given scope.

scopeFinished

private static boolean scopeFinished(java.util.LinkedList<EventList> source,
                                     java.util.LinkedList<EventList> target)

Process a notification that a scope is about to be exited.

All non-persistent triggers registered in the scope are deregistered if current block is not an external procedure.

All persistent triggers registered in this scope are moved to the previous scope.

Parameters:

source - The source event list.

target - The target where the persistent triggers will be merged, may be null

Returns:

true if there were any events in the current scope.

collectRowDisplayEvents

private static void collectRowDisplayEvents(EventList list,
                                            org.roaringbitmap.RoaringBitmap triggers)

Collect trigger IDs for row display events in an event list.

Parameters:

list - The source event list

triggers - The output trigger ID bitmap