com.bigdata.relation.rule.eval
Interface IRuleState

All Known Implementing Classes:

RuleState

public interface IRuleState

Version:

$Id: IRuleState.java 4218 2011-02-21 22:01:49Z thompsonbry $

Author:

Bryan Thompson

Method Summary

IKeyOrder[]	getKeyOrder() An array of the IKeyOrder that will be used for each predicate in the tail of the rule.
int[]	getNVars() The #of unbound variables for the predicates in the tail of the Rule for the evaluation plan.
IEvaluationPlan	getPlan() The evaluation plan.
IVariable[][]	getRequiredVars() A list of variables required for each tail, by tailIndex.
IRule	getRule() The IRule being evaluated.
String	toString() Externalizes the rule and the evaluation order.
String	toString(IBindingSet bindingSet) Shows the bindings (if given), the computed evaluation order, and the computed IKeyOrder for each IPredicate in the rule.

Method Detail

getRule

IRule getRule()

The IRule being evaluated.

getPlan

IEvaluationPlan getPlan()

The evaluation plan.

getNVars

int[] getNVars()

The #of unbound variables for the predicates in the tail of the Rule for the evaluation plan. The array is correlated with the predicates index in the tail of the rule NOT with its evaluation order.

getKeyOrder

IKeyOrder[] getKeyOrder()

An array of the IKeyOrder that will be used for each predicate in the tail of the rule. The array is correlated with the predicates index in the tail of the rule NOT with its evaluation order.

Note: The fully qualified index name for a given predicate is the name of the relation for that predicate plus IKeyOrder.getIndexName().

getRequiredVars

IVariable[][] getRequiredVars()

A list of variables required for each tail, by tailIndex. Used to filter downstream variable binding sets.

toString

String toString()

Externalizes the rule and the evaluation order.

Overrides:

toString in class Object

toString

String toString(IBindingSet bindingSet)

Shows the bindings (if given), the computed evaluation order, and the computed IKeyOrder for each IPredicate in the rule.

Parameters:

bindingSet - When non-null, the current variable bindings will be displayed. Otherwise, the names of variables will be displayed rather than their bindings.