jadex.bridge.service.types.factory

Interface IComponentFactory

All Known Implementing Classes:

BDIAgentFactory, BpmnFactory, MicroAgentFactory

public interface IComponentFactory

A factory is responsible for one or more component types and is capable of loading component models from files as well as instantiating components. The classloader must be part of the loadModel (and other) methods as it represents the context. If file names are fully qualified no context is needed but if shortcut notations are used it is unknown where the file is located.

Method Summary

Methods

Modifier and Type	Method and Description
IFuture<Tuple2<IComponentInstance,IComponentAdapter>>	createComponentInstance(IComponentDescription desc, IComponentAdapterFactory factory, IModelInfo model, String config, Map<String,Object> arguments, IExternalAccess parent, RequiredServiceBinding[] bindings, boolean copy, boolean realtime, IIntermediateResultListener<Tuple2<String,Object>> resultlistener, Future<Void> init) Create a component instance.
IFuture<String>	getComponentType(String model, String[] imports, IResourceIdentifier rid) Get the component type of a model.
IFuture<byte[]>	getComponentTypeIcon(String type) Get a default icon for a component type.
String[]	getComponentTypes() Get the names of component types supported by this factory.
Map<String,Object>	getProperties(String type) Get the properties (name/value pairs).
IFuture<Boolean>	isLoadable(String model, String[] imports, IResourceIdentifier rid) Test if a model can be loaded by the factory.
IFuture<Boolean>	isStartable(String model, String[] imports, IResourceIdentifier rid) Test if a model is startable (e.g. an component).
IFuture<IModelInfo>	loadModel(String model, String[] imports, IResourceIdentifier rid) Load a model.

Method Detail

getComponentTypeIcon

IFuture<byte[]> getComponentTypeIcon(String type)

Get a default icon for a component type.

getComponentTypes

String[] getComponentTypes()

Get the names of component types supported by this factory.

loadModel

IFuture<IModelInfo> loadModel(String model,
                            String[] imports,
                            IResourceIdentifier rid)

Load a model.

Parameters:

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

The - imports (if any).

Returns:

The loaded model.

isLoadable

IFuture<Boolean> isLoadable(String model,
                          String[] imports,
                          IResourceIdentifier rid)

Test if a model can be loaded by the factory.

Parameters:

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

The - imports (if any).

Returns:

True, if model can be loaded.

isStartable

IFuture<Boolean> isStartable(String model,
                           String[] imports,
                           IResourceIdentifier rid)

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

Parameters:

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

The - imports (if any).

Returns:

True, if startable (and loadable).

getComponentType

IFuture<String> getComponentType(String model,
                               String[] imports,
                               IResourceIdentifier rid)

Get the component type of a model.

Parameters:

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

The - imports (if any).

getProperties

Map<String,Object> getProperties(String type)

Get the properties (name/value pairs). Arbitrary properties that can e.g. be used to define kernel-specific settings to configure tools.

Parameters:

type - The component type.

Returns:

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

createComponentInstance

IFuture<Tuple2<IComponentInstance,IComponentAdapter>> createComponentInstance(IComponentDescription desc,
                                                                            IComponentAdapterFactory factory,
                                                                            IModelInfo model,
                                                                            String config,
                                                                            Map<String,Object> arguments,
                                                                            IExternalAccess parent,
                                                                            RequiredServiceBinding[] bindings,
                                                                            boolean copy,
                                                                            boolean realtime,
                                                                            IIntermediateResultListener<Tuple2<String,Object>> resultlistener,
                                                                            Future<Void> init)

Create a component instance.

Parameters:

factory - The component adapter factory.

model - The component model.

config - The name of the configuration (or null for default configuration)

arguments - The arguments for the component as name/value pairs.

parent - The parent component (if any).

Returns:

An instance of a component and the corresponding adapter.