org.apache.marmotta.kiwi.reasoner.sail

Class KiWiReasoningSail

java.lang.Object

org.openrdf.sail.helpers.SailWrapper

org.openrdf.sail.helpers.NotifyingSailWrapper

org.apache.marmotta.commons.sesame.transactions.wrapper.TransactionalSailWrapper

org.apache.marmotta.kiwi.reasoner.sail.KiWiReasoningSail

All Implemented Interfaces:

TransactionalSail, org.openrdf.sail.NotifyingSail, org.openrdf.sail.Sail, org.openrdf.sail.StackableSail

public class KiWiReasoningSail
extends TransactionalSailWrapper

This sail adds the KWRL reasoner to the stack of sails. Because the reasoner is tightly coupled with the database schema of KiWi, it requires that the persistence on the root of the stack is a KiWiStore.

Author: Sebastian Schaffert (sschaffert@apache.org)

Constructor Summary

Constructors

Constructor and Description
KiWiReasoningSail(TransactionalSail parent, ReasoningConfiguration config)

Method Summary

Methods

Modifier and Type	Method and Description
void	addProgram(Program program) Add a program to the reasoner.
void	addProgram(String name, InputStream data) Add a program to the reasoner using the given name.
void	deleteProgram(String name) Remove the program with the given name.
KiWiStore	getBaseStore() Return the KiWi store that is at the base of the SAIL stack.
ReasoningConfiguration	getConfig()
ReasoningEngine	getEngine() Return a reference to the underlying reasoning engine.
KiWiReasoningPersistence	getPersistence() Return a reference to the underlying database persistence layer.
Program	getProgram(String name) Return the program with the given name.
void	initialize()
info.aduna.iteration.CloseableIteration<Justification,org.openrdf.sail.SailException>	justify(long tripleId) List the justifications for the triple with the id given as argument.
info.aduna.iteration.CloseableIteration<Program,org.openrdf.sail.SailException>	listPrograms() List all reasoning programs currently stored in the triplestore.
void	reRunPrograms() Clean all inferred triples and re-run all reasoning rules.
void	shutDown()
void	updateProgram(Program program) Update the program given as argument.
void	updateProgram(String name, InputStream data) Update the program with the name given as argument using the data provided in the stream.

Methods inherited from class org.apache.marmotta.commons.sesame.transactions.wrapper.TransactionalSailWrapper

addTransactionListener, isTransactionsEnabled, removeTransactionListener, setTransactionsEnabled

Methods inherited from class org.openrdf.sail.helpers.NotifyingSailWrapper

addSailChangedListener, getBaseSail, getConnection, removeSailChangedListener, setBaseSail

Methods inherited from class org.openrdf.sail.helpers.SailWrapper

getDataDir, getValueFactory, isWritable, setDataDir, verifyBaseSailSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openrdf.sail.NotifyingSail

addSailChangedListener, getConnection, removeSailChangedListener

Methods inherited from interface org.openrdf.sail.Sail

getDataDir, getValueFactory, isWritable, setDataDir

Constructor Detail

KiWiReasoningSail

public KiWiReasoningSail(TransactionalSail parent,
                 ReasoningConfiguration config)

Method Detail

initialize

public void initialize()
                throws org.openrdf.sail.SailException

Specified by:

initialize in interface org.openrdf.sail.Sail

Overrides:

initialize in class org.openrdf.sail.helpers.SailWrapper

Throws:

org.openrdf.sail.SailException

shutDown

public void shutDown()
              throws org.openrdf.sail.SailException

Specified by:

shutDown in interface org.openrdf.sail.Sail

Overrides:

shutDown in class org.openrdf.sail.helpers.SailWrapper

Throws:

org.openrdf.sail.SailException

getBaseStore

public KiWiStore getBaseStore()

Return the KiWi store that is at the base of the SAIL stack. Throws an IllegalArgumentException in case the base store is not a KiWi store.

Returns:

getConfig

public ReasoningConfiguration getConfig()

addProgram

public void addProgram(String name,
              InputStream data)
                throws IOException,
                       org.openrdf.sail.SailException,
                       ParseException

Add a program to the reasoner using the given name. The program data will be read from the stream passed as second argument. The program is persisted to the database and the reasoning engine is notified of the added rules and immediately calculates the inferences. Inferencing in this case is synchronous, so the method only returns when the first round of reasoning is completed for all added rules.

If a program with this name already exists, a SailException is thrown. To update existing programs, please use updateProgram().

Parameters:

name - a unique name for the program

data - the program data in KWRL syntax

Throws:

IOException - in case the stream cannot be read

org.openrdf.sail.SailException - in case the program already exists

ParseException - in case the program cannot be parsed

addProgram

public void addProgram(Program program)
                throws org.openrdf.sail.SailException

Add a program to the reasoner. The program is persisted to the database and the reasoning engine is notified of the added rules and immediately calculates the inferences. Inferencing in this case is synchronous, so the method only returns when the first round of reasoning is completed for all added rules.

If a program with this name already exists, a SailException is thrown. To update existing programs, please use updateProgram().

Parameters:

program - the program data in KWRL syntax

Throws:

org.openrdf.sail.SailException - in case the program already exists

updateProgram

public void updateProgram(String name,
                 InputStream data)
                   throws IOException,
                          org.openrdf.sail.SailException,
                          ParseException

Update the program with the name given as argument using the data provided in the stream. This method will first calculate the difference between the previous version of the program and the new version of the program. It then updates the program in the database and notifies the engine of all removed and added rules.

Throws:

IOException - in case the stream cannot be read

org.openrdf.sail.SailException - in case the program already exists

ParseException - in case the program cannot be parsed

updateProgram

public void updateProgram(Program program)
                   throws org.openrdf.sail.SailException

Update the program given as argument. This method will first calculate the difference between the previous version of the program and the new version of the program. It then updates the program in the database and notifies the engine of all removed and added rules.

Parameters:

program - the updated version of the program

Throws:

org.openrdf.sail.SailException - in case a database error occurs

listPrograms

public info.aduna.iteration.CloseableIteration<Program,org.openrdf.sail.SailException> listPrograms()
                                                                                             throws org.openrdf.sail.SailException

List all reasoning programs currently stored in the triplestore.

Returns:

Throws:

org.openrdf.sail.SailException

getProgram

public Program getProgram(String name)
                   throws org.openrdf.sail.SailException

Return the program with the given name. In case the program does not exist, the method will return null.

Parameters:

name - the unique name of the program to retrieve

Returns:

the parsed program, or null in case a program with the given name does not exist

Throws:

org.openrdf.sail.SailException - in case an error occurs

deleteProgram

public void deleteProgram(String name)
                   throws org.openrdf.sail.SailException

Remove the program with the given name. This method will first remove the program from the database and then inform the reasoning engine to run cleanups.

If a program with this name does not exist, does nothing

Parameters:

name - the unique name of the program to remove

Throws:

org.openrdf.sail.SailException

reRunPrograms

public void reRunPrograms()

Clean all inferred triples and re-run all reasoning rules.

getEngine

public ReasoningEngine getEngine()

Return a reference to the underlying reasoning engine.

Returns:

getPersistence

public KiWiReasoningPersistence getPersistence()

Return a reference to the underlying database persistence layer.

Returns:

justify

public info.aduna.iteration.CloseableIteration<Justification,org.openrdf.sail.SailException> justify(long tripleId)
                                                                                              throws org.openrdf.sail.SailException

List the justifications for the triple with the id given as argument. For informational purposes.

Parameters:

tripleId -

Returns:

Throws:

org.openrdf.sail.SailException