Package jade.domain.KBManagement

Class DBKB

java.lang.Object

jade.domain.KBManagement.KB

jade.domain.KBManagement.DBKB

Direct Known Subclasses:

DFDBKB

public abstract class DBKB
extends KB

This class provides an abstract implementation of the KB interface where information are stored in a database.

Author:

Roland Mungenast - Profactor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	DBKB.ConnectionWrapper
protected class	DBKB.EmptyKBIterator	Inner class EmptyKBIterator

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	cleanTables	Specifies whether the KB should delete all existing tables for the DF at startup
protected String	driver	Used database driver

Fields inherited from class jade.domain.KBManagement.KB

lm, logger, sr

Constructor Summary

Constructors

Constructor	Description
DBKB(String url, int maxResultLimit, boolean cleanTables)	Constructs a new DFKB and establishes a connection to the database at the given URL using the sun.jdbc.odbc.JdbcOdbcDriver driver.
DBKB(String drv, String url, int maxResultLimit, boolean cleanTables)	Constructs a new DFKB and establishes a connection to the database.
DBKB(String drv, String url, String username, String password, int maxResultLimit, boolean cleanTables)	Constructs a new DFKB and establishes a connection to the database.

Method Summary

Modifier and Type	Method	Description
protected Connection	createDBConnection(String url, String username, String password)
protected DBKB.ConnectionWrapper	getConnectionWrapper()
abstract Enumeration	getSubscriptions()
protected void	initConnectionWrapper(DBKB.ConnectionWrapper wrapper)	Subclasses can redefine this method to provide implementation specific ConnectionWrapper initializations
protected Object	insert(Object name, Object fact)
protected abstract Object	insertSingle(Object name, Object fact)
KBIterator	iterator(Object template)
protected abstract KBIterator	iteratorSingle(Object template)
protected Object	remove(Object name)
protected abstract Object	removeSingle(Object name)
List	search(Object template, int maxResult)
protected abstract List	searchSingle(Object template, int maxResult)
abstract void	setup()	This method is called by the KB Factory and is a placeholder for implementation specific KB initializations.
void	subscribe(Object template, SubscriptionResponder.Subscription s)
protected abstract void	subscribeSingle(Object template, SubscriptionResponder.Subscription s)
void	unsubscribe(SubscriptionResponder.Subscription s)
protected abstract void	unsubscribeSingle(SubscriptionResponder.Subscription s)

Methods inherited from class jade.domain.KBManagement.KB

deregister, register, search, setLeaseManager, setSubscriptionResponder

Methods inherited from class java.lang.Object

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

Field Detail

driver

protected String driver

Used database driver

cleanTables

protected boolean cleanTables

Specifies whether the KB should delete all existing tables for the DF at startup

Constructor Detail

DBKB

public DBKB(String url,
            int maxResultLimit,
            boolean cleanTables)
     throws SQLException

Constructs a new DFKB and establishes a connection to the database at the given URL using the sun.jdbc.odbc.JdbcOdbcDriver driver.

Parameters:

maxResultLimit - internal limit for the number of maximum search results.

url - database URL

maxResultLimit - JADE internal limit for the maximum number of search results

cleanTables - specifies whether the KB should delete all existing tables for the DF at startup

Throws:

SQLException - an error occured while opening a connection to the database

DBKB

public DBKB(String drv,
            String url,
            int maxResultLimit,
            boolean cleanTables)
     throws SQLException

Constructs a new DFKB and establishes a connection to the database.

Parameters:

maxResultLimit - internal limit for the number of maximum search results.

drv - database driver

url - database URL

user - database user name

passwd - database password

maxResultLimit - JADE internal limit for the maximum number of search results

cleanTables - specifies whether the KB should delete all existing tables for the DF at startup

Throws:

SQLException - an error occured while opening a connection to the database

DBKB

public DBKB(String drv,
            String url,
            String username,
            String password,
            int maxResultLimit,
            boolean cleanTables)
     throws SQLException

Constructs a new DFKB and establishes a connection to the database.

Parameters:

maxResultLimit - internal limit for the number of maximum search results.

drv - database driver

url - database URL

user - database user name

passwd - database password

maxResultLimit - JADE internal limit for the maximum number of search results

cleanTables - specifies whether the KB should delete all existing tables for the DF at startup

Throws:

SQLException - an error occured while opening a connection to the database

Method Detail

setup

public abstract void setup()
                    throws SQLException

This method is called by the KB Factory and is a placeholder for implementation specific KB initializations.

Throws:

SQLException

createDBConnection

protected Connection createDBConnection(String url,
                                        String username,
                                        String password)
                                 throws SQLException

Throws:

SQLException

getConnectionWrapper

protected final DBKB.ConnectionWrapper getConnectionWrapper()
                                                     throws SQLException

Throws:

SQLException

initConnectionWrapper

protected void initConnectionWrapper(DBKB.ConnectionWrapper wrapper)
                              throws SQLException

Subclasses can redefine this method to provide implementation specific ConnectionWrapper initializations

Throws:

SQLException

insert

protected Object insert(Object name,
                        Object fact)

Specified by:

insert in class KB

insertSingle

protected abstract Object insertSingle(Object name,
                                       Object fact)
                                throws SQLException

Throws:

SQLException

remove

protected Object remove(Object name)

Specified by:

remove in class KB

removeSingle

protected abstract Object removeSingle(Object name)
                                throws SQLException

Throws:

SQLException

search

public List search(Object template,
                   int maxResult)

Specified by:

search in class KB

searchSingle

protected abstract List searchSingle(Object template,
                                     int maxResult)
                              throws SQLException

Throws:

SQLException

iterator

public KBIterator iterator(Object template)

Specified by:

iterator in class KB

iteratorSingle

protected abstract KBIterator iteratorSingle(Object template)
                                      throws SQLException

Throws:

SQLException

subscribe

public void subscribe(Object template,
                      SubscriptionResponder.Subscription s)
               throws NotUnderstoodException

Specified by:

subscribe in class KB

Throws:

NotUnderstoodException

subscribeSingle

protected abstract void subscribeSingle(Object template,
                                        SubscriptionResponder.Subscription s)
                                 throws SQLException,
                                        NotUnderstoodException

Throws:

SQLException

NotUnderstoodException

getSubscriptions

public abstract Enumeration getSubscriptions()

Specified by:

getSubscriptions in class KB

unsubscribe

public void unsubscribe(SubscriptionResponder.Subscription s)

Specified by:

unsubscribe in class KB

unsubscribeSingle

protected abstract void unsubscribeSingle(SubscriptionResponder.Subscription s)
                                   throws SQLException

Throws:

SQLException