jadex.model
Interface IMExpression

All Superinterfaces:

IMElement, IMReferenceableElement

All Known Subinterfaces:

IMBindingCondition, IMCondition, IMInhibits, IMPlanBody

public interface IMExpression

extends IMReferenceableElement

An expression is a string that is parsed and later evaluated.

Field Summary

static String	ANY_ELEMENT The any element indicator (for expressions affected by system events regardless of the originating element).
static String	MODE_DYNAMIC The evaluation mode for dynamic values.
static String	MODE_STATIC The evaluation mode for static values.

Method Summary

IMExpressionParameter	createExpressionParameter(String name, Class clazz) Create an expression parameter.
IMRelevantElement	createRelevantBelief(String ref, String event) Add a relevant belief.
IMRelevantElement	createRelevantBeliefSet(String ref, String event) Add a relevant belief set.
IMRelevantElement	createRelevantGoal(String ref, String event) Add a relevant goal.
IMRelevantElement	createRelevantParameter(String ref, String event) Add a relevant parameter.
IMRelevantElement	createRelevantParameterSet(String ref, String event) Add a relevant parameter set.
void	deleteExpressionParameter(IMExpressionParameter param) Delete an expression parameter.
void	deleteRelevantBelief(IMRelevantElement ref) Delete a relevant belief.
void	deleteRelevantBeliefSet(IMRelevantElement ref) Delete a relevant belief set.
void	deleteRelevantGoal(IMRelevantElement ref) Delete a relevant goal.
void	deleteRelevantParameter(IMRelevantElement ref) Delete a relevant parameter.
void	deleteRelevantParameterSet(IMRelevantElement ref) Delete a relevant parameter set.
Class	getClazz() Get the expected value type.
String	getEvaluationMode() Get the evaluation mode.
String	getExpressionText() Get the expression text.
IMRelevantElement[]	getRelevantBeliefs() Get the relevant beliefs.
IMRelevantElement[]	getRelevantBeliefSets() Get the relevant belief sets.
IMRelevantElement[]	getRelevantGoals() Get the relevant goals.
MultiCollection	getRelevantList() Get the relevant list.
IMRelevantElement[]	getRelevantParameters() Get the relevant parameters.
IMRelevantElement[]	getRelevantParameterSets() Get the relevant parameter sets.
jadex.parser.ITerm	getTerm() Get the term.
IMExpressionParameter[]	getUserExpressionParameters() Get all expression parameters.
Object	getValue(Map params) Evaluate the expression.
void	setClazz(Class clazz) Set the expected value type.
void	setEvaluationMode(String eva) Set the evaluation mode.
void	setExpressionText(String expression) Set the expression text.

Methods inherited from interface jadex.model.IMReferenceableElement

createAssignTo, deleteAssignTo, getAssignToElements, getAssignTos, isExported, setExported

Methods inherited from interface jadex.model.IMElement

check, getChildren, getDescription, getEncodableRepresentation, getExpressionParameters, getName, getOwner, getReport, getScope, setDescription, setName

Field Detail

MODE_DYNAMIC

public static final String MODE_DYNAMIC

The evaluation mode for dynamic values.

See Also:

Constant Field Values

MODE_STATIC

public static final String MODE_STATIC

The evaluation mode for static values.

See Also:

Constant Field Values

ANY_ELEMENT

public static final String ANY_ELEMENT

The any element indicator (for expressions affected by system events regardless of the originating element).

See Also:

Constant Field Values

Method Detail

getEvaluationMode

public String getEvaluationMode()

Get the evaluation mode.

Returns:

The evaluation mode.

setEvaluationMode

public void setEvaluationMode(String eva)

Set the evaluation mode.

Parameters:

eva - The evaluation mode.

getExpressionText

public String getExpressionText()

Get the expression text.

Returns:

The expression text.

setExpressionText

public void setExpressionText(String expression)

Set the expression text.

Parameters:

expression - The expression text.

getUserExpressionParameters

public IMExpressionParameter[] getUserExpressionParameters()

Get all expression parameters.

Returns:

The expression parameters.

createExpressionParameter

public IMExpressionParameter createExpressionParameter(String name,
                                                       Class clazz)

Create an expression parameter.

Parameters:

name - The name.

clazz - The clazz.

deleteExpressionParameter

public void deleteExpressionParameter(IMExpressionParameter param)

Delete an expression parameter.

Parameters:

param - The expression parameter.

getRelevantBeliefs

public IMRelevantElement[] getRelevantBeliefs()

Get the relevant beliefs.

Returns:

The relevant beliefs.

createRelevantBelief

public IMRelevantElement createRelevantBelief(String ref,
                                              String event)

Add a relevant belief.

Parameters:

ref - The referenced belief.

event - The relevant system event (or null for default).

deleteRelevantBelief

public void deleteRelevantBelief(IMRelevantElement ref)

Delete a relevant belief.

Parameters:

ref - The referenced belief.

getRelevantBeliefSets

public IMRelevantElement[] getRelevantBeliefSets()

Get the relevant belief sets.

Returns:

The relevant belief sets.

createRelevantBeliefSet

public IMRelevantElement createRelevantBeliefSet(String ref,
                                                 String event)

Add a relevant belief set.

Parameters:

ref - The referenced belief set.

event - The relevant system event (or null for default).

deleteRelevantBeliefSet

public void deleteRelevantBeliefSet(IMRelevantElement ref)

Delete a relevant belief set.

Parameters:

ref - The referenced belief set.

getRelevantGoals

public IMRelevantElement[] getRelevantGoals()

Get the relevant goals.

Returns:

The relevant goals.

createRelevantGoal

public IMRelevantElement createRelevantGoal(String ref,
                                            String event)

Add a relevant goal.

Parameters:

ref - The referenced goal.

event - The relevant system event (or null for default).

deleteRelevantGoal

public void deleteRelevantGoal(IMRelevantElement ref)

Delete a relevant goal.

Parameters:

ref - The referenced goal.

getRelevantParameters

public IMRelevantElement[] getRelevantParameters()

Get the relevant parameters.

Returns:

The relevant parameters.

createRelevantParameter

public IMRelevantElement createRelevantParameter(String ref,
                                                 String event)

Add a relevant parameter.

Parameters:

ref - The referenced parameter.

event - The relevant system event (or null for default).

deleteRelevantParameter

public void deleteRelevantParameter(IMRelevantElement ref)

Delete a relevant parameter.

Parameters:

ref - The referenced parameter.

getRelevantParameterSets

public IMRelevantElement[] getRelevantParameterSets()

Get the relevant parameter sets.

Returns:

The relevant parameter sets.

createRelevantParameterSet

public IMRelevantElement createRelevantParameterSet(String ref,
                                                    String event)

Add a relevant parameter set.

Parameters:

ref - The referenced parameter set.

event - The relevant system event (or null for default).

deleteRelevantParameterSet

public void deleteRelevantParameterSet(IMRelevantElement ref)

Delete a relevant parameter set.

Parameters:

ref - The referenced parameter set.

getClazz

public Class getClazz()

Get the expected value type.

Returns:

The expected value type.

setClazz

public void setClazz(Class clazz)

Set the expected value type.

Parameters:

clazz - The expected value type.

getRelevantList

public MultiCollection getRelevantList()

Get the relevant list. Hack!!! todo: remove or change?!

getValue

public Object getValue(Map params)

Evaluate the expression.

Parameters:

params - The expression parameters (if any).

Returns:

The value.

getTerm

public jadex.parser.ITerm getTerm()

Get the term.

Returns:

The term.