jadex.extension.envsupport.environment

Class AbstractEnvironmentSpace

java.lang.Object

jadex.commons.SimplePropertyObject

jadex.commons.meta.TypedPropertyObject

jadex.extension.envsupport.environment.SynchronizedPropertyObject

jadex.extension.envsupport.environment.AbstractEnvironmentSpace

All Implemented Interfaces:

IExtensionInstance, IPropertyObject, ITypedPropertyObject, IEnvironmentSpace

Direct Known Subclasses:

Space2D, Space3D

public abstract class AbstractEnvironmentSpace
extends SynchronizedPropertyObject
implements IEnvironmentSpace

Abstract base class for environment space.

Constructor Summary

Constructors

Constructor and Description
AbstractEnvironmentSpace() Create an environment space

Method Summary

Modifier and Type	Method and Description
void	addAvatarMappings(AvatarMapping mapping) Adds an avatar mapping.
void	addDataConsumer(String name, ITableDataConsumer consumer) Add a new data consumer.
void	addDataProvider(String name, ITableDataProvider provider) Add a new data provider.
void	addDataView(String name, IDataView view) Adds a view to the space.
void	addDataViewMapping(String objecttype, Map view) Add a mapping from object type to data view
void	addEnvironmentListener(IEnvironmentListener listener) Add an environment listener.
void	addInitialAvatar(IComponentIdentifier ownerid, String type, Map props) Initial settings for the avatar of a specific component.
void	addObjectTaskType(String typename, Class clazz, List properties) Add a object task type.
void	addPerceptGenerator(Object id, IPerceptGenerator gen) Adds a percept generator.
void	addPerceptProcessor(String componenttype, Set percepttypes, IPerceptProcessor proc) Add a percept processor.
void	addPerceptType(PerceptType percepttype) Add a space percept type.
void	addSpaceAction(String id, ISpaceAction action) Adds an space action.
void	addSpaceObjectType(String typename, IPropertyMetaDataSet mobjecttype) Add a space type.
void	addSpaceProcessType(String typename, Class clazz, List properties) Add a space process type.
void	addTaskListener(Object taskid, Object objectid, IResultListener listener) Add a result listener to an object task.
void	cancelSpaceAction(int id) Cancel a queued space action.
void	componentAdded(IComponentDescription owner) Called when an component was added.
void	componentRemoved(IComponentDescription desc) Called when an component was removed.
Object	createObjectTask(String typename, Map properties, Object objectid) Creates an object task.
void	createPercept(String typename, Object data, IComponentDescription comp, ISpaceObject avatar) Create a percept for the given component.
ISpaceObject	createSpaceObject(String typename, Map properties, List tasks) Creates an object in this space.
ISpaceObject	createSpaceObjectZombie(String typename, Map properties, List tasks) Creates a zombie object in this space.
void	createSpaceProcess(String typename, Map properties) Creates a space process.
void	destroySpaceObject(Object id) Destroys an object in this space.
ISpaceObject	getAvatar(IComponentDescription owner) Get the avatar object.
ISpaceObject	getAvatar(IComponentDescription owner, String fullname) Get the avatar object.
ISpaceObject[]	getAvatars(IComponentDescription owner) Get the avatar objects.
ClassLoader	getClassLoader() Get the class loader.
ComponentActionList	getComponentActionList() Get the list of scheduled component actions
IComponentDescription[]	getComponents() Get the avatar objects.
ITableDataConsumer	getDataConsumer(String name) Get a data consumer.
Collection	getDataConsumers() Get the data consumers.
ITableDataProvider	getDataProvider(String name) Get a data provider.
IDataView	getDataView(String name) Gets a specific view.
Map	getDataViews() Get all available dataviews in this space.
IExternalAccess	getExternalAccess() Get the context.
SimpleValueFetcher	getFetcher() Get the value fetcher.
IComponentDescription	getOwner(Object id) Get the owner of an object.
PerceptList	getPerceptList() Get the list of scheduled percepts.
PerceptType	getPerceptType(String percepttype) Get a space percept type.
Collection	getProcesses() Get the processes.
Object	getProperty(String name) Returns a property.
ISpaceAction	getSpaceAction(String id) Adds an space action.
ISpaceObject	getSpaceObject(Object id) Returns an object in this space.
ISpaceObject	getSpaceObject0(Object id) Returns an object in this space.
ISpaceObject[]	getSpaceObjectsByType(String type) Get all space object of a specific type.
Collection	getSpaceObjectsCollection() Get the space objects.
ISpaceProcess	getSpaceProcess(Object id) Returns a space process.
Set	getSpaceProcessNames() Returns then names of the space processes.
Collection	getViews() Get the views.
IFuture<Void>	init() Initialize the extension.
IFuture<Void>	initSpace() Create a space.
void	initSpaceObject(ISpaceObject ret) Creates an object in this space.
Object	performSpaceAction(String id, Map parameters) Performs a space action.
int	performSpaceAction(String id, Map parameters, IResultListener listener) Schedules an space action.
void	removeAvatarMappings(AvatarMapping mapping) Remove an avatar mapping.
void	removeDataView(String name) Removes a view from the space.
void	removeEnvironmentListener(IEnvironmentListener listener) Remove an environment listener.
void	removeObjectTask(Object taskid, Object objectid) Remove an object task.
void	removeObjectTaskType(String typename) Remove an object task type.
void	removePerceptGenerator(Object id) Remove a percept generator.
void	removePerceptProcessor(String componenttype, IPerceptProcessor proc) remove a percept processor.
void	removePerceptType(String typename) Remove a space process type.
void	removeSpaceAction(String id) Removes an space action.
void	removeSpaceObjectType(String typename) Remove a space object type.
void	removeSpaceProcess(Object id) Removes a space process.
void	removeSpaceProcessType(String typename) Remove a space process type.
void	removeTaskListener(Object taskid, Object objectid, IResultListener listener) Remove a result listener from an object task.
void	setFetcher(SimpleValueFetcher fetcher) Set the fetcher.
void	setInitData(IInternalAccess ia, MEnvSpaceInstance config, IValueFetcher pfetcher)
void	setOwner(Object id, IComponentDescription owner) Set the owner of an object.
IFuture<Void>	terminate() Terminate the extension.
IFuture<Void>	waitForTask(Object taskid, Object objectid) Add a result listener to an object task.

