com.googlecode.sarasvati.join.lang
Interface JoinLangEnv

All Superinterfaces:

PredicateEnv

All Known Implementing Classes:

JoinLangEnvImpl

public interface JoinLangEnv
extends PredicateEnv

Method Summary

List<ArcToken>	getAvailableTokens() Returns the arc tokens which are present at the node being joined.
Engine	getEngine() Returns the engine instance performing the join
ArcToken	getInitiatingToken() Returns the arc token which initiated this join operation.
NodeToken	getMergeToken() Returns the newest token on the join node, as long as that token is not backtracked.
TokenSet	getTokenSet(String tokenSetName) Looks for a token set with the given name on the tokens which are arriving at the joining node.

Methods inherited from interface com.googlecode.sarasvati.rubric.env.PredicateEnv

evalPredicate

Method Detail

getEngine

Engine getEngine()

Returns the engine instance performing the join

Returns:

The engine instance performing the join

getInitiatingToken

ArcToken getInitiatingToken()

Returns the arc token which initiated this join operation.

Returns:

the arc token which initiated this join operation.

getAvailableTokens

List<ArcToken> getAvailableTokens()

Returns the arc tokens which are present at the node being joined. Other arc tokens may be involved in the join. These however are those most likely to be used, and are therefore easily accessible and should be cached for performance reasons.

Returns:

the arc tokens which are present at the node being joined.

getTokenSet

TokenSet getTokenSet(String tokenSetName)

Looks for a token set with the given name on the tokens which are arriving at the joining node. If none is found, returns null.

Parameters:

tokenSetName - the token set name

Returns:

The token set, or null if no token set with that name is found.

getMergeToken

NodeToken getMergeToken()

Returns the newest token on the join node, as long as that token is not backtracked. If appropriate token exist, null is returned.

Returns:

The newest token on the join node, as long as that token is not backtracked. If appropriate token exist, null is returned.