Package com.semedy.reasoner.api.builtin

Class AbstractConnector

java.lang.Object

com.semedy.reasoner.api.builtin.AbstractConnector

All Implemented Interfaces:

Builtin, Connector

Direct Known Subclasses:

ReasonerConnector, SQLiteConnector

public abstract class AbstractConnector
extends Object
implements Connector

coordinates calls to connectors and performs constraint reasoning for connectors

Author:

angele

Constructor Summary

Constructors

Constructor	Description
AbstractConnector()

Method Summary

Modifier and Type	Method	Description
static void	clearData()
abstract Builtin	cloneBuiltin()	clone the builtin
boolean	eval()	Create queries from available restrictions.
void	evaluationFinished()	call back function.
abstract String[]	getArgumentDescriptions()	get descriptions for the different arguments
abstract int	getArity()	get the arity of the builtin
static List<AbstractConnector>	getConnectorInstances()	get an instance from each connector type for evaluation
abstract String	getDescription()	get a description for the builtin
abstract String	getName()	get the name of the builtin
int	getNumberOfRestrictions()
BuiltinType	getType()	get the type of the builtin
long	getUID()
abstract long	getWeight(BitSet grounds, BitSet variableInstantiations, Object[] args)	the weight of the builtin.
abstract void	init(Object[] args)	initialize the builtin
void	input(long[] input)	Feed the built-in with an input tuple.
boolean	isEvaluable(BitSet grounds, BitSet variableInstantiations, Object[] args)	is builtin evaluable with a certain instantiation of variables
boolean	isInternal()	is it a builtin for internal use only
abstract BitSet	objectGeneratingArguments(BitSet grounds, BitSet variableInstantiations, Object[] args)	In which argument position are new objects created
boolean	readsSymbolTable()	does the builtin read the symbol table
void	setProperties(Properties prp)	set the sytem properties
void	setSymbolTable(SymbolTable symbolTable)	set the symbol table
void	start(BitSet grounds, BuiltinReceiver receiver)	Start feeding the built-in with input values.
void	stop()	stop feeding the built-in with input values
boolean	writesSymbolTable()	does the builtin write into the symbol table

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.semedy.reasoner.api.builtin.Builtin

clear

Constructor Details

AbstractConnector

public AbstractConnector()

Method Details

getNumberOfRestrictions

public int getNumberOfRestrictions()

getConnectorInstances

public static List<AbstractConnector> getConnectorInstances()

get an instance from each connector type for evaluation

Returns:

writesSymbolTable

public boolean writesSymbolTable()

Description copied from interface: Builtin

does the builtin write into the symbol table

Specified by:

writesSymbolTable in interface Builtin

Returns:

true if it writes to the symbol table

setProperties

public void setProperties(Properties prp)

Description copied from interface: Builtin

set the sytem properties

Specified by:

setProperties in interface Builtin

Parameters:

prp - , properties

setSymbolTable

public void setSymbolTable(SymbolTable symbolTable)

Description copied from interface: Builtin

set the symbol table

Specified by:

setSymbolTable in interface Builtin

Parameters:

symbolTable - , the symbol table

readsSymbolTable

public boolean readsSymbolTable()

Description copied from interface: Builtin

does the builtin read the symbol table

Specified by:

readsSymbolTable in interface Builtin

Returns:

true if it reads the symbol table

objectGeneratingArguments

public abstract BitSet objectGeneratingArguments(BitSet grounds,
 BitSet variableInstantiations,
 Object[] args)
                                          throws BuiltinException

Description copied from interface: Builtin

In which argument position are new objects created

Specified by:

objectGeneratingArguments in interface Builtin

Parameters:

grounds - , ground argument positions

variableInstantiations - , instantiated variables

args - , arguments of the literal

Returns:

each bit indicates the argument position where new objects are created

Throws:

BuiltinException

isInternal

public boolean isInternal()

Description copied from interface: Builtin

is it a builtin for internal use only

Specified by:

isInternal in interface Builtin

Returns:

