Package com.semedy.reasoner.api.builtin

Class SensorBuiltin

java.lang.Object

com.semedy.reasoner.api.builtin.SensorBuiltin

All Implemented Interfaces:

Builtin

Direct Known Subclasses:

Alarm, IncrementalFactsBuiltin, ListenToPort, SensorBuiltinSingleValue, Ticks

public abstract class SensorBuiltin
extends Object
implements Builtin

A sensor builtin feeds events asynchroniously into the reasoner.
Used for complex event processing.

Author:

angele

Constructor Summary

Constructors

Constructor	Description
SensorBuiltin()

Method Summary

Modifier and Type	Method	Description
void	addReceiver(Receiver receive)
abstract Builtin	cloneBuiltin()	create a clone of the built-in
void	evaluationFinished()	evaluation is finished
abstract String[]	getArgumentDescriptions()	get a description of the arguments
abstract int	getArity()	get the arity of the built-in
abstract String	getDescription()	get a description of the built-in itself
abstract String	getName()	get the name of the built-in
abstract BuiltinType	getType()	get the type of the built-in
abstract long	getWeight(BitSet grounds, BitSet variableInstantiations, Object[] args)	get the weight of the built-in
abstract void	init(Object[] args)	initialize the built-in
abstract boolean	isEvaluable(BitSet grounds, BitSet variableInstantiations, Object[] args)	is builtin evaluable with the given ground instantiation of variables
abstract boolean	isInternal()	is it an internal built-in
abstract BitSet	objectGeneratingArguments(BitSet grounds, BitSet variableInstantiations, Object[] args)	at which argument positions new objects are generated
abstract boolean	readsSymbolTable()	does the built-in read the symbol table
void	receiveEncodedEvent(Object[] tuple)	receives an event with already coded values (longs) triggers reasoning with this new info
void	receiveEvent(Object[] tuple)	receives an event from an external system/sensor and triggers reasoning with this new info
void	retractEncodedEvent(Object[] tuple)	retracts an event with already coded values (longs) triggers reasoning with this new info
void	retractEvent(Object[] tuple)	withdraws an event from an external system/sensor and triggers reasoning with this new info
void	retractEvents(Relation R)
void	setSemaphore(SimpleSemaphore semaphore)	A semaphore is used to continue evaluation after a new value for a sensor has been arrived
void	setSymbolTable(SymbolTable symbolTable)	set the symbol table
abstract boolean	writesSymbolTable()	does the built-in write 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, setProperties

Constructor Details

SensorBuiltin

public SensorBuiltin()

Method Details

addReceiver

public void addReceiver(Receiver receive)

receiveEvent

public void receiveEvent(Object[] tuple)
                  throws SemReasonerException,
InterruptedException,
IOException

receives an event from an external system/sensor and
triggers reasoning with this new info

Parameters:

tuple -

Throws:

SymboltableException

ReasoningException

InterruptedException

IOException

SemReasonerException

receiveEncodedEvent

public void receiveEncodedEvent(Object[] tuple)
                         throws InterruptedException,
IOException,
SemReasonerException

receives an event with already coded values (longs)
triggers reasoning with this new info

Parameters:

tuple - (array of Long)

Throws:

InterruptedException

IOException

SemReasonerException

retractEvent

public void retractEvent(Object[] tuple)
                  throws SemReasonerException,
InterruptedException,
IOException

withdraws an event from an external system/sensor and triggers reasoning with this new info

Parameters:

tuple -

Throws:

SymboltableException

ReasoningException

InterruptedException

IOException

SemReasonerException

retractEncodedEvent

public void retractEncodedEvent(Object[] tuple)
                         throws IOException,
InterruptedException,
SemReasonerException

retracts an event with already coded values (longs)
triggers reasoning with this new info

Parameters:

tuple - (array of Long)

Throws:

SymboltableException

InterruptedException

IOException

SemReasonerException

retractEvents

public void retractEvents(Relation R)

evaluationFinished

public void evaluationFinished()
                        throws BuiltinException,
InterruptedException

evaluation is finished

Specified by:

evaluationFinished in interface Builtin

Throws:

BuiltinException

InterruptedException

setSymbolTable

public void setSymbolTable(SymbolTable symbolTable)

set the symbol table

Specified by:

setSymbolTable in interface Builtin

Parameters:

symbolTable - , the symbol table

setSemaphore

public void setSemaphore(SimpleSemaphore semaphore)

A semaphore is used to continue evaluation after a new value for a sensor has been arrived

Parameters:

semaphore -

isEvaluable

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

is builtin evaluable with the given ground 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 abstract void init(Object[] args)
                   throws BuiltinException,
InterruptedException,
SemReasonerException

initialize the built-in

Specified by:

init in interface Builtin

Parameters:

args - , the builtin arguments

Throws:

SemReasonerException

InterruptedException

BuiltinException

getWeight

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

get the weight of the built-in

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 abstract BitSet objectGeneratingArguments(BitSet grounds,
 BitSet variableInstantiations,
 Object[] args)
                                          throws BuiltinException

at which argument positions new objects are generated

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 abstract String getName()

get the name of the built-in

Specified by:

getName in interface Builtin

Returns:

the name of the built-in

getArity

public abstract int getArity()

get the arity of the built-in

Specified by:

getArity in interface Builtin

Returns:

the arity of the built-in

getType

public abstract BuiltinType getType()

get the type of the built-in

Specified by:

getType in interface Builtin

Returns:

the type of the built-in

isInternal

public abstract boolean isInternal()

is it an internal built-in

Specified by:

isInternal in interface Builtin

Returns:

getArgumentDescriptions

public abstract String[] getArgumentDescriptions()

get a description of the arguments

Specified by:

getArgumentDescriptions in interface Builtin

Returns:

a description of the arguments of the built-in

getDescription

public abstract String getDescription()

get a description of the built-in itself

Specified by:

getDescription in interface Builtin

Returns:

a description of the built-in

readsSymbolTable

public abstract boolean readsSymbolTable()

does the built-in read the symbol table

Specified by:

readsSymbolTable in interface Builtin

Returns:

true if it reads the symbol table

writesSymbolTable

public abstract boolean writesSymbolTable()

does the built-in write the symbol table

Specified by:

writesSymbolTable in interface Builtin

Returns:

true if it writes to the symbol table

cloneBuiltin

public abstract Builtin cloneBuiltin()

create a clone of the built-in

Specified by:

cloneBuiltin in interface Builtin

Returns:

the cloned built-in