jadex.rules.rulesystem.rete.nodes

Class TestNode

java.lang.Object

jadex.rules.rulesystem.rete.nodes.AbstractNode

jadex.rules.rulesystem.rete.nodes.TestNode

All Implemented Interfaces:

INode, ITupleConsumerNode, ITupleSourceNode, java.lang.Cloneable

public class TestNode
extends AbstractNode
implements ITupleConsumerNode, ITupleSourceNode

A test node takes evaluates a predicate.

Field Summary

Fields

Modifier and Type	Field and Description
protected IConstraintEvaluator	evaluator The constraint evaluator.
protected AttributeSet	indirects The set of indirect attributes.
protected AttributeSet	relevants The set of relevant attributes.
protected ITupleConsumerNode[]	tconsumers The tuple consumers.
protected ITupleSourceNode	tsource The tuple source.

Fields inherited from class jadex.rules.rulesystem.rete.nodes.AbstractNode

clones, nodeid

Constructor Summary

Constructors

Constructor and Description
TestNode(int nodeid, IConstraintEvaluator evaluator) Create a new test node.

Method Summary

Modifier and Type	Method and Description
void	addTuple(Tuple tuple, IOAVState state, ReteMemory mem, AbstractAgenda agenda) Add a new tuple to this node.
void	addTupleConsumer(ITupleConsumerNode node) Add an tuple consumer node.
java.lang.Object	createNodeMemory(IOAVState state) Create the node memory.
protected void	doClone(java.lang.Object theclone) Do clone makes a deep clone without regarding cycles.
IConstraintEvaluator	getConstraintEvaluator() Get the evaluator.
AttributeSet	getIndirectAttributes() Get the set of indirect attribute types.
java.util.Collection	getNodeMemory(ReteMemory mem) Get the memory for this node.
AttributeSet	getRelevantAttributes() Get the set of relevant attribute types.
ITupleConsumerNode[]	getTupleConsumers() Get all tuple consumer nodes.
ITupleSourceNode	getTupleSource() Get the tuple source of this node.
boolean	isAffected(OAVAttributeType attr) Test if the node is affected from a modification.
void	modifyIndirectObject(java.lang.Object object, OAVAttributeType type, java.lang.Object oldvalue, java.lang.Object newvalue, IOAVState state, ReteMemory mem, AbstractAgenda agenda) Propagate an indirect object change to this node.
void	modifyTuple(Tuple tuple, int tupleindex, OAVAttributeType type, java.lang.Object oldvalue, java.lang.Object newvalue, IOAVState state, ReteMemory mem, AbstractAgenda agenda) Modify a tuple in this node.
protected void	propagateAdditionToTupleConsumers(Tuple tuple, IOAVState state, ReteMemory mem, AbstractAgenda agenda) Propagate a new tuple to all tuple consumers.
protected void	propagateModificationToTupleConsumers(Tuple tuple, int tupleindex, OAVAttributeType type, java.lang.Object oldvalue, java.lang.Object newvalue, IOAVState state, ReteMemory mem, AbstractAgenda agenda) Propagate a modified tuple to all tuple consumers.
protected void	propagateRemovalToTupleConsumers(Tuple tuple, IOAVState state, ReteMemory mem, AbstractAgenda agenda) Propagate a removed tuple to all tuple consumers.
void	removeTuple(Tuple tuple, IOAVState state, ReteMemory mem, AbstractAgenda agenda) Remove a tuple from this node.
void	removeTupleConsumer(ITupleConsumerNode node) Remove an tuple consumer.
void	setTupleSource(ITupleSourceNode node) Set the tuple source of this node.

Methods inherited from class jadex.rules.rulesystem.rete.nodes.AbstractNode

checkNodeConsistency, clone, equals, getNodeId, hashCode, toString, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jadex.rules.rulesystem.rete.nodes.INode

checkNodeConsistency, clone, getNodeId

Field Detail

tconsumers

protected ITupleConsumerNode[] tconsumers

The tuple consumers.

tsource

protected ITupleSourceNode tsource

The tuple source.

evaluator

protected final IConstraintEvaluator evaluator

The constraint evaluator.

relevants

protected volatile AttributeSet relevants

The set of relevant attributes.

indirects

protected volatile AttributeSet indirects

The set of indirect attributes.

Constructor Detail

TestNode

public TestNode(int nodeid,
                IConstraintEvaluator evaluator)

Create a new test node.

Parameters:

evaluator - The evaluator.

Method Detail

addTuple

public void addTuple(Tuple tuple,
                     IOAVState state,
                     ReteMemory mem,
                     AbstractAgenda agenda)

Add a new tuple to this node.

Specified by:

addTuple in interface ITupleConsumerNode

Parameters:

