org.drools.core.common

Class BaseNode

java.lang.Object

org.drools.core.common.BaseNode

All Implemented Interfaces:

Externalizable, Serializable, NetworkNode

Direct Known Subclasses:

AbstractTerminalNode, LeftTupleSource, ObjectSource

public abstract class BaseNode
extends Object
implements NetworkNode

The base class for all Rete nodes.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Bag<org.kie.api.definition.rule.Rule>	associations
protected int	hashcode
protected int	id
protected RuleBasePartitionId	partitionId
protected boolean	partitionsEnabled

Constructor Summary

Constructors

Constructor and Description
BaseNode()
BaseNode(int id, RuleBasePartitionId partitionId, boolean partitionsEnabled) All nodes have a unique id, set in the constructor.

Method Summary

Modifier and Type	Method and Description
void	addAssociation(BuildContext context, org.kie.api.definition.rule.Rule rule)
void	addAssociation(org.kie.api.definition.rule.Rule rule) Associates this node with the give rule
abstract void	attach(BuildContext context) Attaches the node into the network.
protected abstract boolean	doRemove(RuleRemovalContext context, ReteooBuilder builder, InternalWorkingMemory[] workingMemories) Removes the node from the network.
int	getAssociatedRuleSize() Returns the number of rules that are associated with this node, regardless of how many times the node is associated with a single rule.
int	getAssociationsSize() Returns how many times this nodes has been associated.
int	getAssociationsSize(org.kie.api.definition.rule.Rule rule)
int	getId() Returns the unique id that represents the node in the Rete network
RuleBasePartitionId	getPartitionId() Returns the partition ID for which this node belongs to
int	hashCode()
protected abstract boolean	internalEquals(Object object)
boolean	isAssociatedWith(org.kie.api.definition.rule.Rule rule)
abstract boolean	isInUse() Returns true in case the current node is in use (is referenced by any other node)
boolean	isStreamMode()
abstract 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 opportunity for state update
void	readExternal(ObjectInput in)
boolean	remove(RuleRemovalContext context, ReteooBuilder builder, InternalWorkingMemory[] workingMemories)
boolean	removeAssociation(org.kie.api.definition.rule.Rule rule) Removes the association to the given rule from the associations map.
void	setId(int id)
void	setPartitionId(BuildContext context, RuleBasePartitionId partitionId) Sets the partition this node belongs to
protected void	setStreamMode(boolean streamMode)
boolean	thisNodeEquals(Object object)
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

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

getType

Field Detail

id

protected int id

partitionId

protected RuleBasePartitionId partitionId

partitionsEnabled

protected boolean partitionsEnabled

associations

protected Bag<org.kie.api.definition.rule.Rule> associations

hashcode

protected int hashcode

Constructor Detail

BaseNode

public BaseNode()

BaseNode

public BaseNode(int id,
                RuleBasePartitionId partitionId,
                boolean partitionsEnabled)

All nodes have a unique id, set in the constructor.

Parameters:

id - The unique id

Method Detail

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

getId

public int getId()

Description copied from interface: NetworkNode

Returns the unique id that represents the node in the Rete network

Specified by:

getId in interface NetworkNode

setId

public void setId(int id)

isStreamMode

public boolean isStreamMode()

setStreamMode

protected void setStreamMode(boolean streamMode)

attach

public abstract void attach(BuildContext context)

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

networkUpdated

public abstract 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 opportunity for state update

remove

public boolean remove(RuleRemovalContext context,
                      ReteooBuilder builder,
                      InternalWorkingMemory[] workingMemories)

doRemove

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

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

isInUse

public abstract boolean isInUse()

Returns true in case the current node is in use (is referenced by any other node)

toString

public String toString()

Overrides:

toString in class Object

getPartitionId

public RuleBasePartitionId getPartitionId()

Returns the partition ID for which this node belongs to

Specified by:

getPartitionId in interface NetworkNode

setPartitionId

public void setPartitionId(BuildContext context,
                           RuleBasePartitionId partitionId)

Sets the partition this node belongs to

addAssociation

public void addAssociation(org.kie.api.definition.rule.Rule rule)

Associates this node with the give rule

addAssociation

public void addAssociation(BuildContext context,
                           org.kie.api.definition.rule.Rule rule)

removeAssociation

public boolean removeAssociation(org.kie.api.definition.rule.Rule rule)

Removes the association to the given rule from the associations map.

getAssociationsSize

public int getAssociationsSize()

Description copied from interface: NetworkNode

Returns how many times this nodes has been associated. Note that due to subnetworks this node could be associated to the same rule multiple times.

Specified by:

getAssociationsSize in interface NetworkNode

getAssociatedRuleSize

public int getAssociatedRuleSize()

Description copied from interface: NetworkNode

Returns the number of rules that are associated with this node, regardless of how many times the node is associated with a single rule.

Specified by:

getAssociatedRuleSize in interface NetworkNode

getAssociationsSize

public int getAssociationsSize(org.kie.api.definition.rule.Rule rule)

Specified by:

getAssociationsSize in interface NetworkNode

isAssociatedWith

public boolean isAssociatedWith(org.kie.api.definition.rule.Rule rule)

Specified by:

isAssociatedWith in interface NetworkNode

thisNodeEquals

public boolean thisNodeEquals(Object object)

Specified by:

thisNodeEquals in interface NetworkNode

internalEquals

protected abstract boolean internalEquals(Object object)

hashCode

public final int hashCode()

Overrides:

hashCode in class Object