bdi4jade.plan

Class GoalTemplate

java.lang.Object

bdi4jade.plan.GoalTemplate

public abstract class GoalTemplate
extends java.lang.Object

This abstract class specifies a goal template that is used to match a goal to be achieved to a template of goals. This template is used to indicate the set of goals that a plan is able to handle. This class also provides a collection of static methods to create common goal templates.

Author:

Ingrid Nunes

Constructor Summary

Constructors

Constructor and Description
GoalTemplate()

Method Summary

Modifier and Type	Method and Description
static GoalTemplate	createBeliefGoalTemplate(java.lang.String beliefName) This method creates a goal template that positively matches a goal if it is of the type BeliefGoal and has the given belief name.
static GoalTemplate	createBeliefSetTypeGoalTemplate(java.lang.String beliefName, java.lang.Class<?> beliefValueClass) This method creates a goal template that positively matches a goal if it is of the type BeliefSetValueGoal, has the given belief name, and its value is of the given type.
static GoalTemplate	createBeliefSetValueGoalTemplate(java.lang.String beliefName, java.lang.Object beliefValue) This method creates a goal template that positively matches a goal if it is of the type BeliefSetValueGoal, has the given belief name, and has the given value.
static GoalTemplate	createBeliefTypeGoalTemplate(java.lang.String beliefName, java.lang.Class<?> beliefValueClass) This method creates a goal template that positively matches a goal if it is of the type BeliefValueGoal, has the given belief name, and its value is of the given type.
static GoalTemplate	createBeliefValueGoalTemplate(java.lang.String beliefName, java.lang.Object beliefValue) This method creates a goal template that positively matches a goal if it is of the type BeliefValueGoal, has the given belief name, and has the given value.
static GoalTemplate	createGoalTypeTemplate(java.lang.Class<? extends Goal> goalClass) This method creates a goal template that positively matches a goal if it is of the given type.
static GoalTemplate	createNullBeliefValueGoalTemplate(java.lang.String beliefName) This method creates a goal template that positively matches a goal if it is of the type BeliefValueGoal, has the given belief name, and is associated with a null value.
abstract boolean	match(Goal goal) This methods checks if the given goal matches this template.

Methods inherited from class java.lang.Object

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

Constructor Detail

GoalTemplate

public GoalTemplate()

Method Detail

createBeliefGoalTemplate

public static GoalTemplate createBeliefGoalTemplate(java.lang.String beliefName)

This method creates a goal template that positively matches a goal if it is of the type BeliefGoal and has the given belief name.

Parameters:

beliefName - the belief name to be matched.

Returns:

the goal template that checks if the goal is a BeliefGoal with the given name.

createBeliefSetTypeGoalTemplate

public static GoalTemplate createBeliefSetTypeGoalTemplate(java.lang.String beliefName,
                                                           java.lang.Class<?> beliefValueClass)

This method creates a goal template that positively matches a goal if it is of the type BeliefSetValueGoal, has the given belief name, and its value is of the given type.

Parameters:

beliefName - the belief name to be matched.

beliefValueClass - the value class name to be matched.

Returns:

the goal template that checks if the goal is a BeliefSetValueGoal with the given name and value of the given type.

createBeliefSetValueGoalTemplate

public static GoalTemplate createBeliefSetValueGoalTemplate(java.lang.String beliefName,
                                                            java.lang.Object beliefValue)

This method creates a goal template that positively matches a goal if it is of the type BeliefSetValueGoal, has the given belief name, and has the given value.

Parameters:

beliefName - the belief name to be matched.

beliefValue - the value to be matched.

Returns:

the goal template that checks if the goal is a BeliefSetValueGoal with the given name and value.

createBeliefTypeGoalTemplate

public static GoalTemplate createBeliefTypeGoalTemplate(java.lang.String beliefName,
                                                        java.lang.Class<?> beliefValueClass)

This method creates a goal template that positively matches a goal if it is of the type BeliefValueGoal, has the given belief name, and its value is of the given type.

Parameters:

beliefName - the belief name to be matched.

beliefValueClass - the value class name to be matched.

Returns:

the goal template that checks if the goal is a BeliefValueGoal with the given name and value of the given type.

createBeliefValueGoalTemplate

public static GoalTemplate createBeliefValueGoalTemplate(java.lang.String beliefName,
                                                         java.lang.Object beliefValue)

This method creates a goal template that positively matches a goal if it is of the type BeliefValueGoal, has the given belief name, and has the given value.

Parameters:

beliefName - the belief name to be matched.

beliefValue - the value to be matched.

Returns:

the goal template that checks if the goal is a BeliefValueGoal with the given name and value.

createGoalTypeTemplate

public static GoalTemplate createGoalTypeTemplate(java.lang.Class<? extends Goal> goalClass)

This method creates a goal template that positively matches a goal if it is of the given type.

Parameters:

goalClass - the goal class to be matched.

Returns:

the goal template that checks if the goal is of the given type.

createNullBeliefValueGoalTemplate

public static GoalTemplate createNullBeliefValueGoalTemplate(java.lang.String beliefName)

This method creates a goal template that positively matches a goal if it is of the type BeliefValueGoal, has the given belief name, and is associated with a null value.

Parameters:

beliefName - the belief name to be matched.

Returns:

the goal template that checks if the goal is a BeliefValueGoal with the given name and null value.

match

public abstract boolean match(Goal goal)

This methods checks if the given goal matches this template.

Parameters:

goal - the goal to be checked.

Returns:

true if the goal matches this template, false otherwise.