tuple - The tuple.

removeTuple

public void removeTuple(Tuple tuple,
                        IOAVState state,
                        ReteMemory mem,
                        AbstractAgenda agenda)

Remove a tuple from this node.

Specified by:

removeTuple in interface ITupleConsumerNode

Parameters:

tuple - The tuple.

modifyTuple

public void modifyTuple(Tuple tuple,
                        int tupleindex,
                        OAVAttributeType type,
                        java.lang.Object oldvalue,
                        java.lang.Object newvalue,
                        IOAVState state,
                        ReteMemory mem,
                        AbstractAgenda agenda)

Modify a tuple in this node.

Specified by:

modifyTuple in interface ITupleConsumerNode

Parameters:

tuple - The tuple.

modifyIndirectObject

public void modifyIndirectObject(java.lang.Object object,
                                 OAVAttributeType type,
                                 java.lang.Object oldvalue,
                                 java.lang.Object newvalue,
                                 IOAVState state,
                                 ReteMemory mem,
                                 AbstractAgenda agenda)

Propagate an indirect object change to this node.

Specified by:

modifyIndirectObject in interface INode

Parameters:

object - The changed object.

setTupleSource

public void setTupleSource(ITupleSourceNode node)

Set the tuple source of this node.

Specified by:

setTupleSource in interface ITupleConsumerNode

Parameters:

node - The tuple source node.

getTupleSource

public ITupleSourceNode getTupleSource()

Get the tuple source of this node.

Specified by:

getTupleSource in interface ITupleConsumerNode

Returns:

The object source node.

addTupleConsumer

public void addTupleConsumer(ITupleConsumerNode node)

Add an tuple consumer node.

Specified by:

addTupleConsumer in interface ITupleSourceNode

Parameters:

node - A new consumer node.

removeTupleConsumer

public void removeTupleConsumer(ITupleConsumerNode node)

Remove an tuple consumer.

Specified by:

removeTupleConsumer in interface ITupleSourceNode

Parameters:

node - The consumer node.

getNodeMemory

public java.util.Collection getNodeMemory(ReteMemory mem)

Get the memory for this node.

Specified by:

getNodeMemory in interface INode

Specified by:

getNodeMemory in interface ITupleSourceNode

Returns:

The memory.

getTupleConsumers

public ITupleConsumerNode[] getTupleConsumers()

Get all tuple consumer nodes.

Specified by:

getTupleConsumers in interface ITupleSourceNode

Returns:

All tuple consumer nodes.

getRelevantAttributes

public AttributeSet getRelevantAttributes()

Get the set of relevant attribute types.

Specified by:

getRelevantAttributes in interface INode

getIndirectAttributes

public AttributeSet getIndirectAttributes()

Get the set of indirect attribute types. I.e. attributes of objects, which are not part of an object conditions (e.g. for chained extractors)

Specified by:

getIndirectAttributes in interface INode

Returns:

The relevant attribute types.

createNodeMemory

public java.lang.Object createNodeMemory(IOAVState state)

Create the node memory.

Specified by:

createNodeMemory in interface INode

Parameters:

state - The state.

Returns:

The node memory.

isAffected

public boolean isAffected(OAVAttributeType attr)

Test if the node is affected from a modification.

Parameters:

type - The attribute type.

Returns:

True, if possibly affected.

getConstraintEvaluator

public IConstraintEvaluator getConstraintEvaluator()

Get the evaluator.

propagateAdditionToTupleConsumers

protected void propagateAdditionToTupleConsumers(Tuple tuple,
                                                 IOAVState state,
                                                 ReteMemory mem,
                                                 AbstractAgenda agenda)

Propagate a new tuple to all tuple consumers.

Parameters:

tuple - The new tuple.

propagateRemovalToTupleConsumers

protected void propagateRemovalToTupleConsumers(Tuple tuple,
                                                IOAVState state,
                                                ReteMemory mem,
                                                AbstractAgenda agenda)

Propagate a removed tuple to all tuple consumers.

Parameters:

tuple - The new tuple.

propagateModificationToTupleConsumers

protected void propagateModificationToTupleConsumers(Tuple tuple,
                                                     int tupleindex,
                                                     OAVAttributeType type,
                                                     java.lang.Object oldvalue,
                                                     java.lang.Object newvalue,
                                                     IOAVState state,
                                                     ReteMemory mem,
                                                     AbstractAgenda agenda)

Propagate a modified tuple to all tuple consumers.

Parameters:

tuple - The new tuple.

doClone

protected void doClone(java.lang.Object theclone)

Do clone makes a deep clone without regarding cycles. Method is overridden by subclasses to actually incorporate their attributes.

Specified by:

doClone in class AbstractNode

Parameters:

theclone - The clone.