jade.semantics.kbase.filters

Class FilterKBaseImpl

java.lang.Object

jade.semantics.kbase.KBaseDecorator

jade.semantics.kbase.filters.FilterKBaseImpl

All Implemented Interfaces:

FilterKBase, KBase

Direct Known Subclasses:

CasaKB

public class FilterKBaseImpl
extends KBaseDecorator
implements FilterKBase

Class that implements the filter belief base api. The data are stored in an ArrayListKBaseImpl by default. The filters of the base are stored in ArrayLists.

Version:

0.9, 0.9, 0.9

Author:

Vincent Pautret - France Telecom

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	FilterKBaseImpl.Cache

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList	assertFilterList List of assertion filters
private Formula	bPattern
private FilterKBaseImpl.Cache	cache Cache
private Logger	logger Logger
protected ArrayList	queryFilterList List of query filters

Fields inherited from class jade.semantics.kbase.KBaseDecorator

decorated

Fields inherited from interface jade.semantics.kbase.filters.FilterKBase

END, FRONT

Constructor Summary

Constructors

Constructor and Description
FilterKBaseImpl(KBase decorated) Creates a new belief base.
FilterKBaseImpl(KBase decorated, FilterKBaseLoader loader) Creates a new belief base.

Method Summary

Modifier and Type	Method and Description
void	addFiltersDefinition(FiltersDefinition filtersDefinition) METHODS TO ADD NEW FILTERS *
void	addKBAssertFilter(KBAssertFilter filter) Adds an assert filter to the belief base
void	addKBAssertFilter(KBAssertFilter filter, int index) Adds an assert filter to the belief base at the specified index.
private void	addKBFilter(KBFilter filter, int index) Adds a new KBFilter.
void	addKBQueryFilter(KBQueryFilter filter) Adds a query filter to the belief base
void	addKBQueryFilter(KBQueryFilter filter, int index) Adds a query filter to the belief base at the specified index.
void	addObserver(Observer obs) Do not forget to initialise observers once added to the KBase by using observer.update(null); Only observers added in the setupKBase method are automatically initialised.
void	assertFormula(Formula formula) METHODS TO ACCESS KBASE *
void	getObserverTriggerPatterns(Formula formula, Set result) Calls the getObserverTriggerPatterns method of each query filters.
QueryResult	query(Formula formula, ArrayList reasons)
void	removeKBAssertFilter(Finder filterIdentifier) METHODS TO REMOVE FILTERS *
void	removeKBQueryFilter(Finder filterIdentifier) Removes the query filters that are identified by the specified finder.
ArrayList	toStrings() DISPLAY METHODS *
private void	toStrings(ArrayList result, ArrayList strings)
void	viewFilterQuery() For debugging purpose only

Methods inherited from class jade.semantics.kbase.KBaseDecorator

addClosedPredicate, eval, getAgentName, getDecorated, getWrappingKBase, isClosed, query, queryRef, queryRef, queryRefSingleTerm, removeClosedPredicate, removeFormula, removeObserver, removeObserver, retractFormula, setAgentName, setWrappingKBase, updateObservers

Methods inherited from class java.lang.Object

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

Methods inherited from interface jade.semantics.kbase.KBase

addClosedPredicate, eval, getAgentName, getWrappingKBase, isClosed, query, queryRef, queryRef, queryRefSingleTerm, removeClosedPredicate, removeFormula, removeObserver, removeObserver, retractFormula, setAgentName, setWrappingKBase, updateObservers

Field Detail

bPattern

private final Formula bPattern

assertFilterList

protected ArrayList assertFilterList

List of assertion filters

queryFilterList

protected ArrayList queryFilterList

List of query filters

logger

private Logger logger

Logger

cache

private FilterKBaseImpl.Cache cache

Cache

Constructor Detail

FilterKBaseImpl

public FilterKBaseImpl(KBase decorated)

Creates a new belief base.

Parameters:

decorated - the wrapped kbase used to store the facts, which should not be null.

FilterKBaseImpl

