Package org.drools.core.reteoo

Class BaseLeftTuple

java.lang.Object

org.drools.core.reteoo.BaseTuple

org.drools.core.reteoo.BaseLeftTuple

All Implemented Interfaces:

java.io.Serializable, LeftTuple, Tuple, Entry<Tuple>

Direct Known Subclasses:

EvalNodeLeftTuple, FromNodeLeftTuple, JoinNodeLeftTuple, LeftTupleImpl, NotNodeLeftTuple, QueryElementNodeLeftTuple, QueryRiaFixerNodeLeftTuple, RuleTerminalNodeLeftTuple, SubnetworkTuple

public class BaseLeftTuple
extends BaseTuple
implements LeftTuple

A parent class for all specific LeftTuple specializations

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected TupleList	memory

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

handle, handleNext, handlePrevious, sink, stagedNext, stagedPrevious

Fields inherited from interface org.drools.core.reteoo.Tuple

DELETE, INSERT, NONE, NORMALIZED_DELETE, UPDATE

Constructor Summary

Constructors

Constructor	Description
BaseLeftTuple()
BaseLeftTuple(InternalFactHandle factHandle, LeftTuple leftTuple, Sink sink)
BaseLeftTuple(InternalFactHandle factHandle, Sink sink, boolean leftTupleMemoryEnabled)
BaseLeftTuple(LeftTuple leftTuple, RightTuple rightTuple, LeftTuple currentLeftChild, LeftTuple currentRightChild, Sink sink, boolean leftTupleMemoryEnabled)
BaseLeftTuple(LeftTuple leftTuple, RightTuple rightTuple, Sink sink)
BaseLeftTuple(LeftTuple leftTuple, RightTuple rightTuple, Sink sink, boolean leftTupleMemoryEnabled)
BaseLeftTuple(LeftTuple leftTuple, Sink sink, PropagationContext pctx, boolean leftTupleMemoryEnabled)

Method Summary

Modifier and Type	Method	Description
void	clear()
void	clearBlocker()
void	clearStaged()
boolean	equals(java.lang.Object object)
InternalFactHandle	get(int index)	Returns the FactHandle for the given pattern index.
LeftTuple	getBlockedNext()
LeftTuple	getBlockedPrevious()
RightTuple	getBlocker()
LeftTuple	getFirstChild()
LeftTuple	getHandleNext()
LeftTuple	getHandlePrevious()
int	getIndex()
ObjectTypeNode.Id	getInputOtnId()
LeftTuple	getLastChild()
LeftTuple	getLeftParent()
TupleList	getMemory()
LeftTuple	getNextParentWithHandle()
java.lang.Object	getObject(int index)
LeftTuple	getParent()
LeftTuple	getPeer()
RightTuple	getRightParent()
LeftTuple	getRightParentNext()
LeftTuple	getRightParentPrevious()
LeftTuple	getStagedNext()
LeftTuple	getStagedPrevious()
short	getStagedTypeForQueries()
LeftTuple	getSubTuple(int elements)	Returns the ReteTuple that contains the "elements" first elements in this tuple.
LeftTupleSink	getTupleSink()
LeftTupleSource	getTupleSource()
int	hashCode()
void	initPeer(BaseLeftTuple original, LeftTupleSink sink)
boolean	isStagedOnRight()
void	reAdd()
void	reAddLeft()
void	reAddRight()
void	setBlockedNext(LeftTuple blockerNext)
void	setBlockedPrevious(LeftTuple blockerPrevious)
void	setBlocker(RightTuple blocker)
void	setFirstChild(LeftTuple firstChild)
void	setLastChild(LeftTuple lastChild)
void	setLeftParent(LeftTuple leftParent)
void	setLeftTupleSink(LeftTupleSink sink)
void	setMemory(TupleList memory)
void	setPeer(LeftTuple peer)
void	setRightParent(RightTuple rightParent)
void	setRightParentNext(LeftTuple rightParentRight)
void	setRightParentPrevious(LeftTuple rightParentLeft)
void	setStagedTypeForQueries(short stagedTypeForQueries)
int	size()	Returns the size of this tuple in number of elements (patterns)
protected java.lang.String	toExternalString()
InternalFactHandle[]	toFactHandles()	Returns the fact handles in reverse order
java.lang.Object[]	toObjects(boolean reverse)
java.lang.String	toString()
void	unlinkFromLeftParent()
void	unlinkFromRightParent()

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

