org.drools.core.reteoo

Class TimerNode

java.lang.Object

org.drools.core.common.BaseNode

org.drools.core.reteoo.LeftTupleSource

org.drools.core.reteoo.TimerNode

All Implemented Interfaces:

Externalizable, Serializable, MemoryFactory<TimerNode.TimerNodeMemory>, NetworkNode, LeftTupleSink, LeftTupleSinkNode, Sink

public class TimerNode
extends LeftTupleSource
implements LeftTupleSinkNode, MemoryFactory<TimerNode.TimerNodeMemory>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimerNode.TimerNodeMemory

Field Summary

Fields inherited from class org.drools.core.reteoo.LeftTupleSource

leftInput, sink

Fields inherited from class org.drools.core.common.BaseNode

associations, id, partitionId, partitionsEnabled

Constructor Summary

Constructors

Constructor and Description
TimerNode()
TimerNode(int id, LeftTupleSource tupleSource, Timer timer, String[] calendarNames, Declaration[][] declarations, BuildContext context)

Method Summary

Methods

Modifier and Type	Method and Description
void	assertLeftTuple(LeftTuple leftTuple, PropagationContext context, InternalWorkingMemory workingMemory) Assert a new ReteTuple.
void	attach(BuildContext context) Attaches the node into the network.
LeftTuple	createLeftTuple(InternalFactHandle factHandle, LeftTuple leftTuple, LeftTupleSink sink)
LeftTuple	createLeftTuple(InternalFactHandle factHandle, LeftTupleSink sink, boolean leftTupleMemoryEnabled)
LeftTuple	createLeftTuple(LeftTuple leftTuple, LeftTupleSink sink, PropagationContext pctx, boolean leftTupleMemoryEnabled)
LeftTuple	createLeftTuple(LeftTuple leftTuple, RightTuple rightTuple, LeftTuple currentLeftChild, LeftTuple currentRightChild, LeftTupleSink sink, boolean leftTupleMemoryEnabled)
LeftTuple	createLeftTuple(LeftTuple leftTuple, RightTuple rightTuple, LeftTupleSink sink)
TimerNode.TimerNodeMemory	createMemory(RuleBaseConfiguration config, InternalWorkingMemory wm)
LeftTuple	createPeer(LeftTuple original)
protected boolean	doRemove(RuleRemovalContext context, ReteooBuilder builder, InternalWorkingMemory[] workingMemories) Removes the node from teh network.
boolean	equals(Object object)
String[]	getCalendarNames()
Declaration[][]	getDeclarations()
LeftTupleSource	getLeftTupleSource()
LeftTupleSinkNode	getNextLeftTupleSinkNode() Returns the next node
protected ObjectTypeNode	getObjectTypeNode()
LeftTupleSinkNode	getPreviousLeftTupleSinkNode() Returns the previous node
Timer	getTimer()
short	getType()
int	hashCode() The hashCode return is simply the unique id of the node.
boolean	isLeftTupleMemoryEnabled()
void	modifyLeftTuple(InternalFactHandle factHandle, ModifyPreviousTuples modifyPreviousTuples, PropagationContext context, InternalWorkingMemory workingMemory)
void	modifyLeftTuple(LeftTuple leftTuple, PropagationContext context, InternalWorkingMemory workingMemory)
void	networkUpdated(UpdateContext updateContext) A method that is called for all nodes whose network below them changed, after the change is complete, providing them with an oportunity for state update
void	readExternal(ObjectInput in)
void	retractLeftTuple(LeftTuple leftTuple, PropagationContext context, InternalWorkingMemory workingMemory)
void	setLeftTupleMemoryEnabled(boolean tupleMemoryEnabled)
void	setNextLeftTupleSinkNode(LeftTupleSinkNode next) Sets the next node
void	setPreviousLeftTupleSinkNode(LeftTupleSinkNode previous) Sets the previous node
String	toString() Produce a debug string.
void	updateSink(LeftTupleSink sink, PropagationContext context, InternalWorkingMemory workingMemory)
void	writeExternal(ObjectOutput out)