public FilterKBaseImpl(KBase decorated,
                       FilterKBaseLoader loader)

Creates a new belief base.

Parameters:

decorated - the wrapped kbase used to store the facts, which should not be null.

loader - a particular filters loader.

Method Detail

assertFormula

public void assertFormula(Formula formula)

METHODS TO ACCESS KBASE *

Specified by:

assertFormula in interface KBase

Overrides:

assertFormula in class KBaseDecorator

Parameters:

formula - the formula to assert.

query

public QueryResult query(Formula formula,
                         ArrayList reasons)

Specified by:

query in interface KBase

Overrides:

query in class KBaseDecorator

addFiltersDefinition

public void addFiltersDefinition(FiltersDefinition filtersDefinition)

METHODS TO ADD NEW FILTERS *

Specified by:

addFiltersDefinition in interface FilterKBase

Parameters:

filtersDefinition - the list of filters

addKBFilter

private void addKBFilter(KBFilter filter,
                         int index)

Adds a new KBFilter.

Parameters:

filter - a filter

index - the index to add the filter

addKBAssertFilter

public void addKBAssertFilter(KBAssertFilter filter)

Description copied from interface: FilterKBase

Adds an assert filter to the belief base

Specified by:

addKBAssertFilter in interface FilterKBase

Parameters:

filter - an assert filter

addKBAssertFilter

public void addKBAssertFilter(KBAssertFilter filter,
                              int index)

Description copied from interface: FilterKBase

Adds an assert filter to the belief base at the specified index. It is possible the FRONT or END constants to put the filter at the beginning of the lits or at the end of the list.

Specified by:

addKBAssertFilter in interface FilterKBase

Parameters:

filter - an assert filter

index - the index in the list of filters to add a new filter

addKBQueryFilter

public void addKBQueryFilter(KBQueryFilter filter)

Description copied from interface: FilterKBase

Adds a query filter to the belief base

Specified by:

addKBQueryFilter in interface FilterKBase

Parameters:

filter - a queryFilter

addKBQueryFilter

public void addKBQueryFilter(KBQueryFilter filter,
                             int index)

Description copied from interface: FilterKBase

Adds a query filter to the belief base at the specified index. It is possible the FRONT or END constants to put the filter at the beginning of the lits or at the end of the list.

Specified by:

addKBQueryFilter in interface FilterKBase

Parameters:

filter - a queryFilter

index - the index in the list of filters to add a new filter

removeKBAssertFilter

public void removeKBAssertFilter(Finder filterIdentifier)

METHODS TO REMOVE FILTERS *

Specified by:

removeKBAssertFilter in interface FilterKBase

Parameters:

filterIdentifier - a finder

removeKBQueryFilter

public void removeKBQueryFilter(Finder filterIdentifier)

Description copied from interface: FilterKBase

Removes the query filters that are identified by the specified finder.

Specified by:

removeKBQueryFilter in interface FilterKBase

Parameters:

filterIdentifier - a finder

addObserver

public void addObserver(Observer obs)

Do not forget to initialise observers once added to the KBase by using observer.update(null); Only observers added in the setupKBase method are automatically initialised.

Specified by:

addObserver in interface KBase

Overrides:

addObserver in class KBaseDecorator

Parameters:

obs - the observer to add

getObserverTriggerPatterns

public void getObserverTriggerPatterns(Formula formula,
                                       Set result)

Description copied from interface: FilterKBase

Calls the getObserverTriggerPatterns method of each query filters. At least, the pattern corresponding to the observed formula is returned.

Specified by:

getObserverTriggerPatterns in interface FilterKBase

Parameters:

formula - an observed formula

toStrings

public ArrayList toStrings()

DISPLAY METHODS *

Specified by:

toStrings in interface KBase

Overrides:

toStrings in class KBaseDecorator

Returns:

the list of believed facts in this belief base.

toStrings

private void toStrings(ArrayList result,
                       ArrayList strings)

viewFilterQuery

public void viewFilterQuery()

For debugging purpose only