org.oddjob.events

Class ListSource<T>

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.extend.BasePrimary

org.oddjob.events.EventServiceBase<CompositeEvent<T>>

org.oddjob.events.ListSource<T>

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, ArooaContextAware, ArooaSessionAware, Outbound<CompositeEvent<T>>, PropertyChangeNotifier, Iconic, LogEnabled, Resettable, Stateful, Stoppable, Structural

public class ListSource<T>
extends EventServiceBase<CompositeEvent<T>>
implements java.io.Serializable, Structural

Description

An event source that aggregates a list of child event sources. The events are aggregated according to the provided EventOperator which defaults to AllEvents.

Example

Trigger on a list of state expressions.

<oddjob>
    <job>
        <sequential>
            <jobs>
                <events:when id="when" xmlns:events="oddjob:events">
                    <jobs>
                        <events:list>
                            <of>
                                <events:watch name="Is Job 1 Complete">
                                    <eventSource>
                                        <state:watch xmlns:state="http://rgordon.co.uk/oddjob/state">
                                            job1 is COMPLETE
                                        </state:watch>
                                    </eventSource>
                                </events:watch>
                                <events:watch name="Is Job 2 Complete">
                                    <eventSource>
                                        <state:watch xmlns:state="http://rgordon.co.uk/oddjob/state">
                                            job2 is COMPLETE
                                        </state:watch>
                                    </eventSource>
                                </events:watch>
                            </of>
                        </events:list>
                        <echo id="job3" name="Job 3">
                            It's Done on ${when.trigger}
                        </echo>
                    </jobs>
                </events:when>
                <folder>
                    <jobs>
                        <echo id="job1" name="Job 1">
                            Hello
                        </echo>
                        <echo id="job2" name="Job 2">
                            World
                        </echo>
                    </jobs>
                </folder>
            </jobs>
        </sequential>
    </job>
</oddjob>

See Also:

Serialized Form

Author:

Rob Gordon

Field Summary

Fields

Modifier and Type	Field and Description
protected ChildHelper<java.lang.Object>	childHelper Track changes to children an notify listeners.

Constructor Summary

Constructors

Constructor and Description
ListSource() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addStructuralListener(StructuralListener listener) Add a listener.
protected Restore	doStart(java.util.function.Consumer<? super CompositeEvent<T>> consumer)
EventOperator<T>	getEventOperator()
CompositeEvent<T>	getLast()
protected void	onHardReset() Allow sub classes to do something on a hard reset.
protected void	onSoftReset() Allow subclasses to do something on a soft reset.
void	removeStructuralListener(StructuralListener listener) Remove a listener.
void	setEventOperator(EventOperator<T> eventOperator)
void	setOf(int index, java.lang.Object child)

Methods inherited from class org.oddjob.events.EventServiceBase

fireDestroyedState, getStateChanger, hardReset, iconHelper, onReset, run, setStateException, setTo, softReset, stateHandler, stop

Methods inherited from class org.oddjob.framework.extend.BasePrimary

configure, getName, logger, logger, loggerName, save, setName, toString

Methods inherited from class org.oddjob.framework.extend.BaseComponent

addIconListener, addPropertyChangeListener, addStateListener, configure, destroy, firePropertyChange, getArooaSession, iconForId, initialise, lastStateEvent, onConfigured, onDestroy, onInitialised, removeIconListener, removePropertyChangeListener, removeStateListener, save, setArooaContext, setArooaSession

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.oddjob.Stateful

addStateListener, lastStateEvent, removeStateListener

Field Detail

childHelper

protected transient volatile ChildHelper<java.lang.Object> childHelper

Track changes to children an notify listeners.

Constructor Detail

ListSource

public ListSource()

Constructor.

Method Detail

doStart

protected Restore doStart(java.util.function.Consumer<? super CompositeEvent<T>> consumer)

Specified by:

doStart in class EventServiceBase<CompositeEvent<T>>

addStructuralListener

public void addStructuralListener(StructuralListener listener)

Add a listener. The listener will immediately receive add notifications for all existing children.

Specified by:

addStructuralListener in interface Structural

Parameters:

listener - The listener.

removeStructuralListener

public void removeStructuralListener(StructuralListener listener)

Remove a listener.

Specified by:

removeStructuralListener in interface Structural

Parameters:

listener - The listener.

onSoftReset

protected void onSoftReset()

Description copied from class: EventServiceBase

Allow subclasses to do something on a soft reset. Defaults to EventServiceBase.onReset()

Overrides:

onSoftReset in class EventServiceBase<CompositeEvent<T>>

onHardReset

protected void onHardReset()

Description copied from class: EventServiceBase

Allow sub classes to do something on a hard reset. Defaults to EventServiceBase.onReset()

Overrides:

onHardReset in class EventServiceBase<CompositeEvent<T>>

setOf

public void setOf(int index,
                  java.lang.Object child)

Property: of

Description: The event sources to combine.

Required: No, but pointless without.

getEventOperator

public EventOperator<T> getEventOperator()

setEventOperator

public void setEventOperator(EventOperator<T> eventOperator)

getLast

public CompositeEvent<T> getLast()