opendial.domains.rules

Class Rule

java.lang.Object

opendial.domains.rules.Rule

public class Rule
extends java.lang.Object

Generic representation of a probabilistic rule, with an identifier and an ordered list of cases. The rule can be either a probability or a utility rule.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Rule.RuleType

Constructor Summary

Constructors

Constructor and Description
Rule(java.lang.String id, Rule.RuleType ruleType) Creates a new rule, with the given identifier and type, and an empty list of cases

Method Summary

Modifier and Type	Method and Description
void	addCase(Condition condition, RuleOutput output) Adds a new case to the abstract rule
boolean	equals(java.lang.Object o) Returns true if o is a rule that has the same identifier, rule type and list of cases than the current rule.
java.util.Set<Effect>	getEffects() Returns the set of all possible effects in the rule.
java.util.Set<Template>	getInputVariables() Returns the input variables (possibly underspecified, with slots to fill) for the rule
RuleOutput	getOutput(Assignment input) Returns the first rule output whose condition matches the input assignment provided as argument.
java.util.Set<java.lang.String>	getParameterIds() Returns the set of all parameter identifiers employed in the rule
java.lang.String	getRuleId() Returns the rule identifier
Rule.RuleType	getRuleType() Returns the rule type
int	hashCode() Returns the hashcode for the rule
java.lang.String	toString() Returns a string representation for the rule

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Rule

public Rule(java.lang.String id,
            Rule.RuleType ruleType)

Creates a new rule, with the given identifier and type, and an empty list of cases

Parameters:

id - the identifier

ruleType - the rule type

Method Detail

addCase

public void addCase(Condition condition,
                    RuleOutput output)

Adds a new case to the abstract rule

Parameters:

condition - the condition

output - the corresponding output

getRuleId

public java.lang.String getRuleId()

Returns the rule identifier

Returns:

the rule identifier

getInputVariables

public java.util.Set<Template> getInputVariables()

Returns the input variables (possibly underspecified, with slots to fill) for the rule

Returns:

the set of labels for the input variables

getOutput

public RuleOutput getOutput(Assignment input)

Returns the first rule output whose condition matches the input assignment provided as argument. The output contains the grounded list of effects associated with the satisfied condition.

Parameters:

input - the input assignment

Returns:

the matched rule output.

getRuleType

public Rule.RuleType getRuleType()

Returns the rule type

Returns:

the rule type

getParameterIds

public java.util.Set<java.lang.String> getParameterIds()

Returns the set of all parameter identifiers employed in the rule

Returns:

the set of parameter identifiers

getEffects

public java.util.Set<Effect> getEffects()

Returns the set of all possible effects in the rule.

Returns:

the set of all possible effects

toString

public java.lang.String toString()

Returns a string representation for the rule

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Returns the hashcode for the rule

Overrides:

hashCode in class java.lang.Object

Returns:

the hashcode

equals

public boolean equals(java.lang.Object o)

Returns true if o is a rule that has the same identifier, rule type and list of cases than the current rule.

Overrides:

equals in class java.lang.Object

Parameters:

o - the object to compare

Returns:

true if the object is an identical rule, false otherwise.