Package com.aquima.interactions.flow

Class FlowEngineFactory

java.lang.Object

com.aquima.interactions.flow.FlowEngineFactory

All Implemented Interfaces:

IFlowEngineFactory

public class FlowEngineFactory
extends Object
implements IFlowEngineFactory

Factory class that may be used to create an instance of IFlowEngine.

Since:

5.0

Author:

Jon van Leuven

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROPERTY	This define denotates the key that is used to locate a flow-engine factory implementation.

Constructor Summary

Constructors

Constructor	Description
FlowEngineFactory()

Method Summary

Modifier and Type	Method	Description
IFlowEngine	create(INodeDetailsFactory nodeFactory, IParserFactory parserFactory, IFlowEngineDS datasource)	This method creates a new flow engine using the specified node factory and data source.
static IFlowEngineFactory	getInstance()	Get an instance of IFlowEngineFactory.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY

public static final String PROPERTY

This define denotates the key that is used to locate a flow-engine factory implementation.

See Also:

Constant Field Values

Constructor Detail

FlowEngineFactory

public FlowEngineFactory()

Method Detail

getInstance

public static IFlowEngineFactory getInstance()

Get an instance of IFlowEngineFactory. If there is an implementation register via the ClassFactory (with key 'flowengine-factory'), an instance of this class is returned. Note: keep in mind that the instance returned is kept in a static member, so once this class is loaded always the same instance is returned.

Returns:

IFlowEngineFactory implementation

create

public IFlowEngine create(INodeDetailsFactory nodeFactory,
                          IParserFactory parserFactory,
                          IFlowEngineDS datasource)
                   throws InitializationException

Description copied from interface: IFlowEngineFactory

This method creates a new flow engine using the specified node factory and data source. The node factory is optional, as the default factory will be used when a null value is supplied.

Specified by:

create in interface IFlowEngineFactory

Parameters:

nodeFactory - The node factory that should be used to create nodes.

parserFactory - The expression parser that should be used to parse expressions.

datasource - The data source providing the flow information.

Returns:

Flow engine implementation for the specified data source.

Throws:

InitializationException - This exception is thrown when the flow engine could not be initialised due to a fatal error.