Package com.semedy.reasoner.api.reasoning

Interface Reasoner

All Known Implementing Classes:

ReasonerNotThreaded, ReasonerThreadedFactsPartitioning, ReasonerThreadedRulesPartitioning

public interface Reasoner

a reasoner performs the reasoning process

Author:

angele

Method Summary

Modifier and Type	Method	Description
void	close()	Close the reasoner.
void	compile(IntensionalDB idb, ExtensionalDB[] edbs, ReasoningMonitor monitor, SystemMonitor smonitor, boolean topdown, int maxNumberOfResults, boolean streamReasoning, boolean streamReasoningWithRetracts)	compile rules for the reasoning process
List<TupleEnumerator>	evaluate()	starts evaluation and returns iterators for the results of the evaluation
void	evaluate(Receiver receiver)	Starts evaluation and feed the results into receiver
List<List<TupleEnumerator>>	evaluateSeveralQueries()	Starts evaluation for several queries.
void	evaluationFinished()	Is called after reasoning process is finished
List<Rule>	getQueries()	get queries after compilation
SymbolTable	getSymbolTable()	Returns the reasoning symbol table used to create new symbols during reasoning This reasoning symbol table is different to the base symbol table given by core.getSymbolTable() To decode reasoning results always use this one
void	register(InterruptFlag interruptFlag, List<EventResultReceiver> receiver, CoreReadLock edbReadLock)	Register several queries for events caused by sensors or in case of stream reasoning db caused by added facts. Every time events from sensors arrive there might be one or more new results. For every result receiver.receive is called This is used for stream reasoning
boolean	resultsContainedEDBRelations()	Have results contained whole edb relations?
boolean	test(Reader in, SymbolTable baseTable, ExternalDataTypeProvider datatypes, ExtensionalDB edb, boolean topdown, String path, BuiltinProvider builtinProvider, RewriterProvider rewriterProvider, Configuration config, Properties prp)	Testing the evaluation.

Method Details

test

boolean test(Reader in,
 SymbolTable baseTable,
 ExternalDataTypeProvider datatypes,
 ExtensionalDB edb,
 boolean topdown,
 String path,
 BuiltinProvider builtinProvider,
 RewriterProvider rewriterProvider,
 Configuration config,
 Properties prp)
      throws ReasoningException,
IOException,
ReasoningException,
InterruptedException,
SemReasonerException

Testing the evaluation.
The file contains rules and facts and solutions.
Solutions are given by the solutions predicate.
This method reads the file, stores the facts in an edb,
stores the rules in an idb, compiles and evaluates
the query and compares the results to the solutions

Parameters:

in - , reader for e.g. a file

baseTable - , symbol table

edb - , extensional database

topdown - , top down evaluation (magic sets)

path - , path to edb

builtinProvider - , provides builtins

rewriterProvider - , provides rewriters

config - , a configuration

prp - , builtin properties

Returns:

true, if results of evaluation are the same as the solutions inside the file

Throws:

ReasoningException

IOException

InterruptedException

SemReasonerException

evaluate

void evaluate(Receiver receiver)
       throws InterruptedException,
ReasoningException,
IOException,
SemReasonerException

Starts evaluation and feed the results into receiver

Parameters:

receiver - , the results are sent to receiver

Throws:

InterruptedException

ReasoningException

IOException

SemReasonerException

evaluate

List<TupleEnumerator> evaluate()
                        throws InterruptedException,
ReasoningException,
IOException,
SemReasonerException

starts evaluation and returns iterators for the results of the evaluation

Returns:

iterator for results

Throws:

InterruptedException

ReasoningException

IOException

SemReasonerException

evaluateSeveralQueries

List<List<TupleEnumerator>> evaluateSeveralQueries()
                                            throws InterruptedException,
ReasoningException,
IOException,
SemReasonerException

Starts evaluation for several queries.
For every query a list of iterators for the results is returned.

Returns:

, list of tuple enumerators for results

Throws:

InterruptedException

ReasoningException

IOException

SemReasonerException

close

void close()
    throws ReasoningException,
InterruptedException

Close the reasoner. Must be called to correctly finalize the reasoner

Throws:

ReasoningException

InterruptedException

evaluationFinished

void evaluationFinished()
                 throws IOException,
InterruptedException,
SemReasonerException

Is called after reasoning process is finished

Throws:

ReasoningException

IOException

InterruptedException

SemReasonerException

getSymbolTable

SymbolTable getSymbolTable()

Returns the reasoning symbol table used to create new symbols during reasoning
This reasoning symbol table is different to the base symbol table given by core.getSymbolTable()
To decode reasoning results always use this one

Returns:

compile

void compile(IntensionalDB idb,
 ExtensionalDB[] edbs,
 ReasoningMonitor monitor,
 SystemMonitor smonitor,
 boolean topdown,
 int maxNumberOfResults,
 boolean streamReasoning,
 boolean streamReasoningWithRetracts)
      throws InterruptedException,
IOException,
SemReasonerException

compile rules for the reasoning process

Parameters:

idb - , intensional db

edbs - extensional dbs

monitor - , monitoring reasoning and memory consumption

smonitor - , system monitor, used by system may be null

topdown - , execution is done top down (magic sets)

streamReasoningWithRetracts - , retracts in stream reasoning

streamReasoning - , stream reasoning is done

Throws:

InterruptedException

IOException

SemReasonerException

register

void register(InterruptFlag interruptFlag,
 List<EventResultReceiver> receiver,
 CoreReadLock edbReadLock)
       throws InterruptedException,
IOException,
SemReasonerException

Register several queries for events caused by sensors or in case of
stream reasoning db caused by added facts.
Every time events from sensors arrive there might be one or more new results.
For every result receiver.receive is called
This is used for stream reasoning

Parameters:

interruptFlag - , interrupt

receiver -

edbReadLock - , the read lock for the extensional db, used during reasoning

Throws:

IOException

SemReasonerException

InterruptedException

resultsContainedEDBRelations

boolean resultsContainedEDBRelations()

Have results contained whole edb relations?

Returns:

getQueries

List<Rule> getQueries()

get queries after compilation

Returns: