org.apache.marmotta.platform.reasoner.services

Class ReasoningSailProvider

java.lang.Object

org.apache.marmotta.platform.reasoner.services.ReasoningSailProvider

All Implemented Interfaces:

org.apache.marmotta.platform.core.api.triplestore.SailProvider, org.apache.marmotta.platform.core.api.triplestore.TransactionalSailProvider

@ApplicationScoped
public class ReasoningSailProvider
extends Object
implements org.apache.marmotta.platform.core.api.triplestore.TransactionalSailProvider

Add file description here!

Author: Sebastian Schaffert (sschaffert@apache.org)

Field Summary

Fields

Modifier and Type	Field and Description
static String	REASONING_ENABLED

Constructor Summary

Constructors

Constructor and Description
ReasoningSailProvider()

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	configurationChanged(org.apache.marmotta.platform.core.events.ConfigurationChangedEvent e)
TransactionalSailWrapper	createSail(TransactionalSail parent) Create the sail wrapper provided by this SailProvider
void	deleteProgram(String name) Remove the program with the given name.
String	getName() Return the name of the provider.
Program	getProgram(String name) Return the program with the given name.
boolean	isEnabled() Return true if this sail provider is enabled in the configuration.
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	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 java.lang.Object

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

Field Detail

REASONING_ENABLED

public static final String REASONING_ENABLED

See Also:

Constant Field Values

Constructor Detail

ReasoningSailProvider

public ReasoningSailProvider()

Method Detail

getName

public String getName()

Return the name of the provider. Used e.g. for displaying status information or logging.

Specified by:

getName in interface org.apache.marmotta.platform.core.api.triplestore.SailProvider

Returns:

createSail

public TransactionalSailWrapper createSail(TransactionalSail parent)

Create the sail wrapper provided by this SailProvider

Specified by:

createSail in interface org.apache.marmotta.platform.core.api.triplestore.TransactionalSailProvider

Parameters:

parent - the parent sail to wrap by the provider

Returns:

the wrapped sail

isEnabled

public boolean isEnabled()

Return true if this sail provider is enabled in the configuration.

Specified by:

isEnabled in interface org.apache.marmotta.platform.core.api.triplestore.SailProvider

Returns:

configurationChanged

public void configurationChanged(@Observes
                        org.apache.marmotta.platform.core.events.ConfigurationChangedEvent e)

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

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

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

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

reRunPrograms

public void reRunPrograms()

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

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

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