Package weka.associations

Class AssociationRule

java.lang.Object
weka.associations.AssociationRule
All Implemented Interfaces:
Comparable<AssociationRule>
Direct Known Subclasses:
DefaultAssociationRule
public abstract class AssociationRule extends Object implements Comparable<AssociationRule>
Abstract class for storing and manipulating an association rule.
Version:
$Revision: 8034 $
Author:
Mark Hall (mhall{[at]}pentaho{[dot]}com).

  • Constructor Details

    • AssociationRule

      public AssociationRule()

  • Method Details

    • getPremise

      public abstract Collection<Item> getPremise()
      Get the premise of this rule.
      Returns:
      the premise of this rule.

    • getConsequence

      public abstract Collection<Item> getConsequence()
      Get the consequence of this rule.
      Returns:
      the consequence of this rule.

    • getPrimaryMetricName

      public abstract String getPrimaryMetricName()
      Get the name of the primary metric of this rule (e.g. confidence).
      Returns:
      the name of the primary metric of this rule.

    • getPrimaryMetricValue

      public abstract double getPrimaryMetricValue()
      Get the value of the metric for this rule.
      Returns:
      the value of the metric for this rule.

    • getNamedMetricValue

      public abstract double getNamedMetricValue(String metricName) throws Exception
      Get the value of the named metric for this rule
      Parameters:
      metricName - the metric to get the value for
      Returns:
      the value of the named metric
      Throws:
      Exception - if the requested metric is unknown for this rule

    • getNumberOfMetricsForRule

      public abstract int getNumberOfMetricsForRule()
      Gets the number of metrics available for this rule.
      Returns:
      the number of metrics available for this rule

    • getMetricNamesForRule

      public abstract String[] getMetricNamesForRule()
      Return the names of the metrics available for this rule.
      Returns:
      the names of the metrics that are available for this rule.

    • getMetricValuesForRule

      public abstract double[] getMetricValuesForRule() throws Exception
      Get all the available metric values for this rule. Values are returned in an array with entries that correspond to the metric names returned by getMetricNamesForRule().
      Returns:
      all the available metrics for this rule.
      Throws:
      Exception - if a metric can't be computed for some reason.

    • getPremiseSupport

      public abstract int getPremiseSupport()
      Get the support for the premise.
      Returns:
      the support for the premise.

    • getConsequenceSupport

      public abstract int getConsequenceSupport()
      Get the support for the consequence.
      Returns:
      the support for the consequence.

    • getTotalSupport

      public abstract int getTotalSupport()
      Get the total support for this rule (premise + consequence).
      Returns:
      the total support for this rule.

    • getTotalTransactions

      public abstract int getTotalTransactions()
      Get the total number of transactions in the data.
      Returns:
      the total number of transactions in the data.

    • compareTo

      public int compareTo(AssociationRule other)
      Compare this rule to the supplied rule.
      Specified by:
      compareTo in interface Comparable<AssociationRule>
      Parameters:
      other - the rule to compare to.
      Returns:
      the result of the comparison.

    • equals

      public boolean equals(Object other)
      Return true if this rule is equal to the supplied one.
      Overrides:
      equals in class Object
      Returns:
      true if this rule is the same as the supplied rule.

    • containsItems

      public boolean containsItems(ArrayList<Item> items, boolean useOr)