org.grouplens.grapht.solver

Interface BindRule

All Superinterfaces:

Comparable<BindRule>

public interface BindRule
extends Comparable<BindRule>

BindRule is a partial function from desire to desire that acts as a binding. The RuleBasedBindingFunction takes a collection of BindRules grouped into their activating contexts to form a BindingFunction.

Note: this interface's ordering is inconsistent with Object.equals(Object). See compareTo(BindRule) for more details.

See Also:

BindRules

Method Summary

Modifier and Type	Method and Description
Desire	apply(Desire desire) Apply this BindRule to the given Desire, and return a restricted and possibly satisfied desire.
int	compareTo(BindRule other) Compare this bind rule to another.
CachePolicy	getCachePolicy() Get the rule's cache policy.
EnumSet<BindingFlag>	getFlags() Get the flags attached to this bind rule.
boolean	isTerminal() Query whether this rule is terminal.
boolean	matches(Desire desire)
BindRuleBuilder	newCopyBuilder() Create a new bind rule builder initialized to copy this bind rule.

Method Detail

getCachePolicy

CachePolicy getCachePolicy()

Get the rule's cache policy.

Returns:

The CachePolicy to use for satisfactions created with this rule.

apply

Desire apply(Desire desire)

Apply this BindRule to the given Desire, and return a restricted and possibly satisfied desire. It is assumed that matches(org.grouplens.grapht.reflect.Desire) returns true.

Parameters:

desire - The desire that is input to this partial binding function

Returns:

The restricted desire

isTerminal

boolean isTerminal()

Query whether this rule is terminal. Terminal rules have no further lookup applied in order to find the final binding target.

Returns:

True if this should be the last bind rule applied to the desire chain when attempting to find a satisfaction

getFlags

EnumSet<BindingFlag> getFlags()

Get the flags attached to this bind rule.

Returns:

The flags attached to the bind rule.

matches

boolean matches(Desire desire)

Parameters:

desire - The input desire

Returns:

True if this desire matches this BindRule and can be passed to apply(org.grouplens.grapht.reflect.Desire)

newCopyBuilder

BindRuleBuilder newCopyBuilder()

Create a new bind rule builder initialized to copy this bind rule. Use this to create a copy of this bind rule that differs in some way.

Returns:

A new bind rule builder whose BindRuleBuilder.build() method will return a copy of this bind rule.

Throws:

UnsupportedOperationException - if the bind rule cannot be reconfigured in this manner.

compareTo

int compareTo(BindRule other)

Compare this bind rule to another. More-specific bind rules compare less than less-specific rules.

Note: This implements an ordering inconsistent with Object.equals(Object). Equal rules will compare the same (and implementations are required to enforce this), but unequal rules may compare equal to each other when compared with this method.

Specified by:

compareTo in interface Comparable<BindRule>

Parameters:

other - The bind rule to compare with.

Returns:

The comparison result.

Throws:

IllegalArgumentException - if called with an incompatible bind rule. This should not arise in practice, but if you implement your own bind rules they will not be comparable with the ones provided by Grapht.