org.oddjob.events

Class ForEvents<T>

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.extend.BasePrimary

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

org.oddjob.events.ForEvents<T>

All Implemented Interfaces:

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

public class ForEvents<T>
extends EventServiceBase<CompositeEvent<T>>
implements Structural, ConfigurationOwner

Description

An Event Source For a variable set of child Event Sources. Required when the list of events to wait for changes dynamically - such as the set of files required to run a job.

Example

Wait for prices to be available to price some fruit trades. This resulted as an experiment in turning Oddjob into a rules engine.

<oddjob id="this">
    <job>
        <sequential>
            <jobs>
                <properties name="Properties">
                    <values>
                        <file file="${some.dir}" key="data.dir"/>
                    </values>
                </properties>
                <bean class="org.oddjob.events.example.FileFactStore" id="factStore" rootDir="${data.dir}"/>
                <events:when id="whenBookList" name="When BookList Available" xmlns:events="oddjob:events">
                    <jobs>
                        <bean class="org.oddjob.events.example.FactSubscriber" factStore="${factStore}" name="Subscribe to BookList" query="BookList:GREENGROCERS"/>
                        <foreach id="forEachBook" name="For Each Book">
                            <values>
                                <value value="${whenBookList.trigger.of.books}"/>
                            </values>
                            <configuration>
                                <inline>
                                    <foreach id="bookName">
                                        <job>
                                            <events:when id="whenBook" name="When ${bookName.current}">
                                                <jobs>
                                                    <bean class="org.oddjob.events.example.FactSubscriber" factStore="${factStore}" name="Subscribe to Book ${bookName.current}" query="Book:${bookName.current}"/>
                                                    <events:when id="priceMatch" name="When Prices for ${bookName.current}">
                                                        <jobs>
                                                            <events:for name="For Each Trade">
                                                                <configuration>
                                                                    <inline>
                                                                        <events id="trade">
                                                                            <job>
                                                                                <bean class="org.oddjob.events.example.FactSubscriber" factStore="${factStore}" name="Subscribe to Price for ${trade.current.product}" query="Price:${trade.current.product}"/>
                                                                            </job>
                                                                        </events>
                                                                    </inline>
                                                                </configuration>
                                                                <values>
                                                                    <value value="${whenBook.trigger.of.trades}"/>
                                                                </values>
                                                            </events:for>
                                                            <sequential name="Run Calculation">
                                                                <jobs>
                                                                    <bean class="org.oddjob.events.example.ValueCalculator" id="calculate">
                                                                        <trades>
                                                                            <value value="${whenBook.trigger.of.trades}"/>
                                                                        </trades>
                                                                        <prices>
                                                                            <value value="${priceMatch.trigger.ofs}"/>
                                                                        </prices>
                                                                    </bean>
                                                                    <echo>Value of ${bookName.current} is ${calculate.value}</echo>
                                                                </jobs>
                                                            </sequential>
                                                        </jobs>
                                                    </events:when>
                                                </jobs>
                                            </events:when>
                                        </job>
                                    </foreach>
                                </inline>
                            </configuration>
                        </foreach>
                    </jobs>
                </events:when>
            </jobs>
        </sequential>
    </job>
</oddjob>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ForEvents.LocalBean This provides a bean for current properties.

Field Summary

Fields

Modifier and Type	Field and Description
protected ChildHelper<java.lang.Object>	childHelper Track changes to children and notify listeners.
static ArooaElement	FOREACH_ELEMENT Root element for configuration.

Constructor Summary

Constructors

Constructor and Description
ForEvents() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addOwnerStateListener(OwnerStateListener listener) Add a listener.
void	addStructuralListener(StructuralListener listener) Add a listener.
Restore	doStart(java.util.function.Consumer<? super CompositeEvent<T>> consumer)
ArooaConfiguration	getConfiguration()
EventOperator<T>	getEventOperator()
java.io.File	getFile()
int	getIndex()
CompositeEvent<T>	getLast()
int	getPurgeAfter()
protected java.lang.Object	loadConfigFor(java.lang.Object value) Load a configuration for a single value.
protected void	onDestroy() Subclasses override this method to clear up resources.
protected void	onReset() Allow sub classes to do something on reset.
protected void	preLoad() Setup and load the first jobs.
ConfigurationSession	provideConfigurationSession() Provide a ConfigurationSession.
void	removeOwnerStateListener(OwnerStateListener listener) Remove a listener.
void	removeStructuralListener(StructuralListener listener) Remove a listener.
SerializableDesignFactory	rootDesignFactory() Get the design factory for the configuration.
ArooaElement	rootElement() Get the root element.
void	setConfiguration(ArooaConfiguration configuration)
void	setEventOperator(EventOperator<T> eventOperator)
void	setFile(java.io.File file)
void	setPurgeAfter(int purgeAfter)
void	setValues(java.util.stream.Stream<?> values) Add a type.

