Package com.semedy.reasoner.builtin.connector

Class Currency

java.lang.Object

com.semedy.reasoner.builtin.connector.Currency

All Implemented Interfaces:

Builtin, Connector

public class Currency
extends Object
implements Connector

retrieve currency information

Author:

angele

Constructor Summary

Constructors

Constructor	Description
Currency()

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 arg0, BitSet arg1, Object[] arg2)	the weight of the builtin.
void	init(Object[] arg0)	initialize the builtin
void	input(long[] input)	Feed the built-in with an input tuple.
boolean	isEvaluable(BitSet arg, BitSet arg1, Object[] arg2)	is builtin evaluable with a certain instantiation of variables
boolean	isInternal()	is it a builtin for internal use only
BitSet	objectGeneratingArguments(BitSet arg0, BitSet arg1, Object[] arg2)	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 arg0)	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

Currency

public Currency()

Method Details

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

stop

public void stop()
          throws InterruptedException,
IOException,
SemReasonerException

Description copied from interface: Connector

stop feeding the built-in with input values

Specified by:

stop in interface Connector

Throws:

InterruptedException

IOException

SemReasonerException

clear

public void clear()

Description copied from interface: Builtin

frees up allocated resources

Specified by:

clear in interface Builtin

cloneBuiltin

public Builtin cloneBuiltin()

Description copied from interface: Builtin

clone the builtin

Specified by:

cloneBuiltin in interface Builtin

Returns:

the cloned 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

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

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

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

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

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

getWeight

public long getWeight(BitSet arg0,
 BitSet arg1,
 Object[] arg2)

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:

arg0 - , ground arguments

arg1 - , instantiated variables

arg2 - , arguments of the builtin

Returns:

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

init

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

Description copied from interface: Builtin

initialize the builtin

Specified by:

init in interface Builtin

Parameters:

arg0 - , the builtin arguments

Throws:

InterruptedException

IOException

BuiltinException

isEvaluable

public boolean isEvaluable(BitSet arg,
 BitSet arg1,
 Object[] arg2)
                    throws BuiltinException

Description copied from interface: Builtin

is builtin evaluable with a certain instantiation of variables

Specified by:

isEvaluable in interface Builtin

Parameters:

arg - , which arguments are ground

arg1 - , which variables are instantiated

arg2 - , the arguments

Returns:

was it evaluable

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:

objectGeneratingArguments

public BitSet objectGeneratingArguments(BitSet arg0,
 BitSet arg1,
 Object[] arg2)
                                 throws BuiltinException

Description copied from interface: Builtin

In which argument position are new objects created

Specified by:

objectGeneratingArguments in interface Builtin

Parameters:

arg0 - , ground argument positions

arg1 - , instantiated variables

arg2 - , arguments of the literal

Returns:

each bit indicates the argument position where new objects are created

Throws:

BuiltinException

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

setSymbolTable

public void setSymbolTable(SymbolTable arg0)

Description copied from interface: Builtin

set the symbol table

Specified by:

setSymbolTable in interface Builtin

Parameters:

arg0 - , 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

setProperties

public void setProperties(Properties prp)

Description copied from interface: Builtin

set the sytem properties

Specified by:

setProperties in interface Builtin

Parameters:

prp - , properties

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