oracle.adf.model.binding.events

Class EventDispatcherImpl

java.lang.Object

oracle.adf.model.events.AbstractEventDispatcher

oracle.adf.model.binding.events.EventDispatcherImpl

All Implemented Interfaces:

EventDispatcher

public class EventDispatcherImpl
extends AbstractEventDispatcher

A EventDispatcherImpl implements EventDispatcher interface This class helps in dispatching the event.

See Also:

EventDispatcher

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	bDebugMode
static java.lang.String	CONSUMER_DEF
static java.lang.String	CONSUMER_OBJECT
static java.lang.String	DOT_SEP
static java.lang.String	EVENT_DEF
static java.lang.String	EVENT_OBJECT
protected DCBindingContainer	mBndContainer
static java.lang.String	PAYLOAD
static java.lang.String	PRODUCER_NAME

Constructor Summary

Constructors

Constructor and Description
EventDispatcherImpl(DCBindingContainer container) constructor

Method Summary

Modifier and Type	Method and Description
protected void	_dbg_afterEvent(EventDefinition eventDef, Event eventObject, ConsumerDef consumerDef) For internal debugging purpose only
protected void	_dbg_beforeEvent(Event eventObject, EventDefinition eventDef, java.lang.String qualifiedProducerName) For internal debugging purpose only
void	addDynamicEventSubscription(java.lang.String containerName)
protected EventNameResolver	createNameResolverInstance() createNameResolverInstance Returns a new DefaultEventNameResolver instance if it doesnt exixts
void	dispatchEvent(java.util.ArrayList eventsDefsToHandle, Event eventObject, java.lang.String qualifiedProducerName) dispatchEvent this method starts dispatching the event to the current bindingcontainer and then to its parent
protected void	dispatchEventForCurrentContainer(java.util.ArrayList eventsDefsToHandle, Event eventObject, java.lang.String qualifiedProducerName) dispatchEventForCurrentContainer this method given the event name and producer qualified name retrieves the ProducerDef in the EventMap
protected void	dispatchEventForSubscription(ProducerDef prodDef, EventDefinition eventDef, Event eventObject) dispatchEventForSubscription this method calls dispatchEventToConsumer method
void	dispatchEventForWildCards(java.util.ArrayList eventsDefsToHandle, Event eventObject)
void	dispatchEventFromChildContainer(java.util.ArrayList eventsDefsToHandle, Event eventObject, java.lang.String qualifiedProducerName) dispatchEventFromChildContainer this method dispatches if this container listens to events generated by child containers
protected void	dispatchEventToChildForWildCards(DCBindingContainer regBnd, java.util.ArrayList eventsDefsToHandle, Event eventObject)
protected void	dispatchEventToConsumer(ConsumerDef consumerDef, Event eventObject) dispatchEventToConsumer() gets the consumer from the qualified name and invokes the event
protected void	dispatchEventToParent(java.util.ArrayList eventsDefsToHandle, Event eventObject, java.lang.String qualifiedProducerName)
protected ProducerDef	findMatchingSubscription(EventMapDef eMap, java.lang.String eventName, java.lang.String producerRefName)
protected void	fireEvent(java.util.ArrayList eventDefList, Event eventObject) fireEvent starts propogating the events by constructing the Qualified producer name
void	fireEvent(EventProducer producer, java.lang.Object payLoad) fireEvent starting point for the events to get propogated
void	fireEvent(EventProducer producer, java.lang.Object payLoad, EventDefinition[] eventDefs) fireEvent starting point for the events to get propogated
java.lang.String	getBindingContainerDefName() Deprecated. Only for internal debug purpose.
java.util.List<java.lang.String>	getDynamicEventSubscriptionList()
EventNameResolver	getEventNameResolver() getEventNameResolver Returns the EventNameResolver which this EventDispatcherImpl has
EventConsumer	getRegisteredEventConsumer(java.lang.String consumerName) getRegisteredEventConsumer used to get any consumer which is registered with EventHandler
boolean	hasDynamicEventSubscription(java.lang.String name)
protected void	invokeEvent(EventConsumer consumer, Event eventObject, java.util.HashMap consumerParamMap) invokeEvent passes on the control to the consumer to handle the event.
void	processContextualEvents() processContextualEvents used to propagate queued events
protected void	processContextualEventsToChildContainers(DCBindingContainer regBnd)
void	queueEvent(EventProducer producer, java.lang.Object payLoad) queueEvent queues up the event to be invoked
void	registerEventConsumer(EventConsumer consumer) registerEventConsumer used to register any consumer with EventHandler
BindingContext	retrieveBindingContext(DCBindingContainer container)
void	setEventNameResolver(EventNameResolver eventNameResolver) setEventNameResolver sets the EventNameResolver to this EventDispatcherImpl
void	unRegisterEventConsumer(EventConsumer consumer) unRegisterEventConsumer used to unregister any consumer with EventHandler

