org.drools.reteoo.beta
Interface BetaRightMemory

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

BooleanConstrainedRightMemory, DefaultRightMemory, ObjectEqualConstrRightMemory, ObjectNotEqualConstrRightMemory

public interface BetaRightMemory

extends java.io.Serializable

BetaRightMemory The BetaRightMemory is the interface for all classes implementing the right memory of a BetaMemory instance. The right memory is responsible for indexing and storing references to all input fact handles in the ReteOO network. Specialized implementations for this interface are capable of indexing and partitioning the fact handles with the objective of improve query time. Although, the implementations are all required to keep the order of objects, and iterate then in order with the iterator() method.

Method Summary

void	add(WorkingMemory workingMemory, MultiLinkedListNodeWrapper matches) Adds an object to the right memory
void	add(WorkingMemory workingMemory, ObjectMatches matches) Adds an object to the right memory
BetaRightMemory	getInnerMemory() Returns the inner beta right memory in case of a multi-indexed memory
boolean	isEmpty() Returns true if the memory is empty
boolean	isPossibleMatch(MultiLinkedListNodeWrapper matches) Returns true if the matches is a possible match to the tuple given to the previous selectPossibleMatches() call
java.util.Iterator	iterator() Returns an iterator that allows to iterate over all the ObjectMatches in the beta right memory.
java.util.Iterator	iterator(WorkingMemory workingMemory, ReteTuple tuple) Returns an iterator that allows to iterate over the ObjectMatches (and referenced FactHandles) that are possible matches to the given tuple.
void	remove(WorkingMemory workingMemory, MultiLinkedListNodeWrapper matches) Removes the given match from memory
void	remove(WorkingMemory workingMemory, ObjectMatches matches) Removes the given match from memory
void	selectPossibleMatches(WorkingMemory workingMemory, ReteTuple tuple) Prepares the right memory for subsequent calls of isPossibleMatch() based on the constraints applied to the tuples
void	setInnerMemory(BetaRightMemory innerMemory) Sets the inner beta right memory in case of a multi-indexed memory
int	size() Returns the number of objects currently stored in the right memory

Method Detail

add

public void add(WorkingMemory workingMemory,
                ObjectMatches matches)

Adds an object to the right memory

Parameters:

workingMemory - the working memory reference

matches - the matches object (with the reference to the fact implementation)

remove

public void remove(WorkingMemory workingMemory,
                   ObjectMatches matches)

Removes the given match from memory

Parameters:

workingMemory - the working memory reference

matches -

add

public void add(WorkingMemory workingMemory,
                MultiLinkedListNodeWrapper matches)

Adds an object to the right memory

Parameters:

workingMemory - the working memory reference

matches - the matches object (with the reference to the fact implementation)

remove

public void remove(WorkingMemory workingMemory,
                   MultiLinkedListNodeWrapper matches)

Removes the given match from memory

Parameters:

workingMemory - the working memory reference

matches -

iterator

public java.util.Iterator iterator(WorkingMemory workingMemory,
                                   ReteTuple tuple)

Returns an iterator that allows to iterate over the ObjectMatches (and referenced FactHandles) that are possible matches to the given tuple. IMPORTANT: this iterator should NOT implement/support the remove() method

Parameters:

workingMemory - the working memory reference

tuple - the tuple that will possibly join with the returned matches

Returns:

iterator

public java.util.Iterator iterator()

Returns an iterator that allows to iterate over all the ObjectMatches in the beta right memory. This might not be much efficient for indexed memories, so this shall be used only when changing RETE network layoud (adding/removing rules).

Returns:

size

public int size()

Returns the number of objects currently stored in the right memory

Returns:

the number of objects currently stored in the right memory

isEmpty

public boolean isEmpty()

Returns true if the memory is empty

Returns:

selectPossibleMatches

public void selectPossibleMatches(WorkingMemory workingMemory,
                                  ReteTuple tuple)

Prepares the right memory for subsequent calls of isPossibleMatch() based on the constraints applied to the tuples

isPossibleMatch

public boolean isPossibleMatch(MultiLinkedListNodeWrapper matches)

Returns true if the matches is a possible match to the tuple given to the previous selectPossibleMatches() call

Parameters:

matches -

Returns:

setInnerMemory

public void setInnerMemory(BetaRightMemory innerMemory)
                    throws javax.naming.OperationNotSupportedException

Sets the inner beta right memory in case of a multi-indexed memory

Throws:

javax.naming.OperationNotSupportedException

Parameters:

innerMemory -

getInnerMemory

public BetaRightMemory getInnerMemory()
                               throws javax.naming.OperationNotSupportedException

Returns the inner beta right memory in case of a multi-indexed memory

Throws:

javax.naming.OperationNotSupportedException

Returns:

the inner beta right memory or null in case it is not a multi-indexed memory