Package com.semedy.reasoner.builtin.connector

Class TestMultiRelationalCached

java.lang.Object

com.semedy.reasoner.api.builtin.CachedConnector

com.semedy.reasoner.builtin.connector.TestMultiRelationalCached

All Implemented Interfaces:

Builtin, Connector

public class TestMultiRelationalCached
extends CachedConnector
implements Connector

Constructor Summary

Constructors

Constructor	Description
TestMultiRelationalCached()

Method Summary

Modifier and Type	Method	Description
void	clear()	frees up allocated resources
Builtin	cloneBuiltin()	clone the builtin
void	evaluationFinished()	call back function.
String[]	getArgumentDescriptions()	get descriptions for the different arguments
int	getArity()	get the arity of the builtin
String	getDescription()	get a description for the builtin
String	getName()	get the name of the builtin
BuiltinType	getType()	get the type of the builtin
long	getWeight(BitSet grounds, BitSet variableInstantiations, Object[] args)	the weight of the builtin.
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
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

Constructor Details

TestMultiRelationalCached

public TestMultiRelationalCached()

Method Details

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

Specified by:

isEvaluable in class CachedConnector

Parameters:

grounds - , which arguments are ground

variableInstantiations - , which variables are instantiated

args - , the arguments

Returns:

was it evaluable

Throws:

BuiltinException

setProperties

public void setProperties(Properties prp)

Description copied from interface: Builtin

set the sytem properties

Specified by:

setProperties in interface Builtin

Specified by:

setProperties in class CachedConnector

Parameters:

prp - , properties

init

public void init(Object[] args)

Description copied from interface: Builtin

initialize the builtin

Specified by:

init in interface Builtin

Specified by:

init in class CachedConnector

Parameters:

args - , the builtin arguments

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

Overrides:

evaluationFinished in class CachedConnector

Throws:

BuiltinException

InterruptedException

setSymbolTable

public void setSymbolTable(SymbolTable symbolTable)

Description copied from interface: Builtin

set the symbol table

Specified by:

setSymbolTable in interface Builtin

Specified by:

setSymbolTable in class CachedConnector

Parameters:

symbolTable - , the symbol table

getWeight

public 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

Specified by:

getWeight in class CachedConnector

Parameters:

grounds - , ground arguments

variableInstantiations - , instantiated variables

args - , arguments of the builtin

Returns:

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

objectGeneratingArguments

public 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

Specified by:

objectGeneratingArguments in class CachedConnector

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

getName

public String getName()

Description copied from interface: Builtin

get the name of the builtin

Specified by:

getName in interface Builtin

Specified by:

getName in class CachedConnector

Returns:

the name of the built-in

getArity

public int getArity()

Description copied from interface: Builtin

get the arity of the builtin

Specified by:

getArity in interface Builtin

Specified by:

getArity in class CachedConnector

Returns:

the arity of the built-in

getType

public BuiltinType getType()

Description copied from interface: Builtin

get the type of the builtin

Specified by:

getType in interface Builtin

Specified by:

getType in class CachedConnector

Returns:

the type of the built-in

isInternal

public boolean isInternal()

Description copied from interface: Builtin

is it a builtin for internal use only

Specified by:

isInternal in interface Builtin

Specified by:

isInternal in class CachedConnector

Returns:

getArgumentDescriptions

public String[] getArgumentDescriptions()

Description copied from interface: Builtin

get descriptions for the different arguments

Specified by:

getArgumentDescriptions in interface Builtin

Specified by:

getArgumentDescriptions in class CachedConnector

Returns:

a description of the arguments of the built-in

getDescription

public String getDescription()

Description copied from interface: Builtin

get a description for the builtin

Specified by:

getDescription in interface Builtin

Specified by:

getDescription in class CachedConnector

Returns:

a description of the built-in

readsSymbolTable

public boolean readsSymbolTable()

Description copied from interface: Builtin

does the builtin read the symbol table

Specified by:

readsSymbolTable in interface Builtin

Specified by:

readsSymbolTable in class CachedConnector

Returns:

true if it reads the symbol table

writesSymbolTable

public boolean writesSymbolTable()

Description copied from interface: Builtin

does the builtin write into the symbol table

Specified by:

writesSymbolTable in interface Builtin

Specified by:

writesSymbolTable in class CachedConnector

Returns:

true if it writes to the symbol table

start

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

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

Specified by:

start in class CachedConnector

Parameters:

grounds - , the arguments which are ground

receiver - , the receiver receiving the results

Throws:

ReasoningException

InterruptedException

input

public void input(long[] input)

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

Specified by:

input in class CachedConnector

Parameters:

input - encoded input tuple

stop

public void stop()
          throws SemReasonerException

Description copied from interface: Connector

stop feeding the built-in with input values

Specified by:

stop in interface Connector

Specified by:

stop in class CachedConnector

Throws:

SemReasonerException

cloneBuiltin

public Builtin cloneBuiltin()

Description copied from interface: Builtin

clone the builtin

Specified by:

cloneBuiltin in interface Builtin

Specified by:

cloneBuiltin in class CachedConnector

Returns:

the cloned built-in

clear

public void clear()

Description copied from interface: Builtin

frees up allocated resources

Specified by:

clear in interface Builtin

Specified by:

clear in class CachedConnector