Package com.semedy.reasoner.builtin.directfilter

Class DirectLess

java.lang.Object

com.semedy.reasoner.builtin.directfilter.DirectLess

All Implemented Interfaces:

Builtin, Receiver, DirectFilterBuiltin

public class DirectLess
extends Object

Author:

angele

Constructor Summary

Constructors

Constructor	Description
DirectLess()

Method Summary

Modifier and Type	Method	Description
void	addRelation(ReasoningRelation relation)	add a whole relation at the beginning
void	clear()	frees up allocated resources
Builtin	cloneBuiltin()	clone the builtin
void	evaluate()
void	evaluationFinished()	call back function.
String[]	getArgumentDescriptions()	get descriptions for the different arguments
int	getArity()	arity of the tuples
String	getDescription()	get a description for the builtin
String	getName()	get the name of the builtin
static int	getTestCode()
TupleStore	getTupleStore()	get the basic tuple store
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
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
boolean	receiveRelation(ReasoningRelation relation)	receive a whole relation
boolean	receiveTuple(int tuple)	receive a single tuple
boolean	receiveTuple(long[] tuple)	receive a single tuple
boolean	receiveTuple(TupleBuffer tuple)	receive a single tuple
static void	resetTestCode()
void	setParameters(BuiltinReceiver receiver, int sourceArity, int destArity, BitSet variablePositions)	set parameters
void	setProperties(Properties prp)	set the sytem properties
void	setSymbolTable(SymbolTable symbolTable)	set the symbol table
Receiver	startTuples(Receiver source, boolean check4Duplicates)	start delivering single tuples
void	tuplesFinished(boolean isBottomUp)	finish delivering single tuples
void	tuplesFinished(String annotation, ReasoningRelation T1, ReasoningRelation T2)	Finish delivering single tuples.
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

DirectLess

public DirectLess()

Method Details

getName

public 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

setProperties

public void setProperties(Properties prp)

Description copied from interface: Builtin

set the sytem properties

Parameters:

prp - , properties

cloneBuiltin

public Builtin cloneBuiltin()

Description copied from interface: Builtin

clone the builtin

Specified by:

cloneBuiltin in interface Builtin

Returns:

the cloned built-in

resetTestCode

public static void resetTestCode()

getTestCode

public static int getTestCode()

setParameters

public void setParameters(BuiltinReceiver receiver,
 int sourceArity,
 int destArity,
 BitSet variablePositions)

Description copied from interface: DirectFilterBuiltin

set parameters

Specified by:

setParameters in interface DirectFilterBuiltin

Parameters:

receiver - , the callback to get results

sourceArity - , the source arity

destArity - , the destination arity

variablePositions - , the variables from left

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

init

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

Description copied from interface: Builtin

initialize the builtin

Specified by:

init in interface Builtin

Parameters:

args - , the builtin arguments

Throws:

InterruptedException

IOException

SemReasonerException

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

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

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

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

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

getArity

public int getArity()

Description copied from interface: Receiver

arity of the tuples

Specified by:

getArity in interface Builtin

Specified by:

getArity in interface Receiver

Returns:

the arity of the receiver

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

isInternal

public boolean isInternal()

Description copied from interface: Builtin

is it a builtin for internal use only

Specified by:

isInternal in interface Builtin

Returns:

getArgumentDescriptions

public 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

getDescription

public 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

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

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

receiveRelation

public boolean receiveRelation(ReasoningRelation relation)
                        throws SemReasonerException,
InterruptedException,
IOException

Description copied from interface: Receiver

receive a whole relation

Specified by:

receiveRelation in interface Receiver

Parameters:

relation - the whole relation to be received

Returns:

true, if relation is later on dissolved, false otherwise

Throws:

ReasoningException

InterruptedException

IOException

SemReasonerException

evaluate

public void evaluate()

clear

public void clear()

Description copied from interface: Builtin

frees up allocated resources

Specified by:

clear in interface Builtin

startTuples

public Receiver startTuples(Receiver source,
 boolean check4Duplicates)
                     throws IOException

Description copied from interface: Receiver

start delivering single tuples

Specified by:

startTuples in interface Receiver

Parameters:

source - , the delivering process

check4Duplicates - , check for duplicates in the target store

Returns:

an object receiving the results

Throws:

IOException

tuplesFinished

public void tuplesFinished(boolean isBottomUp)
                    throws SemReasonerException,
InterruptedException,
IOException

Description copied from interface: Receiver

finish delivering single tuples

Specified by:

tuplesFinished in interface Receiver

Parameters:

isBottomUp - TODO

Throws:

ReasoningException

SemReasonerException

InterruptedException

IOException

tuplesFinished

public void tuplesFinished(String annotation,
 ReasoningRelation T1,
 ReasoningRelation T2)
                    throws SemReasonerException,
InterruptedException,
IOException

Description copied from interface: Receiver

Finish delivering single tuples.
Cache result and annotate result.

Specified by:

tuplesFinished in interface Receiver

Parameters:

annotation - , an annotation used for caching

T1 - , the relations which have been combined

T2 - , the relations which have been combined

Throws:

ReasoningException

SemReasonerException

InterruptedException

IOException

addRelation

public void addRelation(ReasoningRelation relation)

Description copied from interface: Receiver

add a whole relation at the beginning

Specified by:

addRelation in interface Receiver

Parameters:

relation - the relation to be added

getTupleStore

public TupleStore getTupleStore()

Description copied from interface: Receiver

get the basic tuple store

Specified by:

getTupleStore in interface Receiver

Returns:

the tuple store

receiveTuple

public boolean receiveTuple(long[] tuple)
                     throws SemReasonerException,
InterruptedException,
IOException

Description copied from interface: Receiver

receive a single tuple

Specified by:

receiveTuple in interface Receiver

Parameters:

tuple - the tuple to be received

Returns:

true if tuple has been used (tuple cannot be free'd up)

Throws:

SemReasonerException

InterruptedException

IOException

receiveTuple

public boolean receiveTuple(int tuple)
                     throws SemReasonerException,
InterruptedException,
IOException

Description copied from interface: Receiver

receive a single tuple

Specified by:

receiveTuple in interface Receiver

Parameters:

tuple - the tuple to be received

Returns:

true if tuple has been used (tuple cannot be free'd up)

Throws:

SemReasonerException

InterruptedException

IOException

receiveTuple

public boolean receiveTuple(TupleBuffer tuple)
                     throws SemReasonerException,
InterruptedException,
IOException

Description copied from interface: Receiver

receive a single tuple

Specified by:

receiveTuple in interface Receiver

Parameters:

tuple - the tuple to be received

Returns:

true if tuple has been used (tuple cannot be free'd up)

Throws:

ReasoningException

SemReasonerException

InterruptedException

IOException