Methods inherited from class java.lang.Object

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

Field Detail

DOT_SEP

public static final java.lang.String DOT_SEP

See Also:

Constant Field Values

PAYLOAD

public static final java.lang.String PAYLOAD

See Also:

Constant Field Values

PRODUCER_NAME

public static final java.lang.String PRODUCER_NAME

See Also:

Constant Field Values

EVENT_OBJECT

public static final java.lang.String EVENT_OBJECT

See Also:

Constant Field Values

EVENT_DEF

public static final java.lang.String EVENT_DEF

See Also:

Constant Field Values

CONSUMER_DEF

public static final java.lang.String CONSUMER_DEF

See Also:

Constant Field Values

CONSUMER_OBJECT

public static final java.lang.String CONSUMER_OBJECT

See Also:

Constant Field Values

bDebugMode

public static final boolean bDebugMode

mBndContainer

protected final DCBindingContainer mBndContainer

Constructor Detail

EventDispatcherImpl

public EventDispatcherImpl(DCBindingContainer container)

constructor

Parameters:

container - DCBindingContainer

Method Detail

getBindingContainerDefName

@Deprecated
public java.lang.String getBindingContainerDefName()

Deprecated. Only for internal debug purpose.

Returns the fully qualified name of the binding container definition (package.id)

createNameResolverInstance

protected EventNameResolver createNameResolverInstance()

createNameResolverInstance Returns a new DefaultEventNameResolver instance if it doesnt exixts

getEventNameResolver

public EventNameResolver getEventNameResolver()

getEventNameResolver Returns the EventNameResolver which this EventDispatcherImpl has

setEventNameResolver

public void setEventNameResolver(EventNameResolver eventNameResolver)

setEventNameResolver sets the EventNameResolver to this EventDispatcherImpl

Parameters:

eventNameResolver - EventNameResolver

fireEvent

public void fireEvent(EventProducer producer,
                      java.lang.Object payLoad)

fireEvent starting point for the events to get propogated

Parameters:

producer - EventProducer

payLoad - Object

fireEvent

public void fireEvent(EventProducer producer,
                      java.lang.Object payLoad,
                      EventDefinition[] eventDefs)

fireEvent starting point for the events to get propogated

Parameters:

producer - EventProducer

payLoad - Object Payload

eventDefs - EventDefinition array

fireEvent

protected void fireEvent(java.util.ArrayList eventDefList,
                         Event eventObject)

fireEvent starts propogating the events by constructing the Qualified producer name

Parameters:

eventDefList - ArrayList

eventObject - Event

dispatchEvent

public void dispatchEvent(java.util.ArrayList eventsDefsToHandle,
                          Event eventObject,
                          java.lang.String qualifiedProducerName)

dispatchEvent this method starts dispatching the event to the current bindingcontainer and then to its parent

Parameters:

eventsDefsToHandle - ArrayList list of eventDef's to be handled

eventObject - Event Object

qualifiedProducerName - String has the qualified name of the Producer

dispatchEventToParent

protected void dispatchEventToParent(java.util.ArrayList eventsDefsToHandle,
                                     Event eventObject,
                                     java.lang.String qualifiedProducerName)

dispatchEventFromChildContainer

public void dispatchEventFromChildContainer(java.util.ArrayList eventsDefsToHandle,
                                            Event eventObject,
                                            java.lang.String qualifiedProducerName)

dispatchEventFromChildContainer this method dispatches if this container listens to events generated by child containers

Parameters:

eventsDefsToHandle - ArrayList list of eventDef's to be handled

eventObject - Event Object

qualifiedProducerName - String has the qualified name of the Producer

_dbg_beforeEvent

protected void _dbg_beforeEvent(Event eventObject,
                                EventDefinition eventDef,
                                java.lang.String qualifiedProducerName)

For internal debugging purpose only

_dbg_afterEvent

protected void _dbg_afterEvent(EventDefinition eventDef,
                               Event eventObject,
                               ConsumerDef consumerDef)

