com.ibm.rules.engine.ruledef.runtime
Interface RuleInstance
-
public interface RuleInstance
AnRuleInstance
object is defined by the association between anRuleAction
and the tuple that satisfies the condition part of aRule
. Although aRule
can be composed of severalRuleAction
parts, aRuleInstance
object is linked to oneRuleAction
only.- See Also:
RuleAction
-
-
Field Summary
Fields Modifier and Type Field and Description static java.lang.Object
INVALID_VALUE
Represent an invalid value of a variable, i.e.
-
Method Summary
Methods Modifier and Type Method and Description EngineData
getEngineData()
Returns theEngineData
linked to thisRuleInstance
.int
getPriority()
Returns the priority of theRule
object linked to thisRuleInstance
.int
getRecency()
Returns the recency of the tuple linked to thisRuleInstance
.Rule
getRule()
Returns theRule
object linked to this rule instance.RuleAction
getRuleAction()
Returns theRuleAction
linked thisRuleInstance
.java.lang.String
getRuleName()
Returns the name of theRule
object linked to this rule instance.java.lang.Object[]
getTuple()
Returns the object bindings or the tuple that satisfies the rule conditions.java.util.Map<java.lang.String,java.lang.Object>
getVariables()
Return the map of variables of the rule instance.
-
-
-
Field Detail
-
INVALID_VALUE
static final java.lang.Object INVALID_VALUE
Represent an invalid value of a variable, i.e. when an exception has been encountered during its evaluation.
-
-
Method Detail
-
getRule
Rule getRule()
Returns theRule
object linked to this rule instance.- Returns:
- The linked
Rule
.
-
getRuleName
java.lang.String getRuleName()
Returns the name of theRule
object linked to this rule instance.- Returns:
- The
Rule
name.
-
getRuleAction
RuleAction getRuleAction()
Returns theRuleAction
linked thisRuleInstance
.- Returns:
- The
RuleAction
instance linked thisRuleInstance
.
-
getTuple
java.lang.Object[] getTuple()
Returns the object bindings or the tuple that satisfies the rule conditions.- Returns:
- The tuple that satisfies the rule conditions.
-
getEngineData
EngineData getEngineData()
Returns theEngineData
linked to thisRuleInstance
.- Returns:
- The
EngineData
linked to thisRuleInstance
.
-
getPriority
int getPriority()
Returns the priority of theRule
object linked to thisRuleInstance
.- Returns:
- The rule priority.
-
getRecency
int getRecency()
Returns the recency of the tuple linked to thisRuleInstance
.- Returns:
- The recency of the tuple linked to this
RuleInstance
.
-
getVariables
java.util.Map<java.lang.String,java.lang.Object> getVariables()
Return the map of variables of the rule instance.- Returns:
- The map of value of the rule instance variables.
-
-