jadex.bdiv3.runtime.impl

Class RGoal

java.lang.Object

jadex.bdiv3.runtime.impl.RElement

jadex.bdiv3.runtime.impl.RParameterElement

jadex.bdiv3.runtime.impl.RProcessableElement

jadex.bdiv3.runtime.impl.RFinishableElement

jadex.bdiv3.runtime.impl.RGoal

All Implemented Interfaces:

IGoal, IInternalPlan, IElement, IFinishableElement<java.lang.Void>, IParameterElement, jadex.javaparser.IMapAccess

public class RGoal
extends RFinishableElement
implements IGoal, IInternalPlan

Goal instance implementation.

Nested Class Summary

Nested classes/interfaces inherited from class jadex.bdiv3.runtime.impl.RProcessableElement

RProcessableElement.State

Nested classes/interfaces inherited from class jadex.bdiv3.runtime.impl.RParameterElement

RParameterElement.RParameter, RParameterElement.RParameterSet

Nested classes/interfaces inherited from interface jadex.bdiv3.runtime.IGoal

IGoal.GoalLifecycleState, IGoal.GoalProcessingState

Field Summary

Fields

Modifier and Type	Field and Description
protected RPlan	childplan The child plan.
protected IGoal.GoalLifecycleState	lifecyclestate The lifecycle state.
protected RGoal	parentgoal
protected RPlan	parentplan The parent plan.
protected IGoal.GoalProcessingState	processingstate The processing state.

Fields inherited from class jadex.bdiv3.runtime.impl.RFinishableElement

exception, listeners

Fields inherited from class jadex.bdiv3.runtime.impl.RProcessableElement

apl, pojoelement, state, triedplans

Fields inherited from class jadex.bdiv3.runtime.impl.RParameterElement

parameters, parametersets

Fields inherited from class jadex.bdiv3.runtime.impl.RElement

agent, cnt, id, modelelement

Constructor Summary

Constructors

Constructor and Description
RGoal(jadex.bridge.IInternalAccess agent, MGoal mgoal, java.lang.Object goal, RGoal parentgoal, java.util.Map<java.lang.String,java.lang.Object> vals, MConfigParameterElement config) Create a new rgoal.

Method Summary