Methods inherited from class jadex.extension.envsupport.environment.SynchronizedPropertyObject

addPropertyChangeListener, getMonitor, getPropertyNames, hasProperty, removePropertyChangeListener, setProperty

Methods inherited from class jadex.commons.meta.TypedPropertyObject

getMetaData, getMetaDatas

Methods inherited from class jadex.commons.SimplePropertyObject

getProperties, setProperties, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface jadex.commons.IPropertyObject

getPropertyNames, hasProperty, setProperty

Constructor Detail

AbstractEnvironmentSpace

public AbstractEnvironmentSpace()

Create an environment space

Method Detail

setInitData

public void setInitData(IInternalAccess ia,
                        MEnvSpaceInstance config,
                        IValueFetcher pfetcher)

initSpace

public IFuture<Void> initSpace()

Create a space.

addSpaceObjectType

public void addSpaceObjectType(String typename,
                               IPropertyMetaDataSet mobjecttype)

Add a space type.

Specified by:

addSpaceObjectType in interface IEnvironmentSpace

Parameters:

typename - The type name.

initproperties - The MobjectType.

removeSpaceObjectType

public void removeSpaceObjectType(String typename)

Remove a space object type.

Specified by:

removeSpaceObjectType in interface IEnvironmentSpace

Parameters:

typename - The type name.

addSpaceProcessType

public void addSpaceProcessType(String typename,
                                Class clazz,
                                List properties)

Add a space process type.

Specified by:

addSpaceProcessType in interface IEnvironmentSpace

Parameters:

typename - The type name.

properties - The properties.

removeSpaceProcessType

public void removeSpaceProcessType(String typename)

Remove a space process type.

Specified by:

removeSpaceProcessType in interface IEnvironmentSpace

Parameters:

typename - The type name.

createSpaceProcess

public void createSpaceProcess(String typename,
                               Map properties)

Creates a space process.

Specified by:

createSpaceProcess in interface IEnvironmentSpace

Parameters:

