Package weka.associations

Class DefaultAssociationRule

java.lang.Object
weka.associations.AssociationRule
weka.associations.DefaultAssociationRule
All Implemented Interfaces:
Serializable, Comparable<AssociationRule>
public class DefaultAssociationRule extends AssociationRule implements Serializable
Class for storing and manipulating an association rule.
Author:
Mark Hall (mhall{[at]}pentaho{[dot]}com).
See Also:

  • Field Details

    • TAGS_SELECTION

      public static final Tag[] TAGS_SELECTION
      Tags for display in the GUI

  • Constructor Details

    • DefaultAssociationRule

      public DefaultAssociationRule(Collection<Item> premise, Collection<Item> consequence, DefaultAssociationRule.METRIC_TYPE metric, int premiseSupport, int consequenceSupport, int totalSupport, int totalTransactions)
      Construct a new default association rule.
      Parameters:
      premise - the premise of the rule
      consequence - the consequence of the rule
      metric - the metric for the rule
      premiseSupport - the support of the premise
      consequenceSupport - the support of the consequence
      totalSupport - the total support of the rule
      totalTransactions - the number of transactions in the data

  • Method Details

    • getPremise

      public Collection<Item> getPremise()
      Description copied from class: AssociationRule
      Get the premise of this rule.
      Specified by:
      getPremise in class AssociationRule
      Returns:
      the premise of this rule.

    • getConsequence

      public Collection<Item> getConsequence()
      Description copied from class: AssociationRule
      Get the consequence of this rule.
      Specified by:
      getConsequence in class AssociationRule
      Returns:
      the consequence of this rule.

    • getPrimaryMetricName

      public String getPrimaryMetricName()
      Description copied from class: AssociationRule
      Get the name of the primary metric of this rule (e.g. confidence).
      Specified by:
      getPrimaryMetricName in class AssociationRule
      Returns:
      the name of the primary metric of this rule.

    • getPrimaryMetricValue

      public double getPrimaryMetricValue()
      Description copied from class: AssociationRule
      Get the value of the metric for this rule.
      Specified by:
      getPrimaryMetricValue in class AssociationRule
      Returns:
      the value of the metric for this rule.

    • getNamedMetricValue

      public double getNamedMetricValue(String metricName) throws Exception
      Description copied from class: AssociationRule
      Get the value of the named metric for this rule
      Specified by:
      getNamedMetricValue in class AssociationRule
      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 int getNumberOfMetricsForRule()
      Description copied from class: AssociationRule
      Gets the number of metrics available for this rule.
      Specified by:
      getNumberOfMetricsForRule in class AssociationRule
      Returns:
      the number of metrics available for this rule

    • getMetricNamesForRule

      public String[] getMetricNamesForRule()
      Description copied from class: AssociationRule
      Return the names of the metrics available for this rule.
      Specified by:
      getMetricNamesForRule in class AssociationRule
      Returns:
      the names of the metrics that are available for this rule.

    • getMetricValuesForRule

      public double[] getMetricValuesForRule() throws Exception
      Description copied from class: AssociationRule
      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().
      Specified by:
      getMetricValuesForRule in class AssociationRule
      Returns:
      all the available metrics for this rule.
      Throws:
      Exception - if a metric can't be computed for some reason.

    • getPremiseSupport

      public int getPremiseSupport()
      Description copied from class: AssociationRule
      Get the support for the premise.
      Specified by:
      getPremiseSupport in class AssociationRule
      Returns:
      the support for the premise.

    • getConsequenceSupport

      public int getConsequenceSupport()
      Description copied from class: AssociationRule
      Get the support for the consequence.
      Specified by:
      getConsequenceSupport in class AssociationRule
      Returns:
      the support for the consequence.

    • getTotalSupport

      public int getTotalSupport()
      Description copied from class: AssociationRule
      Get the total support for this rule (premise + consequence).
      Specified by:
      getTotalSupport in class AssociationRule
      Returns:
      the total support for this rule.

    • getTotalTransactions

      public int getTotalTransactions()
      Description copied from class: AssociationRule
      Get the total number of transactions in the data.
      Specified by:
      getTotalTransactions in class AssociationRule
      Returns:
      the total number of transactions in the data.

    • toString

      public String toString()
      Get a textual description of this rule.
      Overrides:
      toString in class Object
      Returns:
      a textual description of this rule.