jadex.bpmn

Class BpmnFactory

java.lang.Object

jadex.bridge.service.BasicService

jadex.bpmn.BpmnFactory

All Implemented Interfaces:

IInternalService, IService, IComponentFactory

public class BpmnFactory
extends BasicService
implements IComponentFactory

Factory for loading bpmn processes.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Collection<IComponentFeatureFactory>	BPMN_FEATURES
protected java.util.Collection<IComponentFeatureFactory>	features The standard + micro component features.
static java.lang.String	FILETYPE_BPMNLEGACYPROCESS The bpmn legacy process file type.
static java.lang.String	FILETYPE_BPMNPROCESS The bpmn process file type.
static java.lang.String[]	FILETYPES The supported component types (file extensions).
protected java.util.Map<java.lang.String,java.lang.Object>	fproperties The properties.
protected static LazyResource	ICON The image icon.
protected ILibraryService	libservice The library service.
protected ILibraryServiceListener	libservicelistener The library service listener
protected BpmnModelLoader	loader The model loader
protected IInternalAccess	provider The provider.

Fields inherited from class jadex.bridge.service.BasicService

idcnt, impltype, internalaccess, providerid, shutdowned, sid, started, type

Fields inherited from interface jadex.bridge.service.IService

EMPTY_SERVICES

Constructor Summary

Constructors

Constructor and Description
BpmnFactory(IInternalAccess provider, java.util.Map<java.lang.String,java.lang.Object> properties) Create a new BpmnProcessService.
BpmnFactory(java.lang.String providerid) Create a new factory for startup.

Method Summary

Modifier and Type	Method and Description
IFuture<java.util.Collection<IComponentFeatureFactory>>	getComponentFeatures(IModelInfo model) Get the component features for a model.
IFuture<java.lang.String>	getComponentType(java.lang.String model, java.lang.String[] imports, IResourceIdentifier rid) Get the component type of a model.
IFuture<byte[]>	getComponentTypeIcon(java.lang.String type) Get a default icon for a file type.
java.lang.String[]	getComponentTypes() Get the names of ADF file types supported by this factory.
java.util.Map<java.lang.String,java.lang.Object>	getProperties(java.lang.String type) Get the properties.
IFuture<java.lang.Boolean>	isLoadable(java.lang.String model, java.lang.String[] imports, IResourceIdentifier rid) Test if a model can be loaded by the factory.
IFuture<java.lang.Boolean>	isStartable(java.lang.String model, java.lang.String[] imports, IResourceIdentifier rid) Test if a model is startable (e.g.
IFuture<IModelInfo>	loadModel(java.lang.String model, java.lang.String[] imports, IResourceIdentifier rid) Load a model.
IFuture<java.lang.Void>	shutdownService() Shutdown the service.
IFuture<java.lang.Void>	startService() Start the service.
IFuture<java.lang.Void>	startService(IInternalAccess component, IResourceIdentifier rid) Start the service.

Methods inherited from class jadex.bridge.service.BasicService

createServiceIdentifier, createServiceIdentifier, equals, generateServiceName, getInterfaceType, getInternalAccess, getMethodTimeout, getPropertyMap, getProviderId, getServiceIdentifier, hashCode, initNFProperties, isValid, setComponentAccess, setPropertyMap, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FILETYPES

public static final java.lang.String[] FILETYPES

The supported component types (file extensions). Convention used by platform config panel.

FILETYPE_BPMNPROCESS

public static final java.lang.String FILETYPE_BPMNPROCESS

The bpmn process file type.

See Also:

Constant Field Values

FILETYPE_BPMNLEGACYPROCESS

public static final java.lang.String FILETYPE_BPMNLEGACYPROCESS

The bpmn legacy process file type.

See Also:

Constant Field Values

ICON

protected static final LazyResource ICON

The image icon.

BPMN_FEATURES

public static final java.util.Collection<IComponentFeatureFactory> BPMN_FEATURES

provider

protected IInternalAccess provider

The provider.

loader

protected BpmnModelLoader loader

The model loader

libservice

protected ILibraryService libservice

The library service.

libservicelistener

protected ILibraryServiceListener libservicelistener

The library service listener

fproperties

protected java.util.Map<java.lang.String,java.lang.Object> fproperties

The properties.

features

protected java.util.Collection<IComponentFeatureFactory> features

The standard + micro component features.

Constructor Detail

BpmnFactory

public BpmnFactory(java.lang.String providerid)

Create a new factory for startup.

Parameters:

platform - The platform.

BpmnFactory

public BpmnFactory(IInternalAccess provider,
                   java.util.Map<java.lang.String,java.lang.Object> properties)

Create a new BpmnProcessService.

Method Detail

startService

public IFuture<java.lang.Void> startService(IInternalAccess component,
                                            IResourceIdentifier rid)

Start the service.

startService

public IFuture<java.lang.Void> startService()

Start the service.

Specified by:

startService in interface IInternalService

Overrides:

startService in class BasicService

Returns:

A future that is done when the service has completed starting.

shutdownService

public IFuture<java.lang.Void> shutdownService()

Shutdown the service.

Specified by:

shutdownService in interface IInternalService

Overrides:

shutdownService in class BasicService

Parameters:

listener - The listener.

Returns:

A future that is done when the service has completed its shutdown.

loadModel

public IFuture<IModelInfo> loadModel(java.lang.String model,
                                     java.lang.String[] imports,
                                     IResourceIdentifier rid)

Load a model.

Specified by:

loadModel in interface IComponentFactory

Parameters:

model - The model (e.g. file name).

The - imports (if any).

Returns:

The loaded model.

isLoadable

public IFuture<java.lang.Boolean> isLoadable(java.lang.String model,
                                             java.lang.String[] imports,
                                             IResourceIdentifier rid)

Test if a model can be loaded by the factory.

Specified by:

isLoadable in interface IComponentFactory

Parameters:

model - The model (e.g. file name).

The - imports (if any).

Returns:

True, if model can be loaded.

isStartable

public IFuture<java.lang.Boolean> isStartable(java.lang.String model,
                                              java.lang.String[] imports,
                                              IResourceIdentifier rid)

Test if a model is startable (e.g. an component).

Specified by:

isStartable in interface IComponentFactory

Parameters:

model - The model (e.g. file name).

The - imports (if any).

Returns:

True, if startable (and loadable).

getComponentTypes

public java.lang.String[] getComponentTypes()

Get the names of ADF file types supported by this factory.

Specified by:

getComponentTypes in interface IComponentFactory

getComponentTypeIcon

public IFuture<byte[]> getComponentTypeIcon(java.lang.String type)

Get a default icon for a file type.

Specified by:

getComponentTypeIcon in interface IComponentFactory

getComponentType

public IFuture<java.lang.String> getComponentType(java.lang.String model,
                                                  java.lang.String[] imports,
                                                  IResourceIdentifier rid)

Get the component type of a model.

Specified by:

getComponentType in interface IComponentFactory

Parameters:

model - The model (e.g. file name).

The - imports (if any).

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties(java.lang.String type)

Get the properties. Arbitrary properties that can e.g. be used to define kernel-specific settings to configure tools.

Specified by:

getProperties in interface IComponentFactory

Parameters:

type - The component type.

Returns:

The properties or null, if the component type is not supported by this factory.

getComponentFeatures

public IFuture<java.util.Collection<IComponentFeatureFactory>> getComponentFeatures(IModelInfo model)

Get the component features for a model.

Specified by:

getComponentFeatures in interface IComponentFactory

Parameters:

model - The component model.

Returns:

The component features.