typename - The type name.

properties - The properties.

addObjectTaskType

public void addObjectTaskType(String typename,
                              Class clazz,
                              List properties)

Add a object task type.

Specified by:

addObjectTaskType in interface IEnvironmentSpace

Parameters:

typename - The type name.

properties - The properties.

removeObjectTaskType

public void removeObjectTaskType(String typename)

Remove an object task type.

Specified by:

removeObjectTaskType in interface IEnvironmentSpace

Parameters:

typename - The type name.

createObjectTask

public Object createObjectTask(String typename,
                               Map properties,
                               Object objectid)

Creates an object task.

Specified by:

createObjectTask in interface IEnvironmentSpace

Parameters:

typename - The type name.

properties - The properties.

Returns:

The task id.

removeObjectTask

public void removeObjectTask(Object taskid,
                             Object objectid)

Remove an object task.

Specified by:

removeObjectTask in interface IEnvironmentSpace

Parameters:

typename - The type name.

initproperties - The properties.

addTaskListener

public void addTaskListener(Object taskid,
                            Object objectid,
                            IResultListener listener)

Add a result listener to an object task. The listener result will be the task id. If the task is already finished, the listener will be notified.

Specified by:

addTaskListener in interface IEnvironmentSpace

removeTaskListener

public void removeTaskListener(Object taskid,
                               Object objectid,
                               IResultListener listener)

Remove a result listener from an object task.

Specified by:

removeTaskListener in interface IEnvironmentSpace

waitForTask

public IFuture<Void> waitForTask(Object taskid,
                                 Object objectid)

Add a result listener to an object task. The listener result will be the task id. If the task is already finished, the listener will be notified.

Specified by:

waitForTask in interface IEnvironmentSpace

getSpaceProcessNames

public Set getSpaceProcessNames()

Returns then names of the space processes.

Returns:

the names of the space processes

getSpaceProcess

public ISpaceProcess getSpaceProcess(Object id)

Returns a space process.

Specified by:

getSpaceProcess in interface IEnvironmentSpace

Parameters:

id - ID of the space process

Returns:

the space process or null if not found

removeSpaceProcess

public void removeSpaceProcess(Object id)

Removes a space process.

Specified by:

removeSpaceProcess in interface IEnvironmentSpace

Parameters:

id - ID of the space process

createSpaceObject

public final ISpaceObject createSpaceObject(String typename,
                                            Map properties,
                                            List tasks)

Creates an object in this space.

Specified by:

createSpaceObject in interface IEnvironmentSpace

Parameters:

type - the object's type

properties - initial properties (may be null)

tasks - initial task list (may be null)

Returns:

the object's ID

createSpaceObjectZombie

public ISpaceObject createSpaceObjectZombie(String typename,
                                            Map properties,
                                            List tasks)

Creates a zombie object in this space. Zombies are not (yet) visible in the space and must be inited separately.

Parameters:

type - the object's type

properties - initial properties (may be null)

tasks - initial task list (may be null)

Returns:

the object's ID

initSpaceObject

public void initSpaceObject(ISpaceObject ret)

Creates an object in this space.

Parameters:

type - the object's type

initproperties - initial properties (may be null)

tasks - initial task list (may be null)

listeners - initial listeners (may be null)

destroySpaceObject

public void destroySpaceObject(Object id)

Destroys an object in this space.

Specified by:

destroySpaceObject in interface IEnvironmentSpace

Parameters:

id - the object's ID

getSpaceObject

public ISpaceObject getSpaceObject(Object id)

Returns an object in this space.

Specified by:

getSpaceObject in interface IEnvironmentSpace

Parameters:

id - the object's ID

Returns:

the object in this space

getSpaceObject0

public ISpaceObject getSpaceObject0(Object id)

Returns an object in this space.

Parameters:

id - the object's ID

Returns:

the object in this space

getSpaceObjectsByType

public ISpaceObject[] getSpaceObjectsByType(String type)

Get all space object of a specific type.

Specified by:

getSpaceObjectsByType in interface IEnvironmentSpace

Parameters:

type - The space object type.

Returns:

The space objects of the desired type.

addAvatarMappings

public void addAvatarMappings(AvatarMapping mapping)

