Rule

java.lang.Object
- heart.xtt.Rule

All Implemented Interfaces:: Annotated

public class Rule
extends java.lang.Object
implements Annotated

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Rule.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`Rule.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.LinkedList<java.lang.String>`	`actions` List of names for the `Action` interface implementations that should be executed when the rules conditions are true.
`protected java.util.List<Annotation>`	`annotations`
`protected float`	`certaintyFactor` The certainty factor of a rule.
`protected java.util.LinkedList<Formulae>`	`conditions` A list that contains a list of firing conditions for the rule.
`protected java.util.LinkedList<Decision>`	`decisions` List that contains decisions that has to be fired when conditions are true.
`protected java.lang.String`	`id` This field is used by the SQL module while storing/restoring model into/from database.
`protected java.lang.Integer`	`orderNumber` This field contains rule's order number.
`protected java.util.LinkedList<Rule>`	`ruleLinks` This is a list of rules that the inference engine should proceed to after firing this rule.
`protected java.lang.String`	`schemeName` This field contains scheme's name to which the rule belongs.
`protected java.util.LinkedList<Table>`	`tabLinks` This is a list of rules that the inference engine should proceed to after firing this rule.

Constructor Summary

Constructors
Constructor and Description

Rule()

Constructors
Constructor and Description
`Rule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<Annotation>`	`annotations()`
`java.util.List<Annotation>`	`annotationsNamed(java.lang.String name)`
`UncertainTrue`	`evaluate(WorkingMemory wm, UncertainTrueEvaluator ute)` Method that evaluates all the rules conditions.
`boolean`	`execute(WorkingMemory wm, UncertainTrue certainty)` Method that fires the decision part of the rule.
`java.util.LinkedList<java.lang.String>`	`getActions()`
`float`	`getCertaintyFactor()`
`java.util.LinkedList<Formulae>`	`getConditions()`
`java.util.LinkedList<Decision>`	`getDecisions()`
`java.lang.String`	`getId()`
`java.lang.String`	`getName()`
`java.lang.Integer`	`getOrderNumber()`
`java.util.LinkedList<Rule>`	`getRuleLinks()`
`java.lang.String`	`getSchemeName()`
`java.util.LinkedList<Table>`	`getTabLinks()`
`protected void`	`setTabLinks(java.util.LinkedList<Table> tablinks)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - id
```
protected java.lang.String id
```
    This field is used by the SQL module while storing/restoring model into/from database. If not provided, this should be null;
  - schemeName
```
protected java.lang.String schemeName
```
    This field contains scheme's name to which the rule belongs. Used mainly in debugging.
  - orderNumber
```
protected java.lang.Integer orderNumber
```
    This field contains rule's order number. It should uniquely identify the rule in table. Moreover it's used during infence as a conflict resolver.
  - certaintyFactor
```
protected float certaintyFactor
```
    The certainty factor of a rule. It represents a confidence of the rule.
  - ruleLinks
```
protected java.util.LinkedList<Rule> ruleLinks
```
    This is a list of rules that the inference engine should proceed to after firing this rule.
  - tabLinks
```
protected java.util.LinkedList<Table> tabLinks
```
    This is a list of rules that the inference engine should proceed to after firing this rule.
  - conditions
```
protected java.util.LinkedList<Formulae> conditions
```
    A list that contains a list of firing conditions for the rule. Each condition has to be valid ALSV(FD) expression defined by the Formulae.
  - decisions
```
protected java.util.LinkedList<Decision> decisions
```
    List that contains decisions that has to be fired when conditions are true. Decision is defined by the Decision class.
  - actions
```
protected java.util.LinkedList<java.lang.String> actions
```
    List of names for the Action interface implementations that should be executed when the rules conditions are true.
  - annotations
```
protected java.util.List<Annotation> annotations
```
- Constructor Detail
  - Rule
```
public Rule()
```
- Method Detail
  - evaluate
```
public UncertainTrue evaluate(WorkingMemory wm,
                              UncertainTrueEvaluator ute)
                       throws NotInTheDomainException,
                              UnknownValueException
```
    Method that evaluates all the rules conditions. It does not execute the decision part of the rule, it only evaluates the conditional part.
    
    Parameters:
    
    wm - a working memory object that contains information about attributes values
    
    Returns:
    
    true if all the rule's conditions are true, false otherwise
    
    Throws:
    
    NotInTheDomainException
    
    UnknownValueException
  - execute
```
public boolean execute(WorkingMemory wm,
                       UncertainTrue certainty)
                throws java.lang.UnsupportedOperationException,
                       NotInTheDomainException
```
    Method that fires the decision part of the rule. It does not evaluate the rule conditions. For that, refer to evaluate(heart.WorkingMemory, heart.uncertainty.UncertainTrueEvaluator).
    
    Parameters:
    
    wm - a working memory object that contains information about attributes values
    
    Returns:
    
    true, if the rule was correctly executed, false if there are some errors
    
    Throws:
    
    java.lang.UnsupportedOperationException
    
    NotInTheDomainException
  - getId
```
public java.lang.String getId()
```
  - getSchemeName
```
public java.lang.String getSchemeName()
```
  - getName
```
public java.lang.String getName()
```
  - getOrderNumber
```
public java.lang.Integer getOrderNumber()
```
  - getRuleLinks
```
public java.util.LinkedList<Rule> getRuleLinks()
```
  - getTabLinks
```
public java.util.LinkedList<Table> getTabLinks()
```
  - setTabLinks
```
protected void setTabLinks(java.util.LinkedList<Table> tablinks)
```
  - getConditions
```
public java.util.LinkedList<Formulae> getConditions()
```
  - getDecisions
```
public java.util.LinkedList<Decision> getDecisions()
```
  - getCertaintyFactor
```
public float getCertaintyFactor()
```
  - getActions
```
public java.util.LinkedList<java.lang.String> getActions()
```
  - annotations
```
public java.util.List<Annotation> annotations()
```
    Specified by:
    
    annotations in interface Annotated
  - annotationsNamed
```
public java.util.List<Annotation> annotationsNamed(java.lang.String name)
```
    Specified by:
    
    annotationsNamed in interface Annotated

Class Rule

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

schemeName

orderNumber

certaintyFactor

ruleLinks

tabLinks

conditions

decisions

actions

annotations

Constructor Detail

Rule

Method Detail

evaluate

execute

getId

getSchemeName

getName

getOrderNumber

getRuleLinks

getTabLinks

setTabLinks

getConditions

getDecisions

getCertaintyFactor

getActions

annotations

annotationsNamed