decreaseActivationCountForEvents, get, getContextObject, getFactHandle, getNext, getObject, getOriginalFactHandle, getPrevious, getPropagationContext, getRootTuple, getStagedType, getTuple, increaseActivationCountForEvents, isExpired, setContextObject, setExpired, setFactHandle, setHandleNext, setHandlePrevious, setNext, setPrevious, setPropagationContext, setStagedNext, setStagedPrevious, setStagedType, skipEmptyHandles

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.drools.core.util.Entry

getNext, setNext

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

getAccumulatedObjects, setExpired

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

decreaseActivationCountForEvents, findMostRecentPropagationContext, get, getContextObject, getFactHandle, getObject, getOriginalFactHandle, getPrevious, getPropagationContext, getRootTuple, getStagedType, getTuple, increaseActivationCountForEvents, isDeleted, isExpired, setContextObject, setFactHandle, setHandleNext, setHandlePrevious, setPrevious, setPropagationContext, setStagedNext, setStagedPrevious, setStagedType, skipEmptyHandles, toObjects

Field Detail

memory

protected TupleList memory

Constructor Detail

BaseLeftTuple

public BaseLeftTuple()

BaseLeftTuple

public BaseLeftTuple(InternalFactHandle factHandle,
                     Sink sink,
                     boolean leftTupleMemoryEnabled)

BaseLeftTuple

public BaseLeftTuple(InternalFactHandle factHandle,
                     LeftTuple leftTuple,
                     Sink sink)

BaseLeftTuple

public BaseLeftTuple(LeftTuple leftTuple,
                     Sink sink,
                     PropagationContext pctx,
                     boolean leftTupleMemoryEnabled)

BaseLeftTuple

public BaseLeftTuple(LeftTuple leftTuple,
                     RightTuple rightTuple,
                     Sink sink)

BaseLeftTuple

public BaseLeftTuple(LeftTuple leftTuple,
                     RightTuple rightTuple,
                     Sink sink,
                     boolean leftTupleMemoryEnabled)

BaseLeftTuple

public BaseLeftTuple(LeftTuple leftTuple,
                     RightTuple rightTuple,
                     LeftTuple currentLeftChild,
                     LeftTuple currentRightChild,
                     Sink sink,
                     boolean leftTupleMemoryEnabled)

Method Detail

getNextParentWithHandle

public LeftTuple getNextParentWithHandle()

Specified by:

getNextParentWithHandle in interface LeftTuple

reAdd

public void reAdd()

Specified by:

reAdd in interface Tuple

reAddLeft

public void reAddLeft()

Specified by:

reAddLeft in interface LeftTuple

reAddRight

public void reAddRight()

Specified by:

reAddRight in interface LeftTuple

unlinkFromLeftParent

public void unlinkFromLeftParent()

Specified by:

unlinkFromLeftParent in interface Tuple

unlinkFromRightParent

public void unlinkFromRightParent()

Specified by:

unlinkFromRightParent in interface Tuple

getIndex

public int getIndex()

Specified by:

getIndex in interface Tuple

getTupleSink

public LeftTupleSink getTupleSink()

Specified by:

getTupleSink in interface Tuple

setLeftTupleSink

public void setLeftTupleSink(LeftTupleSink sink)

Specified by:

setLeftTupleSink in interface LeftTuple

getLeftParent

public LeftTuple getLeftParent()

Specified by:

getLeftParent in interface LeftTuple

setLeftParent

public void setLeftParent(LeftTuple leftParent)

Specified by:

setLeftParent in interface LeftTuple

getHandlePrevious

public LeftTuple getHandlePrevious()

Specified by:

getHandlePrevious in interface Tuple

Overrides:

getHandlePrevious in class BaseTuple

getHandleNext

public LeftTuple getHandleNext()

Specified by:

getHandleNext in interface Tuple

Overrides:

getHandleNext in class BaseTuple

getRightParent

public RightTuple getRightParent()

Specified by:

getRightParent in interface LeftTuple

setRightParent

public void setRightParent(RightTuple rightParent)

Specified by:

setRightParent in interface LeftTuple

getRightParentPrevious

public LeftTuple getRightParentPrevious()

Specified by:

getRightParentPrevious in interface LeftTuple

setRightParentPrevious

public void setRightParentPrevious(LeftTuple rightParentLeft)

Specified by:

setRightParentPrevious in interface LeftTuple

getRightParentNext

public LeftTuple getRightParentNext()

Specified by:

getRightParentNext in interface LeftTuple

setRightParentNext

public void setRightParentNext(LeftTuple rightParentRight)

Specified by:

