Package com.semedy.reasoner.core

Class Sum

java.lang.Object

com.semedy.reasoner.core.Sum

All Implemented Interfaces:

Aggregation, Builtin

public class Sum
extends Object
implements Aggregation

Aggregating sum() builtin.

Constructor Summary

Constructors

Constructor	Description
Sum()

Method Summary

Modifier and Type	Method	Description
void	clear()	frees up allocated resources
Builtin	cloneBuiltin()	clone the builtin
boolean	deliversOneResultOnly()	aggregation delivers only one result at argument position.
void	evaluate(BuiltinReceiver receiver)	Evaluate the aggregation.
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 aggregation with 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)	start feeding the aggregation with input.
void	stop()	stop feeding the aggregation with input
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

Sum

public Sum()

Method Details

setProperties

public void setProperties(Properties prp)

Description copied from interface: Builtin

set the sytem properties

Specified by:

setProperties in interface Builtin

Parameters:

prp - , properties

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 BuiltinException,
InterruptedException

Description copied from interface: Builtin

initialize the builtin

Specified by:

init in interface Builtin

Parameters:

args - , the builtin arguments

Throws:

InterruptedException

BuiltinException

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

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

getArity

public 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

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

start

public void start(BitSet grounds)
           throws ReasoningException,
InterruptedException

Description copied from interface: Aggregation

start feeding the aggregation with input. Grounds indicates which arguments are ground

Specified by:

start in interface Aggregation

Parameters:

grounds - , which arguments must be instantiated

Throws:

InterruptedException

ReasoningException

input

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

Description copied from interface: Aggregation

feed aggregation with input tuple

Specified by:

input in interface Aggregation

Parameters:

input - , the coded input tuple

Throws:

InterruptedException

IOException

ReasoningException

stop

public void stop()
          throws ReasoningException,
InterruptedException

Description copied from interface: Aggregation

stop feeding the aggregation with input

Specified by:

stop in interface Aggregation

Throws:

InterruptedException

ReasoningException

evaluate

public void evaluate(BuiltinReceiver receiver)
              throws InterruptedException,
ReasoningException,
IOException

Description copied from interface: Aggregation

Evaluate the aggregation.
For every result tuple the method "send" in receiver is called

Specified by:

evaluate in interface Aggregation

Parameters:

receiver - , the receiver getting the results

Throws:

InterruptedException

IOException

ReasoningException

cloneBuiltin

public Builtin cloneBuiltin()

Description copied from interface: Builtin

clone the builtin

Specified by:

cloneBuiltin in interface Builtin

Returns:

the cloned built-in

deliversOneResultOnly

public boolean deliversOneResultOnly()

Description copied from interface: Aggregation

aggregation delivers only one result at argument position.
For instance count delivers one result at argument position 1.

Specified by:

deliversOneResultOnly in interface Aggregation

Returns:

true if it delivers one result only

clear

public void clear()

Description copied from interface: Builtin

frees up allocated resources

Specified by:

clear in interface Builtin