Methods inherited from class org.oddjob.events.EventServiceBase

fireDestroyedState, getStateChanger, hardReset, iconHelper, onHardReset, onSoftReset, 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, 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

FOREACH_ELEMENT

public static final ArooaElement FOREACH_ELEMENT

Root element for configuration.

childHelper

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

Track changes to children and notify listeners.

Constructor Detail

ForEvents

public ForEvents()

Constructor.

Method Detail

setValues

public void setValues(java.util.stream.Stream<?> values)

Add a type. This will be called during parsing by the handler to add a type for each element.

Parameters:

values - The type.

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.

provideConfigurationSession

public ConfigurationSession provideConfigurationSession()

Description copied from interface: ConfigurationOwner

Provide a ConfigurationSession.

Specified by:

provideConfigurationSession in interface ConfigurationOwner

Returns:

A ConfigurationSession. May be null if no session is available.

addOwnerStateListener

public void addOwnerStateListener(OwnerStateListener listener)

Description copied from interface: ConfigurationOwner

Add a listener.

Specified by:

addOwnerStateListener in interface ConfigurationOwner

removeOwnerStateListener

public void removeOwnerStateListener(OwnerStateListener listener)

Description copied from interface: ConfigurationOwner

Remove a listener.

Specified by:

removeOwnerStateListener in interface ConfigurationOwner

rootDesignFactory

public SerializableDesignFactory rootDesignFactory()

Description copied from interface: ConfigurationOwner

Get the design factory for the configuration. If this is null the Oddjob Explorer won't show a DesignInside action.

Note that this is a SerializableDesignFactory so that this interface can be represented remotely.

Specified by:

rootDesignFactory in interface ConfigurationOwner

Returns:

A DesignFactory. Must not be null if a ConfigurationSession is available.

rootElement

public ArooaElement rootElement()

Description copied from interface: ConfigurationOwner

Get the root element.

Specified by:

rootElement in interface ConfigurationOwner

Returns:

The root element of the configuration. Must not be null if a ConfigurationSession is available.

loadConfigFor

protected java.lang.Object loadConfigFor(java.lang.Object value)
                                  throws ArooaParseException

Load a configuration for a single value.

Parameters:

value -

Throws:

ArooaParseException

preLoad

protected void preLoad()
                throws ArooaParseException

Setup and load the first jobs.

if preLoad() is 0 all will be loaded otherwise up to that number will be loaded.

Throws:

ArooaParseException

doStart

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

Specified by:

doStart in class EventServiceBase<CompositeEvent<T>>

getIndex

public int getIndex()

Returns:

Returns the index.

getEventOperator

public EventOperator<T> getEventOperator()

setEventOperator

public void setEventOperator(EventOperator<T> eventOperator)

getLast

public CompositeEvent<T> getLast()

onReset

protected void onReset()

Description copied from class: EventServiceBase

Allow sub classes to do something on reset.

Overrides:

onReset in class EventServiceBase<CompositeEvent<T>>

onDestroy

protected void onDestroy()

Description copied from class: BaseComponent

Subclasses override this method to clear up resources. This is called by the framework before child elements have been destroyed.

Overrides:

onDestroy in class BaseComponent

setFile

public void setFile(java.io.File file)

Property: file

Description: The name of the configuration file. to use for configuration.

Required: No.

getFile

public java.io.File getFile()

getConfiguration

public ArooaConfiguration getConfiguration()

setConfiguration

public void setConfiguration(ArooaConfiguration configuration)

getPurgeAfter

public int getPurgeAfter()

setPurgeAfter

public void setPurgeAfter(int purgeAfter)