jadex.bdiv3x.features

Class BDIXAgentFeature

java.lang.Object

AbstractComponentFeature

jadex.bdiv3x.features.BDIXAgentFeature

All Implemented Interfaces:

IBDIXAgentFeature, ICapability

public class BDIXAgentFeature
extends AbstractComponentFeature
implements IBDIXAgentFeature

BDI agent feature version for XML agents.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BDIXAgentFeature.ChangeInfoEntryMapper Map a change info as Map:Entry.
static class	BDIXAgentFeature.GoalsExistCondition Condition that tests if goal instances of an mgoal exist.
static class	BDIXAgentFeature.LifecycleStateCondition Condition for checking the lifecycle state of a goal.
static class	BDIXAgentFeature.PlansExistCondition Condition that tests if goal instances of an mplan exist.

Field Summary

Fields

Modifier and Type	Field and Description
protected IBDIModel	bdimodel The bdi model.
protected RCapability	capa The bdi state.
static IComponentFeatureFactory	FACTORY
protected RuleSystem	rulesystem The rule system.

Constructor Summary

Constructors

Constructor and Description
BDIXAgentFeature(IInternalAccess component, ComponentCreationInfo cinfo) Factory method constructor for instance level.

Method Summary

Modifier and Type	Method and Description
protected static java.lang.Object	adaptToCapability(java.lang.Object obj, java.lang.String capa, IBDIModel bdimodel) Adapt element for use in inner capabilities.
static void	addBeliefEvents(IInternalAccess ia, java.util.List<EventType> events, java.lang.String belname) Create belief events from a belief name.
void	addBeliefListener(java.lang.String name, IBeliefListener listener) Add a belief listener.
static void	addInitArgs(java.lang.Object obj, java.lang.Class<?> clazz, java.lang.Class<?>[] argtypes, java.lang.Object[] args) Add an entry to the init calls.
static void	createChangeEvent(java.lang.Object val, java.lang.Object oldval, java.lang.Object info, IInternalAccess agent, java.lang.String belname) Caution: this method is used from byte engineered code, change signature with caution Create a belief changed event.
static EventType	createEventType(RawEvent rawev)
protected void	doCleanup() Cleanup the beliefs in kill and shutdown.
IModelInfo	getAgentModel() Get the agent model.
java.lang.String	getAgentName() Get the agent name.
static IBDIXAgentFeature	getBDIAgentFeature(IInternalAccess agent) Get the feature from the agent.
IBDIModel	getBDIModel() Get the bdimodel.
IBeliefbase	getBeliefbase() Get the belief base.
protected static java.lang.String	getBeliefName(java.lang.Object obj, java.lang.String fieldname)
RCapability	getCapability() Get the state.
java.lang.ClassLoader	getClassLoader() Get the classloader.
IComponentDescription	getComponentDescription() Get the component description.
IComponentIdentifier	getComponentIdentifier() Get the agent identifier.
java.lang.String	getConfigurationName() Get the configuration name.
java.util.List<IMonitoringEvent>	getCurrentStateEvents() Get the current state as events.
java.util.Map<EventType,IResultCommand<IFuture<java.lang.Void>,PropertyChangeEvent>>	getEventAdders() Get the event type.
IEventbase	getEventbase() Get the event base.
IExpressionbase	getExpressionbase() Get the expression base.
IExternalAccess	getExternalAccess() Get the scope.
IGoalbase	getGoalbase() Get the goal base.
static java.util.List<EventType>	getGoalEvents(MGoal mgoal) Create goal events for a goal name.
static java.lang.Object[]	getInjectionValues(java.lang.Class<?>[] ptypes, java.lang.annotation.Annotation[][] anns, MElement melement, ChangeEvent event, RPlan rplan, RProcessableElement rpe, java.util.Collection<java.lang.Object> vs, IInternalAccess component) Get parameter values for injection into method and constructor calls.
static java.lang.Object[]	getInjectionValues(java.lang.Class<?>[] ptypes, java.lang.annotation.Annotation[][] anns, MElement melement, ChangeEvent event, RPlan rplan, RProcessableElement rpe, IInternalAccess component) Get parameter values for injection into method and constructor calls.
java.util.logging.Logger	getLogger() Get the logger.
IModelInfo	getModel() Get the capability model.
IPlanbase	getPlanbase() Get the plan base.
RuleSystem	getRuleSystem() Get the rulesystem.
long	getTime() Get the current time.
IValueFetcher	getValueFetcher() Get the value fetcher.
boolean	hasUserBody() Check if the feature potentially executed user code in body.
IFuture<java.lang.Void>	init() Initialize the feature.
protected boolean	isComponentThread()
void	kill() Called on init failure.
IFuture<java.util.Map<java.lang.String,java.lang.Object>>	killAgent() Kill the agent.
static void	publishToolBeliefEvent(IInternalAccess ia, MBelief mbel)
static java.util.List<EventType>	readAnnotationEvents(IInternalAccess ia, java.lang.annotation.Annotation[][] annos) Read the annotation events from method annotations.
void	removeBeliefListener(java.lang.String name, IBeliefListener listener) Remove a belief listener.
IFuture<java.lang.Void>	shutdown() Called on shutdown after successful init.
ISubscriptionIntermediateFuture<IMonitoringEvent>	subscribeToEvents(IFilter<IMonitoringEvent> filter, boolean initial, IMonitoringService.PublishEventLevel elm) Subscribe to monitoring events.
protected void	testBodyAborted(RPlan rplan) Check if plan is already aborted.
protected void	wrapCollections(MCapability mcapa, java.lang.Object agent)

