jade.semantics.kbase.filters

Class KBQueryFilter

java.lang.Object

jade.semantics.kbase.filters.KBFilter

jade.semantics.kbase.filters.KBQueryFilter

Direct Known Subclasses:

AndFilter, CasaQueryFilter, ExistsFilter, ForallFilter, HornClauseFilter.HornClauseQueryFilter, IREFilter, IsdoingQueryFilter, KBQueryFilterAdapter, OrFilter

public abstract class KBQueryFilter
extends KBFilter

This abstact class provides methods the developer has to override to create a new filter for querying the belief base about a formula.

Version:

0.9

Author:

Vincent Pautret - France Telecom

Field Summary

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

myKBase

Constructor Summary

Constructors

Constructor and Description
KBQueryFilter()

Method Summary

Modifier and Type	Method and Description
abstract QueryResult	apply(Formula formula, ArrayList falsityReasons, QueryResult.BoolWrapper goOn) Returns a QueryResult object, similar to the one returned by the query operation of the KBase interface.
abstract boolean	getObserverTriggerPatterns(Formula formula, Set set) Fills the set given in parameter with the patterns manipulated by this filter and likely to trigger the observers which observe the formula given in parameter.
ArrayList	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

Constructor Detail

KBQueryFilter

public KBQueryFilter()

Method Detail

apply

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

Returns a QueryResult object, similar to the one returned by the query operation of the KBase interface. Such an objet can be - QueryResult.UNKNOWN if the filter is not applicable or returns no solution, - QueryResult.KNOWN if the filter returns a solution and the formula holds no meta-variable, - a not empty QueryResult object if the filter returns solutions and the formula holds meta-variables.

Parameters:

formula - a formula on which the filter is tested

falsityReasons - a list of believed formulas, which must be filled to explain a null result of the method. If the filter is actually not applicable, this list must not be modified. Warning: when calling the method, this parameter should not be null

Returns:

a QueryResult as previously described.

See Also:

KBase.query(Formula)

getObserverTriggerPatterns

public abstract boolean getObserverTriggerPatterns(Formula formula,
                                                   Set set)

Fills the set given in parameter with the patterns manipulated by this filter and likely to trigger the observers which observe the formula given in parameter.

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

toStrings

public ArrayList toStrings()