Modifier and Type	Method and Description
protected jadex.commons.future.IFuture<java.lang.Void>	abortPlans() Abort the child plans.
void	addListener(jadex.commons.future.IResultListener<java.lang.Void> listener) Add a new listener to get notified when the goal is finished.
static void	adoptGoal(RGoal rgoal, jadex.bridge.IInternalAccess ia) Adopt a goal so that the agent tries pursuing it.
jadex.commons.future.IFuture<java.lang.Void>	drop() Drop the goal.
boolean	equals(java.lang.Object obj) Test if equal to other object.
java.lang.Object	getCandidate() Get the candidate.
RPlan	getChildPlan() Get the childplan.
java.lang.String	getFetcherName() Get the name of the element in the fetcher (e.g.
static java.lang.Object	getGoalResult(RGoal rgoal, java.lang.ClassLoader cl) Get the goal result of the pojo element.
IGoal.GoalLifecycleState	getLifecycleState() Get the lifecycleState.
MGoal	getMGoal() Get the model element.
RElement	getParent() Get parent (goal or plan).
RGoal	getParentGoal() Get the parentgoal.
RPlan	getParentPlan() Get the parentplan.
IGoal.GoalProcessingState	getProcessingState() Get the processingState.
int	hashCode() Get the hashcode.
boolean	isAborted() Test if plan has been aborted.
boolean	isActive() Test if the goal is in lifecyclestate 'active'.
boolean	isFailed() Test if the element is failed.
boolean	isPassed() Test if plan has passed.
boolean	isProceduralGoal()
boolean	isProceduralSucceeded() Test if a goal has succeeded with respect to its plan execution.
static boolean	isQueryGoalFinished(RGoal goal) Test if a querygoal is finished.
boolean	isRecur()
boolean	isRetry()
boolean	isSame(IGoal goal) Check if the goal is the same as another goal with respect to uniqueness settings.
boolean	isSucceeded() Test if the element is succeeded.
boolean	onActivate()
void	planFinished(jadex.bridge.IInternalAccess ia, IInternalPlan rplan) Called when a plan is finished.
void	publishToolGoalEvent(java.lang.String evtype)
void	setChildPlan(RPlan childplan) Set the childplan.
void	setGoalResult(java.lang.Object result, java.lang.ClassLoader cl)
void	setGoalResult(java.lang.Object result, java.lang.ClassLoader cl, ChangeEvent event, RPlan rplan, RProcessableElement rpe) Set the goal result from a plan.
void	setLifecycleState(IGoal.GoalLifecycleState lifecyclestate) Set the lifecycleState.
void	setLifecycleState(jadex.bridge.IInternalAccess ia, IGoal.GoalLifecycleState lifecyclestate) Set the lifecycle state.
void	setParent(RGoal parent) Set parent (goal or plan).
void	setParent(RPlan parent) Set parent (goal or plan).
void	setProcessingState(IGoal.GoalProcessingState processingstate) Set the processingState.
void	setProcessingState(jadex.bridge.IInternalAccess ia, IGoal.GoalProcessingState processingstate) Set the processingState.
void	targetConditionTriggered(jadex.bridge.IInternalAccess ia, jadex.rules.eca.IEvent event, jadex.rules.eca.IRule<java.lang.Void> rule, java.lang.Object context) Called when the target condition of a goal triggers.
java.lang.String	toString() Get the string representation.

Methods inherited from class jadex.bdiv3.runtime.impl.RFinishableElement

getException, getListeners, isFinished, notifyListeners, removeListener, setException

Methods inherited from class jadex.bdiv3.runtime.impl.RProcessableElement

addTriedPlan, getApplicablePlanList, getPojoElement, getState, getTriedPlans, setApplicablePlanList, setPojoElement, setState, setState, setTriedPlans, testWriteOK

Methods inherited from class jadex.bdiv3.runtime.impl.RParameterElement

addParameter, addParameterSet, createParameter, createParameter, createParameterSet, createParameterSet, get, getParameter, getParameters, getParameterSet, getParameterSets, getType, hasParameter, hasParameterSet, initParameters, wrapFetcher

Methods inherited from class jadex.bdiv3.runtime.impl.RElement

getAgent, getCapability, getId, getMCapability, getModelElement, getRuleSystem, setId, setModelElement

Methods inherited from class java.lang.Object

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

Methods inherited from interface jadex.bdiv3.runtime.IGoal

getId

Methods inherited from interface jadex.bdiv3x.runtime.IFinishableElement

getException, isFinished, removeListener

Methods inherited from interface jadex.bdiv3.runtime.impl.IInternalPlan

getException

Methods inherited from interface jadex.bdiv3x.runtime.IParameterElement

getParameter, getParameters, getParameterSet, getParameterSets, getType, hasParameter, hasParameterSet

Methods inherited from interface jadex.bdiv3x.runtime.IElement

getModelElement

Field Detail

lifecyclestate

protected IGoal.GoalLifecycleState lifecyclestate

The lifecycle state.

processingstate

protected IGoal.GoalProcessingState processingstate

The processing state.

parentplan

protected RPlan parentplan

The parent plan.

parentgoal

protected RGoal parentgoal

childplan

protected RPlan childplan

The child plan.

Constructor Detail

RGoal

public RGoal(jadex.bridge.IInternalAccess agent,
             MGoal mgoal,
             java.lang.Object goal,
             RGoal parentgoal,
             java.util.Map<java.lang.String,java.lang.Object> vals,
             MConfigParameterElement config)

Create a new rgoal.

Method Detail

getFetcherName

public java.lang.String getFetcherName()

Get the name of the element in the fetcher (e.g. $goal).

Specified by:

getFetcherName in class RParameterElement

Returns:

The element name in the fetcher name.

adoptGoal

public static void adoptGoal(RGoal rgoal,
                             jadex.bridge.IInternalAccess ia)

Adopt a goal so that the agent tries pursuing it.

getParentPlan

public RPlan getParentPlan()

Get the parentplan.

Returns:

The parentplan.

getParentGoal

public RGoal getParentGoal()

Get the parentgoal.

Returns:

The parentgoal.

getParent

public RElement getParent()

Get parent (goal or plan).

setParent

public void setParent(RGoal parent)

Set parent (goal or plan).

setParent

public void setParent(RPlan parent)

Set parent (goal or plan).

getLifecycleState

public IGoal.GoalLifecycleState getLifecycleState()

Get the lifecycleState.

Specified by:

getLifecycleState in interface IGoal

Returns:

The lifecycleState.

setLifecycleState

public void setLifecycleState(IGoal.GoalLifecycleState lifecyclestate)

Set the lifecycleState.

Parameters:

lifecycleState - The lifecycleState to set.

getProcessingState

public IGoal.GoalProcessingState getProcessingState()

Get the processingState.

Specified by:

getProcessingState in interface IGoal

Returns:

The processingState.

setProcessingState

public void setProcessingState(IGoal.GoalProcessingState processingstate)

Set the processingState.

Parameters:

processingState - The processingState to set.

setProcessingState

public void setProcessingState(jadex.bridge.IInternalAccess ia,
                               IGoal.GoalProcessingState processingstate)

Set the processingState.

Parameters:

processingState - The processingState to set.

setLifecycleState

public void setLifecycleState(jadex.bridge.IInternalAccess ia,
                              IGoal.GoalLifecycleState lifecyclestate)

Set the lifecycle state.

Parameters:

processingState - The processingState to set.

abortPlans

protected jadex.commons.future.IFuture<java.lang.Void> abortPlans()

Abort the child plans.

getMGoal

public MGoal getMGoal()

Get the model element.

isSucceeded

public boolean isSucceeded()

Test if the element is succeeded.

Specified by:

isSucceeded in interface IFinishableElement<java.lang.Void>

Specified by:

isSucceeded in class RFinishableElement

Returns:

True, if is succeeded.

isFailed

public boolean isFailed()

Test if the element is failed.

Specified by:

isFailed in interface IInternalPlan

Specified by:

isFailed in interface IFinishableElement<java.lang.Void>

Specified by:

isFailed in class RFinishableElement

Returns:

True, if is failed.

isActive

public boolean isActive()

Test if the goal is in lifecyclestate 'active'.

Specified by:

isActive in interface IGoal

getChildPlan

public RPlan getChildPlan()

Get the childplan.

Returns:

The childplan.

setChildPlan

public void setChildPlan(RPlan childplan)

Set the childplan.

Parameters:

childplan - The childplan to set.

hashCode

public int hashCode()

Get the hashcode.

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Test if equal to other object.

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Description copied from class: RElement

Get the string representation.

Overrides:

toString in class RElement

planFinished

public void planFinished(jadex.bridge.IInternalAccess ia,
                         IInternalPlan rplan)

Called when a plan is finished.

Overrides:

planFinished in class RProcessableElement

onActivate

public boolean onActivate()

isRetry

public boolean isRetry()

isRecur

public boolean isRecur()

isProceduralSucceeded

public boolean isProceduralSucceeded()

Test if a goal has succeeded with respect to its plan execution.

isProceduralGoal

public boolean isProceduralGoal()

getGoalResult

public static java.lang.Object getGoalResult(RGoal rgoal,
                                             java.lang.ClassLoader cl)

Get the goal result of the pojo element. Searches @GoalResult and delivers value.

drop

public jadex.commons.future.IFuture<java.lang.Void> drop()

Drop the goal.

Specified by:

drop in interface IGoal

addListener

public void addListener(jadex.commons.future.IResultListener<java.lang.Void> listener)

Add a new listener to get notified when the goal is finished.

Specified by:

addListener in interface IFinishableElement<java.lang.Void>

Overrides:

addListener in class RFinishableElement

Parameters:

listener - The listener.

targetConditionTriggered

public void targetConditionTriggered(jadex.bridge.IInternalAccess ia,
                                     jadex.rules.eca.IEvent event,
                                     jadex.rules.eca.IRule<java.lang.Void> rule,
                                     java.lang.Object context)

Called when the target condition of a goal triggers.

setGoalResult

public void setGoalResult(java.lang.Object result,
                          java.lang.ClassLoader cl)

Parameters:

result -

cl -

setGoalResult

public void setGoalResult(java.lang.Object result,
                          java.lang.ClassLoader cl,
                          ChangeEvent event,
                          RPlan rplan,
                          RProcessableElement rpe)

Set the goal result from a plan.

publishToolGoalEvent

public void publishToolGoalEvent(java.lang.String evtype)

getCandidate

public java.lang.Object getCandidate()

Get the candidate.

Specified by:

getCandidate in interface IInternalPlan

Returns:

The candidate.

isPassed

public boolean isPassed()

Test if plan has passed.

Specified by:

isPassed in interface IInternalPlan

isAborted

public boolean isAborted()

Test if plan has been aborted.

Specified by:

isAborted in interface IInternalPlan

isSame

public boolean isSame(IGoal goal)

Check if the goal is the same as another goal with respect to uniqueness settings. When two goals are the same this does not mean the objects are equal() in the Java sense!

isQueryGoalFinished

public static boolean isQueryGoalFinished(RGoal goal)

Test if a querygoal is finished. It is finished when all out parameters/sets are filled with a value.