org.drools.spi
Interface Tuple

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ReteTuple

public interface Tuple
extends java.io.Serializable

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.

Author:
Mark Proctor, Bob McWhirter
See Also:
FactHandle;

Method Summary
 InternalFactHandle get(Declaration declaration)
          Returns the FactHandle for the given Declaration, which in turn specifcy the Pattern that they depend on.
 InternalFactHandle get(int pattern)
          Returns the FactHandle for the given pattern index.
 InternalFactHandle[] getFactHandles()
           
 long getRecency()
          Returns the tuple recency
 int size()
          Returns the size of this tuple in number of elements (patterns)
 

Method Detail

get

InternalFactHandle get(int pattern)
Returns the FactHandle for the given pattern index. If the pattern is empty It returns null.

Parameters:
pattern - The index of the pattern from which the FactHandleImpl is to be returned
Returns:
The FactHandle

get

InternalFactHandle get(Declaration declaration)
Returns the FactHandle for the given Declaration, which in turn specifcy the Pattern that they depend on.

Parameters:
declaration - The Declaration which specifies the Pattern
Returns:
The FactHandle

getFactHandles

InternalFactHandle[] getFactHandles()

getRecency

long getRecency()
Returns the tuple recency

Returns:

size

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

Returns: