jade.semantics.kbase.filters.std.query

Class IREFilter

java.lang.Object

jade.semantics.kbase.filters.KBFilter

jade.semantics.kbase.filters.KBQueryFilter

jade.semantics.kbase.filters.std.query.IREFilter

public class IREFilter
extends KBQueryFilter

This filter applies when the query relates to the equality between an identifying expression and a term.

Version:

0.9 TODO process the reasons in the apply method

Author:

Vincent Pautret - France Telecom

Field Summary

Fields

Modifier and Type	Field and Description
private Formula	formulaPattern
private ListOfNodes	listOfNodes
private Formula	notPattern Pattern that must match to apply the filter
private Formula	pattern Pattern that must match to apply the filter
private Term	termPattern

Fields inherited from class jade.semantics.kbase.filters.KBFilter

myKBase

Constructor Summary

Constructors

Constructor and Description
IREFilter() Creates a new Filter on the patterns (B ??agent (= ??ire ??term)) and (B ??agent (not (= ??ire ??term))).

Method Summary

Modifier and Type	Method and Description
QueryResult	apply(Formula formula, ArrayList falsityReasons, QueryResult.BoolWrapper goOn) If if the formula matches the pattern (B ??agent (= ??ire ??term)) or (B ??agent (not (= ??ire ??term)) and ??agent equals the given agent term, this method returns a QueryResult corresponding to the solution to the question.
boolean	getObserverTriggerPatterns(Formula formula, Set set) By default, this method does nothing.
private void	getPattern(IdentifyingExpression ire) Creates the formulaPattern and the TermPattern by changing into meta variables all the variables that appear in the term of the identifying expression.
private QueryResult	notPatternProcess(Formula formula, ListOfNodes listOfNodes, Term termPattern, Formula formulaPattern, IdentifyingExpression ire, Term term) Returns a QueryResult corresponding to the answer to the query.
private QueryResult	patternProcess(Formula formula, ListOfNodes listOfNodes, Term termPattern, Formula formulaPattern, IdentifyingExpression ire, Term term) Returns a QueryResult corresponding to the answer to the query.

Methods inherited from class jade.semantics.kbase.filters.KBQueryFilter

toStrings

Methods inherited from class jade.semantics.kbase.filters.KBFilter

getMyKBase, setMyKBase

Methods inherited from class java.lang.Object

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

Field Detail

pattern

private Formula pattern

Pattern that must match to apply the filter

notPattern

private Formula notPattern

Pattern that must match to apply the filter

listOfNodes

private ListOfNodes listOfNodes

termPattern

private Term termPattern

formulaPattern

private Formula formulaPattern

Constructor Detail

IREFilter

public IREFilter()

Creates a new Filter on the patterns (B ??agent (= ??ire ??term)) and (B ??agent (not (= ??ire ??term))).

Method Detail

apply

public QueryResult apply(Formula formula,
                         ArrayList falsityReasons,
                         QueryResult.BoolWrapper goOn)

If if the formula matches the pattern (B ??agent (= ??ire ??term)) or (B ??agent (not (= ??ire ??term)) and ??agent equals the given agent term, this method returns a QueryResult corresponding to the solution to the question. Else it returns QueryResult.UNKNOWN.

Specified by:

apply in class KBQueryFilter

Parameters:

formula - a formula on which the filter is tested

agent - a term that represents the agent is trying to apply the filter

Returns:

a QueryResult as described above.

See Also:

KBase.query(Formula)

patternProcess

private QueryResult patternProcess(Formula formula,
                                   ListOfNodes listOfNodes,
                                   Term termPattern,
                                   Formula formulaPattern,
                                   IdentifyingExpression ire,
                                   Term term)

Returns a QueryResult corresponding to the answer to the query. If the ??term is a meta variable, returns a list of MatchResults with only one MatchResult containing the assignation between the meta varaible corresponding to ??term and the solution. If ??term is a constant, returns an empty list if ??term equals the answer to the query on formula, and null if not.

Parameters:

formula - the formula to be queried

Returns:

a QueryResult corresponding to the answer to the query.

notPatternProcess

private QueryResult notPatternProcess(Formula formula,
                                      ListOfNodes listOfNodes,
                                      Term termPattern,
                                      Formula formulaPattern,
                                      IdentifyingExpression ire,
                                      Term term)

Returns a QueryResult corresponding to the answer to the query. If the ??term is a meta variable, returns an empty list. If ??term is a constant, returns an empty list if ??term does not equal the answer to the query on formula, and null if not.

Parameters:

formula - the formula to be queried

Returns:

a QueryResult corresponding to the answer to the query.

getPattern

private void getPattern(IdentifyingExpression ire)

Creates the formulaPattern and the TermPattern by changing into meta variables all the variables that appear in the term of the identifying expression.

getObserverTriggerPatterns

public boolean getObserverTriggerPatterns(Formula formula,
                                          Set set)

By default, this method does nothing.

Specified by:

getObserverTriggerPatterns in class KBQueryFilter

Parameters:

formula - an observed formula

set - set of patterns. Each pattern corresponds to a kind a formula which, if it is asserted in the base, triggers the observer that observes the formula given in parameter.

Returns:

: FIXME missing javadoc, explain what does the returned boolean mean