Methods inherited from class org.drools.core.reteoo.LeftTupleSource

addTupleSink, addTupleSink, addTupleSink, getLeftDeclaredMask, getLeftInferredMask, getLeftInputOtnId, getLeftNegativeMask, getObjectType, getSinkPropagator, initDeclaredMask, initInferredMask, initMasks, isInUse, removeTupleSink, setLeftInferredMask, setLeftInputOtnId, setLeftListenedProperties, setLeftTupleSource

Methods inherited from class org.drools.core.common.BaseNode

addAssociation, attach, getAssociations, getId, getPartitionId, isStreamMode, remove, removeAssociation, setId, setPartitionId, setStreamMode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.drools.core.reteoo.LeftTupleSink

getLeftInferredMask, getLeftInputOtnId, setLeftInputOtnId

Methods inherited from interface org.drools.core.common.NetworkNode

getAssociations, getId, getPartitionId

Methods inherited from interface org.drools.core.common.MemoryFactory

getId

Constructor Detail

TimerNode

public TimerNode()

TimerNode

public TimerNode(int id,
         LeftTupleSource tupleSource,
         Timer timer,
         String[] calendarNames,
         Declaration[][] declarations,
         BuildContext context)

Method Detail

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class LeftTupleSource

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class LeftTupleSource

Throws:

IOException

attach

public void attach(BuildContext context)

Description copied from class: BaseNode

Attaches the node into the network. Usually to the parent ObjectSource or TupleSource

Specified by:

attach in class BaseNode

networkUpdated

public void networkUpdated(UpdateContext updateContext)

Description copied from class: BaseNode

A method that is called for all nodes whose network below them changed, after the change is complete, providing them with an oportunity for state update

Specified by:

networkUpdated in class BaseNode

getTimer

public Timer getTimer()

getCalendarNames

public String[] getCalendarNames()

getDeclarations

public Declaration[][] getDeclarations()

getLeftTupleSource

public LeftTupleSource getLeftTupleSource()

Specified by:

getLeftTupleSource in interface LeftTupleSink

Overrides:

getLeftTupleSource in class LeftTupleSource

toString

public String toString()

Produce a debug string.

Overrides:

toString in class BaseNode

Returns:

The debug string.

hashCode

public int hashCode()

Description copied from class: BaseNode

The hashCode return is simply the unique id of the node. It is expected that base classes will also implement equals(Object object).

Overrides:

hashCode in class BaseNode

equals

public boolean equals(Object object)

Overrides:

equals in class Object

createMemory

public TimerNode.TimerNodeMemory createMemory(RuleBaseConfiguration config,
                                     InternalWorkingMemory wm)

Specified by:

createMemory in interface MemoryFactory<TimerNode.TimerNodeMemory>

createPeer

public LeftTuple createPeer(LeftTuple original)

Specified by:

createPeer in interface LeftTupleSink

Specified by:

createPeer in class LeftTupleSource

doRemove

protected boolean doRemove(RuleRemovalContext context,
               ReteooBuilder builder,
               InternalWorkingMemory[] workingMemories)

Description copied from class: BaseNode

Removes the node from teh network. Usually from the parent ObjectSource or TupleSource

Specified by:

doRemove in class BaseNode

isLeftTupleMemoryEnabled

public boolean isLeftTupleMemoryEnabled()

Specified by:

isLeftTupleMemoryEnabled in interface LeftTupleSink

Specified by:

isLeftTupleMemoryEnabled in class LeftTupleSource

setLeftTupleMemoryEnabled

public void setLeftTupleMemoryEnabled(boolean tupleMemoryEnabled)

Specified by:

setLeftTupleMemoryEnabled in interface LeftTupleSink

getNextLeftTupleSinkNode

public LeftTupleSinkNode getNextLeftTupleSinkNode()

Returns the next node

Specified by:

