jadex.bdi

Class BDIAgentFactory

java.lang.Object

jadex.bdi.BDIAgentFactory

All Implemented Interfaces:

IDynamicBDIFactory, IComponentFactory

public class BDIAgentFactory
extends Object
implements IDynamicBDIFactory, IComponentFactory

Factory for creating Jadex V2 BDI agents.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILETYPE_BDIAGENT The BDI agent file type.
static String	FILETYPE_BDICAPABILITY The BDI capability file type.

Constructor Summary

Constructors

Constructor and Description
BDIAgentFactory(Map props) Create a new agent factory.
BDIAgentFactory(Map props, IInternalAccess component) Create a new agent factory.

Method Summary

Methods

Modifier and Type	Method and Description
IMECapability	createAgentModel(String name, String pkg, String[] imports) Create a new agent model, which can be manually edited before starting.
IFuture<Tuple2<IComponentInstance,IComponentAdapter>>	createComponentInstance(IComponentDescription desc, IComponentAdapterFactory factory, IModelInfo modelinfo, String config, Map arguments, IExternalAccess parent, RequiredServiceBinding[] bindings, boolean copy, Future<Tuple2<IComponentInstance,IComponentAdapter>> ret) Create a component instance.
Tuple2<IComponentInstance,IComponentAdapter>	createComponentInstance(IComponentDescription desc, IComponentAdapterFactory factory, OAVAgentModel amodel, String config, Map arguments, IExternalAccess parent, RequiredServiceBinding[] bindings, boolean copy, Future<Tuple2<IComponentInstance,IComponentAdapter>> ret) Create a component instance.
IFuture<String>	getComponentType(String model, String[] imports, ClassLoader classloader) Get the component type of a model.
IFuture<Icon>	getComponentTypeIcon(String type) Get a default icon for a file type.
String[]	getComponentTypes() Get the names of ADF file types supported by this factory.
Map	getProperties(String type) Get the properties.
IFuture<Boolean>	isLoadable(String model, String[] imports, ClassLoader classloader) Test if a model can be loaded by the factory.
IFuture<Boolean>	isStartable(String model, String[] imports, ClassLoader classloader) Test if a model is startable (e.g. an component).
IFuture<IModelInfo>	loadModel(String filename, String[] imports, ClassLoader classloader) Load a model.
IModelInfo	registerAgentModel(IMECapability model, String filename) Register a manually edited agent model in the factory.
IFuture	shutdownService() Shutdown the service.
IFuture	startService() Start the service.

Methods inherited from class java.lang.Object

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

Field Detail

FILETYPE_BDIAGENT

public static final String FILETYPE_BDIAGENT

The BDI agent file type.

See Also:

Constant Field Values

FILETYPE_BDICAPABILITY

public static final String FILETYPE_BDICAPABILITY

The BDI capability file type.

See Also:

Constant Field Values

Constructor Detail

BDIAgentFactory

public BDIAgentFactory(Map props,
               IInternalAccess component)

Create a new agent factory.

BDIAgentFactory

public BDIAgentFactory(Map props)

Create a new agent factory.

Method Detail

startService

public IFuture startService()

Start the service.

shutdownService

public IFuture shutdownService()

Shutdown the service.

Parameters:

listener - The listener.

createComponentInstance

public IFuture<Tuple2<IComponentInstance,IComponentAdapter>> createComponentInstance(IComponentDescription desc,
                                                                            IComponentAdapterFactory factory,
                                                                            IModelInfo modelinfo,
                                                                            String config,
                                                                            Map arguments,
                                                                            IExternalAccess parent,
                                                                            RequiredServiceBinding[] bindings,
                                                                            boolean copy,
                                                                            Future<Tuple2<IComponentInstance,IComponentAdapter>> ret)

Create a component instance.

Specified by:

createComponentInstance in interface IComponentFactory

Parameters:

adapter - The component adapter.

model - The component model.

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

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

parent - The parent component (if any).

Returns:

An instance of a component.

createComponentInstance

public Tuple2<IComponentInstance,IComponentAdapter> createComponentInstance(IComponentDescription desc,
                                                                   IComponentAdapterFactory factory,
                                                                   OAVAgentModel amodel,
                                                                   String config,
                                                                   Map arguments,
                                                                   IExternalAccess parent,
                                                                   RequiredServiceBinding[] bindings,
                                                                   boolean copy,
                                                                   Future<Tuple2<IComponentInstance,IComponentAdapter>> ret)

Create a component instance.

Parameters:

adapter - The component adapter.

model - The component model.

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

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

parent - The parent component (if any).

Returns:

An instance of a component.

loadModel

public IFuture<IModelInfo> loadModel(String filename,
                            String[] imports,
                            ClassLoader classloader)

Load a model.

Specified by:

loadModel in interface IComponentFactory

Parameters:

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

The - imports (if any).

Returns:

The loaded model.

isLoadable

public IFuture<Boolean> isLoadable(String model,
                          String[] imports,
                          ClassLoader classloader)

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<Boolean> isStartable(String model,
                           String[] imports,
                           ClassLoader classloader)

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 String[] getComponentTypes()

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

Specified by:

getComponentTypes in interface IComponentFactory

getComponentTypeIcon

public IFuture<Icon> getComponentTypeIcon(String type)

Get a default icon for a file type.

Specified by:

getComponentTypeIcon in interface IComponentFactory

getComponentType

public IFuture<String> getComponentType(String model,
                               String[] imports,
                               ClassLoader classloader)

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 Map getProperties(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.

createAgentModel

public IMECapability createAgentModel(String name,
                             String pkg,
                             String[] imports)

Create a new agent model, which can be manually edited before starting.

Specified by:

createAgentModel in interface IDynamicBDIFactory

Parameters:

name - A type name for the agent model.

pkg - Optional package for the model.

imports - Optional imports for the model.

registerAgentModel

public IModelInfo registerAgentModel(IMECapability model,
                            String filename)

Register a manually edited agent model in the factory.

Specified by:

registerAgentModel in interface IDynamicBDIFactory

Parameters:

model - The edited agent model.

filename - The filename for accessing the model.

Returns:

The startable agent model.