Adds an avatar mapping.

Parameters:

componenttype - The component type.

objecttype - The object type to represent the component.

removeAvatarMappings

public void removeAvatarMappings(AvatarMapping mapping)

Remove an avatar mapping.

Parameters:

componenttype - The component type.

objecttype - The object type to represent the component.

addSpaceAction

public void addSpaceAction(String id,
                           ISpaceAction action)

Adds an space action.

Specified by:

addSpaceAction in interface IEnvironmentSpace

Parameters:

actionId - the action ID

action - the action

getSpaceAction

public ISpaceAction getSpaceAction(String id)

Adds an space action.

Parameters:

actionId - the action ID

action - the action

removeSpaceAction

public void removeSpaceAction(String id)

Removes an space action.

Specified by:

removeSpaceAction in interface IEnvironmentSpace

Parameters:

actionId - the action ID

performSpaceAction

public int performSpaceAction(String id,
                              Map parameters,
                              IResultListener listener)

Schedules an space action.

Specified by:

performSpaceAction in interface IEnvironmentSpace

Parameters:

id - Id of the action

parameters - parameters for the action (may be null)

listener - the result listener

Returns:

The id of the action instance for later access.

cancelSpaceAction

public void cancelSpaceAction(int id)

Cancel a queued space action.

Specified by:

cancelSpaceAction in interface IEnvironmentSpace

performSpaceAction

public Object performSpaceAction(String id,
                                 Map parameters)

Performs a space action.

Parameters:

id - Id of the action

parameters - parameters for the action (may be null)

Returns:

return value of the action

createPercept

public void createPercept(String typename,
                          Object data,
                          IComponentDescription comp,
                          ISpaceObject avatar)

Create a percept for the given component.

Parameters:

typename - The percept type.

data - The content of the percept (if any).

cid - The component that should receive the percept.

getOwner

public IComponentDescription getOwner(Object id)

Get the owner of an object.

Parameters:

id - The id.

Returns:

The owner.

setOwner

public void setOwner(Object id,
                     IComponentDescription owner)

Set the owner of an object.

Specified by:

setOwner in interface IEnvironmentSpace

Parameters:

id - The object id.

pos - The object owner.

getAvatars

public ISpaceObject[] getAvatars(IComponentDescription owner)

Get the avatar objects.

Specified by:

getAvatars in interface IEnvironmentSpace

Returns:

The avatar objects.

getComponents

public IComponentDescription[] getComponents()

Get the avatar objects.

Returns:

The avatar objects.

getAvatar

public ISpaceObject getAvatar(IComponentDescription owner)

Get the avatar object.

Specified by:

getAvatar in interface IEnvironmentSpace

Returns:

The avatar object.

getAvatar

public ISpaceObject getAvatar(IComponentDescription owner,
                              String fullname)

Get the avatar object.

Returns:

The avatar object.

addDataView

public void addDataView(String name,
                        IDataView view)

Adds a view to the space.

Specified by:

addDataView in interface IEnvironmentSpace

Parameters:

name - name of the view

view - the view

removeDataView

public void removeDataView(String name)

Removes a view from the space.

Specified by:

removeDataView in interface IEnvironmentSpace

Parameters:

name - name of the view

getDataView

public IDataView getDataView(String name)

Gets a specific view.

Specified by:

getDataView in interface IEnvironmentSpace

Parameters:

name - name of the view

Returns:

the view

getDataViews

public Map getDataViews()

Get all available dataviews in this space.

Specified by:

getDataViews in interface IEnvironmentSpace

Returns:

all available dataviews

addDataViewMapping

public void addDataViewMapping(String objecttype,
                               Map view)

Add a mapping from object type to data view

Parameters:

objecttype - The object type.

view - Settings for view creation.

addEnvironmentListener

public void addEnvironmentListener(IEnvironmentListener listener)

Add an environment listener.

Specified by:

addEnvironmentListener in interface IEnvironmentSpace

Parameters:

listener - The environment listener.

removeEnvironmentListener

public void removeEnvironmentListener(IEnvironmentListener listener)

Remove an environment listener.

Specified by:

removeEnvironmentListener in interface IEnvironmentSpace

Parameters:

