Package org.drools.core.reteoo

Interface Tuple

All Superinterfaces:

org.drools.base.reteoo.BaseTuple, Entry<Tuple>, java.io.Serializable

All Known Subinterfaces:

LeftTuple, RightTuple

All Known Implementing Classes:

AbstractLeftTuple, AbstractTuple, EvalNodeLeftTuple, JoinNodeLeftTuple, NotNodeLeftTuple, ReactiveFromNodeLeftTuple, RightTupleImpl, RuleTerminalNodeLeftTuple, SubnetworkTuple, WindowTuple

public interface Tuple
extends org.drools.base.reteoo.BaseTuple, java.io.Serializable, Entry<Tuple>

Partial matches are propagated through the Rete network as Tuples. Each Tuple Is able to return the FactHandleImpl members of the partial match for the requested pattern. The pattern refers to the index position of the FactHandleImpl in the underlying implementation.

Field Summary

Fields

Modifier and Type	Field	Description
static short	DELETE
static short	INSERT
static short	NONE
static short	NORMALIZED_DELETE
static short	UPDATE

Method Summary

Modifier and Type	Method	Description
void	clear()
void	clearStaged()
void	decreaseActivationCountForEvents()
default PropagationContext	findMostRecentPropagationContext()
java.lang.Object	getContextObject()
LeftTuple	getFirstChild()
<T extends Tuple> T	getHandleNext()
<T extends Tuple> T	getHandlePrevious()
ObjectTypeNode.Id	getInputOtnId()
LeftTuple	getLastChild()
TupleList	getMemory()
InternalFactHandle	getOriginalFactHandle()
Tuple	getParent()
Tuple	getPrevious()
PropagationContext	getPropagationContext()
Tuple	getRootTuple()
<T extends Tuple> T	getStagedNext()
Tuple	getStagedPrevious()
short	getStagedType()
Tuple	getSubTuple(int elements)	Returns the ReteTuple that contains the "elements" first elements in this tuple.
<S extends Sink> S	getTupleSink()
<N extends org.drools.base.common.NetworkNode> N	getTupleSource()
void	increaseActivationCountForEvents()
default boolean	isDeleted()
boolean	isExpired()
void	reAdd()
void	setContextObject(java.lang.Object object)
void	setFactHandle(org.kie.api.runtime.rule.FactHandle handle)
void	setFirstChild(LeftTuple firstChild)
void	setHandleNext(Tuple leftParentright)
void	setHandlePrevious(Tuple leftParentLeft)
void	setLastChild(LeftTuple firstChild)
void	setMemory(TupleList memory)
void	setPrevious(Tuple previous)
void	setPropagationContext(PropagationContext propagationContext)
void	setStagedNext(Tuple stageNext)
void	setStagedPrevious(Tuple stagePrevious)
void	setStagedType(short stagedType)
Tuple	skipEmptyHandles()
default java.lang.Object[]	toObjects()
void	unlinkFromLeftParent()
void	unlinkFromRightParent()

Methods inherited from interface org.drools.base.reteoo.BaseTuple

get, get, getFactHandle, getIndex, getObject, getObject, getTuple, size, toFactHandles, toObjects

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

getNext, setNext

Field Detail

NONE

static final short NONE

See Also:

Constant Field Values

INSERT

static final short INSERT

See Also:

Constant Field Values

UPDATE

static final short UPDATE

See Also:

Constant Field Values

DELETE

static final short DELETE

See Also:

Constant Field Values

NORMALIZED_DELETE

static final short NORMALIZED_DELETE

See Also:

Constant Field Values

Method Detail

toObjects

default java.lang.Object[] toObjects()

Specified by:

toObjects in interface org.drools.base.reteoo.BaseTuple

setFactHandle

void setFactHandle(org.kie.api.runtime.rule.FactHandle handle)

getOriginalFactHandle

InternalFactHandle getOriginalFactHandle()

getSubTuple

Tuple getSubTuple(int elements)

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;

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;

getContextObject

java.lang.Object getContextObject()

Specified by:

getContextObject in interface org.drools.base.reteoo.BaseTuple

setContextObject

void setContextObject(java.lang.Object object)

getStagedType

short getStagedType()

setStagedType

void setStagedType(short stagedType)

isDeleted

default boolean isDeleted()

getStagedPrevious

Tuple getStagedPrevious()

setStagedPrevious

void setStagedPrevious(Tuple stagePrevious)

getStagedNext

<T extends Tuple> T getStagedNext()

setStagedNext

void setStagedNext(Tuple stageNext)

clear

void clear()

clearStaged

void clearStaged()

reAdd

void reAdd()

unlinkFromRightParent

void unlinkFromRightParent()

unlinkFromLeftParent

void unlinkFromLeftParent()

getPropagationContext

PropagationContext getPropagationContext()

setPropagationContext

void setPropagationContext(PropagationContext propagationContext)

getPrevious

Tuple getPrevious()

setPrevious

void setPrevious(Tuple previous)

getTupleSink

<S extends Sink> S getTupleSink()

getMemory

TupleList getMemory()

setMemory

void setMemory(TupleList memory)

increaseActivationCountForEvents

void increaseActivationCountForEvents()

decreaseActivationCountForEvents

void decreaseActivationCountForEvents()

getRootTuple

Tuple getRootTuple()

skipEmptyHandles

Tuple skipEmptyHandles()

Specified by:

skipEmptyHandles in interface org.drools.base.reteoo.BaseTuple

getFirstChild

LeftTuple getFirstChild()

setFirstChild

void setFirstChild(LeftTuple firstChild)

getLastChild

LeftTuple getLastChild()

setLastChild

void setLastChild(LeftTuple firstChild)

getHandlePrevious

<T extends Tuple> T getHandlePrevious()

getParent

Tuple getParent()

Specified by:

getParent in interface org.drools.base.reteoo.BaseTuple

setHandlePrevious

void setHandlePrevious(Tuple leftParentLeft)

getHandleNext

<T extends Tuple> T getHandleNext()

setHandleNext

void setHandleNext(Tuple leftParentright)

getInputOtnId

ObjectTypeNode.Id getInputOtnId()

getTupleSource

<N extends org.drools.base.common.NetworkNode> N getTupleSource()

isExpired

boolean isExpired()

findMostRecentPropagationContext

default PropagationContext findMostRecentPropagationContext()