getNextLeftTupleSinkNode in interface LeftTupleSinkNode

Returns:

The next TupleSinkNode

setNextLeftTupleSinkNode

public void setNextLeftTupleSinkNode(LeftTupleSinkNode next)

Sets the next node

Specified by:

setNextLeftTupleSinkNode in interface LeftTupleSinkNode

Parameters:

next - The next TupleSinkNode

getPreviousLeftTupleSinkNode

public LeftTupleSinkNode getPreviousLeftTupleSinkNode()

Returns the previous node

Specified by:

getPreviousLeftTupleSinkNode in interface LeftTupleSinkNode

Returns:

The previous TupleSinkNode

setPreviousLeftTupleSinkNode

public void setPreviousLeftTupleSinkNode(LeftTupleSinkNode previous)

Sets the previous node

Specified by:

setPreviousLeftTupleSinkNode in interface LeftTupleSinkNode

Parameters:

previous - The previous TupleSinkNode

getType

public short getType()

Specified by:

getType in interface NetworkNode

Specified by:

getType in interface LeftTupleSink

Specified by:

getType in class LeftTupleSource

createLeftTuple

public LeftTuple createLeftTuple(InternalFactHandle factHandle,
                        LeftTupleSink sink,
                        boolean leftTupleMemoryEnabled)

Specified by:

createLeftTuple in interface LeftTupleSink

createLeftTuple

public LeftTuple createLeftTuple(InternalFactHandle factHandle,
                        LeftTuple leftTuple,
                        LeftTupleSink sink)

Specified by:

createLeftTuple in interface LeftTupleSink

createLeftTuple

public LeftTuple createLeftTuple(LeftTuple leftTuple,
                        LeftTupleSink sink,
                        PropagationContext pctx,
                        boolean leftTupleMemoryEnabled)

Specified by:

createLeftTuple in interface LeftTupleSink

createLeftTuple

public LeftTuple createLeftTuple(LeftTuple leftTuple,
                        RightTuple rightTuple,
                        LeftTupleSink sink)

Specified by:

createLeftTuple in interface LeftTupleSink

createLeftTuple

public LeftTuple createLeftTuple(LeftTuple leftTuple,
                        RightTuple rightTuple,
                        LeftTuple currentLeftChild,
                        LeftTuple currentRightChild,
                        LeftTupleSink sink,
                        boolean leftTupleMemoryEnabled)

Specified by:

createLeftTuple in interface LeftTupleSink

getObjectTypeNode

protected ObjectTypeNode getObjectTypeNode()

Specified by:

getObjectTypeNode in class LeftTupleSource

updateSink

public void updateSink(LeftTupleSink sink,
              PropagationContext context,
              InternalWorkingMemory workingMemory)

Specified by:

updateSink in class LeftTupleSource

assertLeftTuple

public void assertLeftTuple(LeftTuple leftTuple,
                   PropagationContext context,
                   InternalWorkingMemory workingMemory)

Description copied from interface: LeftTupleSink

Assert a new ReteTuple.

Specified by:

assertLeftTuple in interface LeftTupleSink

Parameters:

leftTuple - The ReteTuple to propagate.

context - The PropagationContext of the WorkingMemory action

workingMemory - the WorkingMemory session.

retractLeftTuple

public void retractLeftTuple(LeftTuple leftTuple,
                    PropagationContext context,
                    InternalWorkingMemory workingMemory)

Specified by:

retractLeftTuple in interface LeftTupleSink

modifyLeftTuple

public void modifyLeftTuple(LeftTuple leftTuple,
                   PropagationContext context,
                   InternalWorkingMemory workingMemory)

Specified by:

modifyLeftTuple in interface LeftTupleSink

modifyLeftTuple

public void modifyLeftTuple(InternalFactHandle factHandle,
                   ModifyPreviousTuples modifyPreviousTuples,
                   PropagationContext context,
                   InternalWorkingMemory workingMemory)

Specified by:

modifyLeftTuple in interface LeftTupleSink