ABLE, Version 1.1b

com.ibm.able.beans.rules
Class AbleRule

java.lang.Object
  |
  +--com.ibm.able.beans.rules.AbleRule

public class AbleRule
extends java.lang.Object
implements java.io.Serializable

A Rule consists of a set of antecedent clauses (logically ANDed together) and one consequent clause. Unless the Rule is a simple assertion, in which case it has NO antecendents and the consequent clause represents the assertion.

Version:
1.0.0; change log:
 Version   Description
 --------  -----------
 1.0.0     Initial release.

 
See Also:
Serialized Form

Field Summary
 java.lang.String name
           
 
Constructor Summary
AbleRule(java.lang.String Name, AbleClause lhs1, AbleClause lhs2, AbleClause lhs3, AbleClause lhs4, AbleConsequentClause rhs)
           
AbleRule(java.lang.String Name, AbleClause lhs1, AbleClause lhs2, AbleClause lhs3, AbleConsequentClause rhs)
           
AbleRule(java.lang.String Name, AbleClause lhs1, AbleClause lhs2, AbleConsequentClause rhs)
           
AbleRule(java.lang.String Name, AbleClause lhs, AbleConsequentClause rhs)
          Create a new effector with the specified parts.
AbleRule(java.lang.String Name, AbleConsequentClause rhs)
           
AbleRule(java.lang.String Name, java.util.Vector lhsClauses, AbleConsequentClause rhs)
           
 
Method Summary
 java.lang.Boolean backChain()
          backChain - determine if a rule is true or false by recursively trying to prove its antecedent clauses are true if any are false, the rule is false
 java.lang.Boolean check()
           
static void checkRules(java.util.Vector clauseRefs)
          Check all rules referred to by the vector of clauses
 void fire()
           
 AbleConsequentClause getConsequent()
          Retrieve the number of antecedents in this rule.
 java.lang.String getName()
           
 double getRulePriority()
           
 AbleRuleSet getRuleSet()
           
 long numAntecedents()
          Retrieve the number of antecedents in this rule.
 void reset()
           
 java.lang.String rlString()
          Return a formal able Rule Language String.
 void setRulePriority(double thePriority)
           
 void setRuleSet(AbleRuleSet ruleSet)
          set the owning rule set for this rule
 java.lang.String toString()
           
 java.lang.String xmlString()
          Return a formal XML string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

name

public java.lang.String name
Constructor Detail

AbleRule

public AbleRule(java.lang.String Name,
                AbleClause lhs,
                AbleConsequentClause rhs)
Create a new effector with the specified parts.

AbleRule

public AbleRule(java.lang.String Name,
                AbleClause lhs1,
                AbleClause lhs2,
                AbleConsequentClause rhs)

AbleRule

public AbleRule(java.lang.String Name,
                AbleClause lhs1,
                AbleClause lhs2,
                AbleClause lhs3,
                AbleConsequentClause rhs)

AbleRule

public AbleRule(java.lang.String Name,
                AbleClause lhs1,
                AbleClause lhs2,
                AbleClause lhs3,
                AbleClause lhs4,
                AbleConsequentClause rhs)

AbleRule

public AbleRule(java.lang.String Name,
                java.util.Vector lhsClauses,
                AbleConsequentClause rhs)

AbleRule

public AbleRule(java.lang.String Name,
                AbleConsequentClause rhs)
Method Detail

numAntecedents

public long numAntecedents()
Retrieve the number of antecedents in this rule.
Returns:
The number of antecedents in this rule.

getConsequent

public AbleConsequentClause getConsequent()
Retrieve the number of antecedents in this rule.
Returns:
The number of antecedents in this rule.

getName

public java.lang.String getName()

checkRules

public static void checkRules(java.util.Vector clauseRefs)
Check all rules referred to by the vector of clauses
Parameters:
clauseRefs - A vector of clauses which have changed and so corresponding rules need to be retested


check

public java.lang.Boolean check()

fire

public void fire()

backChain

public java.lang.Boolean backChain()
backChain - determine if a rule is true or false by recursively trying to prove its antecedent clauses are true if any are false, the rule is false

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

reset

public void reset()

setRuleSet

public void setRuleSet(AbleRuleSet ruleSet)
set the owning rule set for this rule

getRuleSet

public AbleRuleSet getRuleSet()

setRulePriority

public void setRulePriority(double thePriority)

getRulePriority

public double getRulePriority()

rlString

public java.lang.String rlString()
Return a formal able Rule Language String.
Returns:
A String describing the object in able rule language.


xmlString

public java.lang.String xmlString()
Return a formal XML string.
Returns:
A String describing the object in XML.


ABLE, Version 1.1b

ABLE: Produced by Joe, Don, and Jeff who say, 'Thanks for your support.'