listener - The environment listener.

addPerceptGenerator

public void addPerceptGenerator(Object id,
                                IPerceptGenerator gen)

Adds a percept generator.

Specified by:

addPerceptGenerator in interface IEnvironmentSpace

Parameters:

id - The percept generator id.

gen - The percept generator.

removePerceptGenerator

public void removePerceptGenerator(Object id)

Remove a percept generator.

Specified by:

removePerceptGenerator in interface IEnvironmentSpace

Parameters:

id - The percept generator id.

addPerceptProcessor

public void addPerceptProcessor(String componenttype,
                                Set percepttypes,
                                IPerceptProcessor proc)

Add a percept processor.

Parameters:

componenttype - The component type.

proc - The percept processor.

removePerceptProcessor

public void removePerceptProcessor(String componenttype,
                                   IPerceptProcessor proc)

remove a percept processor.

Parameters:

componenttype - The component type.

proc - The percept processor.

addPerceptType

public void addPerceptType(PerceptType percepttype)

Add a space percept type.

Specified by:

addPerceptType in interface IEnvironmentSpace

Parameters:

typename - The percept name.

objecttypes - The objecttypes.

componenttypes - The componenttypes.

removePerceptType

public void removePerceptType(String typename)

Remove a space process type.

Specified by:

removePerceptType in interface IEnvironmentSpace

Parameters:

typename - The type name.

getPerceptType

public PerceptType getPerceptType(String percepttype)

Get a space percept type.

Specified by:

getPerceptType in interface IEnvironmentSpace

Parameters:

percepttype - The name of the percept type.

Returns:

The percept type.

componentAdded

public void componentAdded(IComponentDescription owner)

Called when an component was added.

componentRemoved

public void componentRemoved(IComponentDescription desc)

Called when an component was removed.

getExternalAccess

public IExternalAccess getExternalAccess()

Get the context.

Specified by:

getExternalAccess in interface IEnvironmentSpace

Returns:

The context.

getProperty

public Object getProperty(String name)

Returns a property.

Specified by:

getProperty in interface IPropertyObject

Overrides:

getProperty in class SynchronizedPropertyObject

Parameters:

name - name of the property

Returns:

the property

getFetcher

public SimpleValueFetcher getFetcher()

Get the value fetcher.

Returns:

The fetcher.

setFetcher

public void setFetcher(SimpleValueFetcher fetcher)

Set the fetcher.

Parameters:

fetcher - The fetcher to set.

getSpaceObjectsCollection

public Collection getSpaceObjectsCollection()

Get the space objects.

getProcesses

public Collection getProcesses()

Get the processes.

getComponentActionList

public ComponentActionList getComponentActionList()

Get the list of scheduled component actions

getPerceptList

public PerceptList getPerceptList()

Get the list of scheduled percepts.

getViews

public Collection getViews()

Get the views.

addInitialAvatar

public void addInitialAvatar(IComponentIdentifier ownerid,
                             String type,
                             Map props)

Initial settings for the avatar of a specific component.

Parameters:

ownerid - The component id.

type - The object type.

props - The properties for the object (if any).

addDataProvider

public void addDataProvider(String name,
                            ITableDataProvider provider)

Add a new data provider.

Parameters:

name - The name.

provider - The provider.

getDataProvider

public ITableDataProvider getDataProvider(String name)

Get a data provider.

Parameters:

name - The name.

Returns:

The provider.

addDataConsumer

public void addDataConsumer(String name,
                            ITableDataConsumer consumer)

Add a new data consumer.

Parameters:

consumer - The consumer.

getDataConsumer

public ITableDataConsumer getDataConsumer(String name)

Get a data consumer.

Parameters:

name - The name.

Returns:

The consumer.

getDataConsumers

public Collection getDataConsumers()

Get the data consumers.

Returns:

The data consumers.

init

public IFuture<Void> init()

Initialize the extension. Called once, when the extension is created.

Specified by:

init in interface IExtensionInstance

terminate

public IFuture<Void> terminate()

Terminate the extension. Called once, when the extension is terminated.

Specified by:

terminate in interface IExtensionInstance

getClassLoader

public ClassLoader getClassLoader()

Get the class loader.