Methods inherited from class java.lang.Object

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

Field Detail

FACTORY

public static final IComponentFeatureFactory FACTORY

bdimodel

protected IBDIModel bdimodel

The bdi model.

rulesystem

protected RuleSystem rulesystem

The rule system.

capa

protected RCapability capa

The bdi state.

Constructor Detail

BDIXAgentFeature

public BDIXAgentFeature(IInternalAccess component,
                        ComponentCreationInfo cinfo)

Factory method constructor for instance level.

Method Detail

init

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

Initialize the feature.

hasUserBody

public boolean hasUserBody()

Check if the feature potentially executed user code in body. Allows blocking operations in user bodies by using separate steps for each feature. Non-user-body-features are directly executed for speed. If unsure just return true. ;-)

shutdown

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

Called on shutdown after successful init.

kill

public void kill()

Called on init failure.

doCleanup

protected void doCleanup()

Cleanup the beliefs in kill and shutdown.

addInitArgs

public static void addInitArgs(java.lang.Object obj,
                               java.lang.Class<?> clazz,
                               java.lang.Class<?>[] argtypes,
                               java.lang.Object[] args)

Add an entry to the init calls.

Parameters:

obj - object instance that owns the field __initargs

clazz - Class definition of the obj object

argtypes - Signature of the init method

args - Actual argument values for the init method

createChangeEvent

public static void createChangeEvent(java.lang.Object val,
                                     java.lang.Object oldval,
                                     java.lang.Object info,
                                     IInternalAccess agent,
                                     java.lang.String belname)

Caution: this method is used from byte engineered code, change signature with caution Create a belief changed event.

Parameters:

val - The new value.

agent - The agent.

belname - The belief name.

publishToolBeliefEvent

public static void publishToolBeliefEvent(IInternalAccess ia,
                                          MBelief mbel)

getBeliefName

protected static java.lang.String getBeliefName(java.lang.Object obj,
                                                java.lang.String fieldname)

isComponentThread

protected boolean isComponentThread()

adaptToCapability

protected static java.lang.Object adaptToCapability(java.lang.Object obj,
                                                    java.lang.String capa,
                                                    IBDIModel bdimodel)

Adapt element for use in inner capabilities.

Parameters:

obj - The object to adapt (e.g. a change event)

capa - The capability name or null for agent.

wrapCollections

protected void wrapCollections(MCapability mcapa,
                               java.lang.Object agent)

addBeliefListener

public void addBeliefListener(java.lang.String name,
                              IBeliefListener listener)

Add a belief listener.

Parameters:

name - The belief name.

listener - The belief listener.

removeBeliefListener

public void removeBeliefListener(java.lang.String name,
                                 IBeliefListener listener)

Remove a belief listener.

Parameters:

name - The belief name.

listener - The belief listener.

testBodyAborted

protected void testBodyAborted(RPlan rplan)

Check if plan is already aborted.

getInjectionValues

public static java.lang.Object[] getInjectionValues(java.lang.Class<?>[] ptypes,
                                                    java.lang.annotation.Annotation[][] anns,
                                                    MElement melement,
                                                    ChangeEvent event,
                                                    RPlan rplan,
                                                    RProcessableElement rpe,
                                                    IInternalAccess component)

Get parameter values for injection into method and constructor calls.

getInjectionValues

public static java.lang.Object[] getInjectionValues(java.lang.Class<?>[] ptypes,
                                                    java.lang.annotation.Annotation[][] anns,
                                                    MElement melement,
                                                    ChangeEvent event,
                                                    RPlan rplan,
                                                    RProcessableElement rpe,
                                                    java.util.Collection<java.lang.Object> vs,
                                                    IInternalAccess component)

Get parameter values for injection into method and constructor calls.

Returns:

A valid assigment or null if no assignment could be found.

getRuleSystem

public RuleSystem getRuleSystem()

Get the rulesystem.

Returns:

The rulesystem.