For internal debugging purpose only

dispatchEventForCurrentContainer

protected void dispatchEventForCurrentContainer(java.util.ArrayList eventsDefsToHandle,
                                                Event eventObject,
                                                java.lang.String qualifiedProducerName)

dispatchEventForCurrentContainer this method given the event name and producer qualified name retrieves the ProducerDef in the EventMap

Parameters:

eventsDefsToHandle - ArrayList list of eventDef's to be handled

eventObject - Event Object

qualifiedProducerName - String has the qualified name of the Producer

dispatchEventForWildCards

public void dispatchEventForWildCards(java.util.ArrayList eventsDefsToHandle,
                                      Event eventObject)

Specified by:

dispatchEventForWildCards in interface EventDispatcher

Overrides:

dispatchEventForWildCards in class AbstractEventDispatcher

dispatchEventToChildForWildCards

protected void dispatchEventToChildForWildCards(DCBindingContainer regBnd,
                                                java.util.ArrayList eventsDefsToHandle,
                                                Event eventObject)

dispatchEventForSubscription

protected void dispatchEventForSubscription(ProducerDef prodDef,
                                            EventDefinition eventDef,
                                            Event eventObject)

dispatchEventForSubscription this method calls dispatchEventToConsumer method

Parameters:

prodDef - ProducerDef producer of the event

eventDef - EventDefinition event which is beging produced

eventObject - Event Object

dispatchEventToConsumer

protected void dispatchEventToConsumer(ConsumerDef consumerDef,
                                       Event eventObject)

dispatchEventToConsumer() gets the consumer from the qualified name and invokes the event

Parameters:

consumerDef - ConsumerDef of this event

eventObject - Event Object

invokeEvent

protected void invokeEvent(EventConsumer consumer,
                           Event eventObject,
                           java.util.HashMap consumerParamMap)

invokeEvent passes on the control to the consumer to handle the event.

Parameters:

consumerParamMap - HashMap parameters of ConsumerDef

findMatchingSubscription

protected ProducerDef findMatchingSubscription(EventMapDef eMap,
                                               java.lang.String eventName,
                                               java.lang.String producerRefName)

retrieveBindingContext

public BindingContext retrieveBindingContext(DCBindingContainer container)

registerEventConsumer

public void registerEventConsumer(EventConsumer consumer)

Description copied from interface: EventDispatcher

registerEventConsumer used to register any consumer with EventHandler

Parameters:

consumer - EventConsumer

unRegisterEventConsumer

public void unRegisterEventConsumer(EventConsumer consumer)

Description copied from interface: EventDispatcher

unRegisterEventConsumer used to unregister any consumer with EventHandler

Parameters:

consumer - EventConsumer

getRegisteredEventConsumer

public EventConsumer getRegisteredEventConsumer(java.lang.String consumerName)

Description copied from interface: EventDispatcher

getRegisteredEventConsumer used to get any consumer which is registered with EventHandler

Parameters:

consumerName - String

queueEvent

public void queueEvent(EventProducer producer,
                       java.lang.Object payLoad)

queueEvent queues up the event to be invoked

Specified by:

queueEvent in interface EventDispatcher

Overrides:

queueEvent in class AbstractEventDispatcher

Parameters:

producer - EventProducer

payLoad - Object Payload

processContextualEvents

public void processContextualEvents()

processContextualEvents used to propagate queued events

Specified by:

processContextualEvents in interface EventDispatcher

Overrides:

processContextualEvents in class AbstractEventDispatcher

processContextualEventsToChildContainers

protected void processContextualEventsToChildContainers(DCBindingContainer regBnd)

getDynamicEventSubscriptionList

public java.util.List<java.lang.String> getDynamicEventSubscriptionList()

Specified by:

getDynamicEventSubscriptionList in interface EventDispatcher

Overrides:

getDynamicEventSubscriptionList in class AbstractEventDispatcher

addDynamicEventSubscription

public void addDynamicEventSubscription(java.lang.String containerName)

Specified by:

addDynamicEventSubscription in interface EventDispatcher

Overrides:

addDynamicEventSubscription in class AbstractEventDispatcher

hasDynamicEventSubscription

public boolean hasDynamicEventSubscription(java.lang.String name)

Specified by:

hasDynamicEventSubscription in interface EventDispatcher

Overrides:

hasDynamicEventSubscription in class AbstractEventDispatcher