oracle.dmt.odm.rule
Class MiningRule

java.lang.Object
  |
  +--oracle.dmt.odm.MiningObject
        |
        +--oracle.dmt.odm.rule.MiningRule
All Implemented Interfaces:
java.io.Serializable

public class MiningRule
extends MiningObject

An instance of MiningRule represents a rule as produced from the Association Rules model, the Adaptive Bayes Network model, or the Clustering model.

See Also:
AssociationRulesModel, AdaptiveBayesNetworkModel, ClusteringModel, RuleComponent, Serialized Form

Constructor Summary
MiningRule(int rule_id, float support, RuleComponent ante, RuleComponent conseq)
          For Internal Use Only.
 
Method Summary
TypeMethod
 void addRuleAnnotation(RuleAnnotation annotation)
          For internal use only.
 void addRuleAnnotation(RuleAnnotation[] annotations)
          For internal use only.
 RuleComponent getAntecedent()
          Returns the antecendent of the mining rule.
 RuleComponent getConsequent()
          Returns the consequent of the mining rule.
 RuleAnnotation[] getRuleAnnotations()
          Returns an array of the rule annotations in the mining rule.
 int getRuleId()
          Returns the identifier of the mining rule.
 float getSupport()
          Returns the support value of the mining rule.
 java.lang.String toString()
          Returns a formatted string representation of the mining rule for the convenience of display.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MiningRule

public MiningRule(int rule_id,
                  float support,
                  RuleComponent ante,
                  RuleComponent conseq)
           throws MiningObjectException
For Internal Use Only.
Method Detail

getRuleId

public int getRuleId()
Returns the identifier of the mining rule.
Returns:
int - The identifier of the mining rule

addRuleAnnotation

public void addRuleAnnotation(RuleAnnotation annotation)
For internal use only.

addRuleAnnotation

public void addRuleAnnotation(RuleAnnotation[] annotations)
For internal use only.

getRuleAnnotations

public RuleAnnotation[] getRuleAnnotations()
Returns an array of the rule annotations in the mining rule.
Returns:
RuleAnnotation[] The rule annotations in the mining rule.

getAntecedent

public RuleComponent getAntecedent()
Returns the antecendent of the mining rule.
Returns:
RuleComponent - The antecedent of the mining rule.

getConsequent

public RuleComponent getConsequent()
Returns the consequent of the mining rule.
Returns:
RuleComponent - The consequent of the mining rule

getSupport

public float getSupport()
Returns the support value of the mining rule.
Returns:
float - The support value of the rule

toString

public java.lang.String toString()
Returns a formatted string representation of the mining rule for the convenience of display.
Overrides:
toString in class java.lang.Object
Returns:
String - A formatted string of the mining rule