isEvaluable

public boolean isEvaluable(BitSet grounds,
 BitSet variableInstantiations,
 Object[] args)
                    throws BuiltinException

Description copied from interface: Builtin

is builtin evaluable with a certain instantiation of variables

Specified by:

isEvaluable in interface Builtin

Parameters:

grounds - , which arguments are ground

variableInstantiations - , which variables are instantiated

args - , the arguments

Returns:

was it evaluable

Throws:

BuiltinException

getType

public BuiltinType getType()

Description copied from interface: Builtin

get the type of the builtin

Specified by:

getType in interface Builtin

Returns:

the type of the built-in

init

public abstract void init(Object[] args)
                   throws BuiltinException,
InterruptedException,
IOException

Description copied from interface: Builtin

initialize the builtin

Specified by:

init in interface Builtin

Parameters:

args - , the builtin arguments

Throws:

InterruptedException

IOException

BuiltinException

getWeight

public abstract long getWeight(BitSet grounds,
 BitSet variableInstantiations,
 Object[] args)

Description copied from interface: Builtin

the weight of the builtin. Determines when the builtin is executed in a rule

Specified by:

getWeight in interface Builtin

Parameters:

grounds - , ground arguments

variableInstantiations - , instantiated variables

args - , arguments of the builtin

Returns:

the weight of the builtin (influences the position in the rule)

getName

public abstract String getName()

Description copied from interface: Builtin

get the name of the builtin

Specified by:

getName in interface Builtin

Returns:

the name of the built-in

getDescription

public abstract String getDescription()

Description copied from interface: Builtin

get a description for the builtin

Specified by:

getDescription in interface Builtin

Returns:

a description of the built-in

getArity

public abstract int getArity()

Description copied from interface: Builtin

get the arity of the builtin

Specified by:

getArity in interface Builtin

Returns:

the arity of the built-in

getArgumentDescriptions

public abstract String[] getArgumentDescriptions()

Description copied from interface: Builtin

get descriptions for the different arguments

Specified by:

getArgumentDescriptions in interface Builtin

Returns:

a description of the arguments of the built-in

evaluationFinished

public void evaluationFinished()
                        throws BuiltinException,
InterruptedException

Description copied from interface: Builtin

call back function. Is called when the whole evaluation has been finished

Specified by:

evaluationFinished in interface Builtin

Throws:

BuiltinException

InterruptedException

cloneBuiltin

public abstract Builtin cloneBuiltin()

Description copied from interface: Builtin

clone the builtin

Specified by:

cloneBuiltin in interface Builtin

Returns:

the cloned built-in

stop

public void stop()
          throws ReasoningException,
InterruptedException,
SemReasonerException,
IOException

Description copied from interface: Connector

stop feeding the built-in with input values

Specified by:

stop in interface Connector

Throws:

InterruptedException

SemReasonerException

IOException

ReasoningException

start

public void start(BitSet grounds,
 BuiltinReceiver receiver)
           throws ReasoningException,
InterruptedException,
IOException

Description copied from interface: Connector

Start feeding the built-in with input values. Grounds indicates the ground arguments;
receiver catches the results of the evaluation

Specified by:

start in interface Connector

Parameters:

grounds - , the arguments which are ground

receiver - , the receiver receiving the results

Throws:

ReasoningException

InterruptedException

IOException

getUID

public long getUID()

input

public void input(long[] input)
           throws InterruptedException,
IOException,
SemReasonerException

Description copied from interface: Connector

Feed the built-in with an input tuple.
The built-in may produce at any time results,
may be during feeding or may be after calling stop

Specified by:

input in interface Connector

Parameters:

input - encoded input tuple

Throws:

InterruptedException

IOException

SemReasonerException

eval

public boolean eval()
             throws SemReasonerException,
IOException,
InterruptedException

Create queries from available restrictions.
Check them against older queries for subsumption.
Execute queries.

Returns:

Throws:

SemReasonerException

IOException

InterruptedException

clearData

public static void clearData()