getBDIModel

public IBDIModel getBDIModel()

Get the bdimodel.

Returns:

the bdimodel.

getCapability

public RCapability getCapability()

Get the state.

Returns:

the state.

addBeliefEvents

public static void addBeliefEvents(IInternalAccess ia,
                                   java.util.List<EventType> events,
                                   java.lang.String belname)

Create belief events from a belief name. For normal beliefs beliefchanged.belname and factchanged.belname and for multi beliefs additionally factadded.belname and factremoved are created.

getGoalEvents

public static java.util.List<EventType> getGoalEvents(MGoal mgoal)

Create goal events for a goal name. creates goaladopted, goaldropped goaloption, goalactive, goalsuspended goalinprocess, goalnotinprocess events.

readAnnotationEvents

public static java.util.List<EventType> readAnnotationEvents(IInternalAccess ia,
                                                             java.lang.annotation.Annotation[][] annos)

Read the annotation events from method annotations.

getCurrentStateEvents

public java.util.List<IMonitoringEvent> getCurrentStateEvents()

Get the current state as events.

createEventType

public static EventType createEventType(RawEvent rawev)

getBDIAgentFeature

public static IBDIXAgentFeature getBDIAgentFeature(IInternalAccess agent)

Get the feature from the agent.

getValueFetcher

public IValueFetcher getValueFetcher()

Get the value fetcher.

getEventAdders

public java.util.Map<EventType,IResultCommand<IFuture<java.lang.Void>,PropertyChangeEvent>> getEventAdders()

Get the event type.

Returns:

The event adder.

getExternalAccess

public IExternalAccess getExternalAccess()

Get the scope. Method with IExternalAccess return value included for compatibility with IInternalAccess.

Specified by:

getExternalAccess in interface ICapability

Returns:

The scope.

getBeliefbase

public IBeliefbase getBeliefbase()

Get the belief base.

Specified by:

getBeliefbase in interface ICapability

Returns:

The belief base.

getEventbase

public IEventbase getEventbase()

Get the event base.

Specified by:

getEventbase in interface ICapability

Returns:

The event base.

getGoalbase

public IGoalbase getGoalbase()

Get the goal base.

Specified by:

getGoalbase in interface ICapability

Returns:

The goal base.

getPlanbase

public IPlanbase getPlanbase()

Get the plan base.

Specified by:

getPlanbase in interface ICapability

Returns:

The plan base.

getExpressionbase

public IExpressionbase getExpressionbase()

Get the expression base.

Specified by:

getExpressionbase in interface ICapability

Returns:

The expression base.

getLogger

public java.util.logging.Logger getLogger()

Get the logger.

Specified by:

getLogger in interface ICapability

Returns:

The logger.

getAgentModel

public IModelInfo getAgentModel()

Get the agent model.

Specified by:

getAgentModel in interface ICapability

Returns:

The agent model.

getModel

public IModelInfo getModel()

Get the capability model.

Specified by:

getModel in interface ICapability

Returns:

The capability model.

getAgentName

public java.lang.String getAgentName()

Get the agent name.

Specified by:

getAgentName in interface ICapability

Returns:

The agent name.

getConfigurationName

public java.lang.String getConfigurationName()

Get the configuration name.

Specified by:

getConfigurationName in interface ICapability

Returns:

The configuration name.

getComponentIdentifier

public IComponentIdentifier getComponentIdentifier()

Get the agent identifier.

Specified by:

getComponentIdentifier in interface ICapability

Returns:

The agent identifier.

getComponentDescription

public IComponentDescription getComponentDescription()

Get the component description.

Specified by:

getComponentDescription in interface ICapability

Returns:

The component description.

getTime

public long getTime()

Get the current time. The time unit depends on the currently running clock implementation. For the default system clock, the time value adheres to the time representation as used by System.currentTimeMillis(), i.e., the value of milliseconds passed since 0:00 'o clock, January 1st, 1970, UTC. For custom simulation clocks, arbitrary representations can be used.

Specified by:

getTime in interface ICapability

Returns:

The current time.

getClassLoader

public java.lang.ClassLoader getClassLoader()

Get the classloader.

Specified by:

getClassLoader in interface ICapability

Returns:

The classloader.

killAgent

public IFuture<java.util.Map<java.lang.String,java.lang.Object>> killAgent()

Kill the agent.

Specified by:

killAgent in interface ICapability

subscribeToEvents

public ISubscriptionIntermediateFuture<IMonitoringEvent> subscribeToEvents(IFilter<IMonitoringEvent> filter,
                                                                           boolean initial,
                                                                           IMonitoringService.PublishEventLevel elm)

Subscribe to monitoring events.

Specified by:

subscribeToEvents in interface ICapability

Parameters:

filter - An optional filter.