setRightParentNext in interface LeftTuple

get

public InternalFactHandle get(int index)

Description copied from interface: Tuple

Returns the FactHandle for the given pattern index. If the pattern is empty It returns null.

Specified by:

get in interface Tuple

Parameters:

index - The index of the pattern from which the FactHandleImpl is to be returned

Returns:

The FactHandle

toFactHandles

public InternalFactHandle[] toFactHandles()

Description copied from interface: Tuple

Returns the fact handles in reverse order

Specified by:

toFactHandles in interface Tuple

toObjects

public java.lang.Object[] toObjects(boolean reverse)

Specified by:

toObjects in interface Tuple

clearBlocker

public void clearBlocker()

Specified by:

clearBlocker in interface LeftTuple

setBlocker

public void setBlocker(RightTuple blocker)

Specified by:

setBlocker in interface LeftTuple

getBlocker

public RightTuple getBlocker()

Specified by:

getBlocker in interface LeftTuple

getBlockedPrevious

public LeftTuple getBlockedPrevious()

Specified by:

getBlockedPrevious in interface LeftTuple

setBlockedPrevious

public void setBlockedPrevious(LeftTuple blockerPrevious)

Specified by:

setBlockedPrevious in interface LeftTuple

getBlockedNext

public LeftTuple getBlockedNext()

Specified by:

getBlockedNext in interface LeftTuple

setBlockedNext

public void setBlockedNext(LeftTuple blockerNext)

Specified by:

setBlockedNext in interface LeftTuple

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

size

public int size()

Description copied from interface: Tuple

Returns the size of this tuple in number of elements (patterns)

Specified by:

size in interface Tuple

getFirstChild

public LeftTuple getFirstChild()

Specified by:

getFirstChild in interface Tuple

setFirstChild

public void setFirstChild(LeftTuple firstChild)

Specified by:

setFirstChild in interface Tuple

getLastChild

public LeftTuple getLastChild()

Specified by:

getLastChild in interface Tuple

setLastChild

public void setLastChild(LeftTuple lastChild)

Specified by:

setLastChild in interface Tuple

getMemory

public TupleList getMemory()

Specified by:

getMemory in interface Tuple

setMemory

public void setMemory(TupleList memory)

Specified by:

setMemory in interface Tuple

getStagedNext

public LeftTuple getStagedNext()

Specified by:

getStagedNext in interface Tuple

getStagedPrevious

public LeftTuple getStagedPrevious()

Specified by:

getStagedPrevious in interface Tuple

clearStaged

public void clearStaged()

Specified by:

clearStaged in interface Tuple

Overrides:

clearStaged in class BaseTuple

getPeer

public LeftTuple getPeer()

Specified by:

getPeer in interface LeftTuple

setPeer

public void setPeer(LeftTuple peer)

Specified by:

setPeer in interface LeftTuple

getSubTuple

public LeftTuple getSubTuple(int elements)

Description copied from interface: Tuple

Returns the ReteTuple that contains the "elements" first elements in this tuple.

Use carefully as no cloning is made during this process.

This method is used by TupleStartEqualsConstraint when joining a subnetwork tuple into the main network tuple;

Specified by:

getSubTuple in interface Tuple

Parameters:

elements - the number of elements to return, starting from the begining of the tuple

Returns:

a ReteTuple containing the "elements" first elements of this tuple or null if "elements" is greater than size;

getParent

public LeftTuple getParent()

Specified by:

getParent in interface LeftTuple

Specified by:

getParent in interface Tuple

toExternalString

protected java.lang.String toExternalString()

clear

public void clear()

Specified by:

clear in interface Tuple

Overrides:

clear in class BaseTuple

initPeer

public void initPeer(BaseLeftTuple original,
                     LeftTupleSink sink)

getObject

public java.lang.Object getObject(int index)

Specified by:

getObject in interface Tuple

getInputOtnId

public ObjectTypeNode.Id getInputOtnId()

Specified by:

getInputOtnId in interface Tuple

getTupleSource

public LeftTupleSource getTupleSource()

Specified by:

getTupleSource in interface Tuple

getStagedTypeForQueries

public short getStagedTypeForQueries()

Specified by:

getStagedTypeForQueries in interface LeftTuple

setStagedTypeForQueries

public void setStagedTypeForQueries(short stagedTypeForQueries)

Specified by:

setStagedTypeForQueries in interface LeftTuple

isStagedOnRight

public boolean isStagedOnRight()

Specified by:

isStagedOnRight in interface LeftTuple