public abstract class AssociationRule extends java.lang.Object implements java.lang.Comparable<AssociationRule>
Constructor and Description |
---|
AssociationRule() |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(AssociationRule other)
Compare this rule to the supplied rule.
|
boolean |
containsItems(java.util.ArrayList<Item> items,
boolean useOr) |
boolean |
equals(java.lang.Object other)
Return true if this rule is equal to the supplied one.
|
abstract java.util.Collection<Item> |
getConsequence()
Get the consequence of this rule.
|
abstract int |
getConsequenceSupport()
Get the support for the consequence.
|
abstract java.lang.String[] |
getMetricNamesForRule()
Return the names of the metrics available for this rule.
|
abstract double[] |
getMetricValuesForRule()
Get all the available metric values for this rule.
|
abstract double |
getNamedMetricValue(java.lang.String metricName)
Get the value of the named metric for this rule
|
abstract int |
getNumberOfMetricsForRule()
Gets the number of metrics available for this rule.
|
abstract java.util.Collection<Item> |
getPremise()
Get the premise of this rule.
|
abstract int |
getPremiseSupport()
Get the support for the premise.
|
abstract java.lang.String |
getPrimaryMetricName()
Get the name of the primary metric of this rule (e.g.
|
abstract double |
getPrimaryMetricValue()
Get the value of the metric for this rule.
|
abstract int |
getTotalSupport()
Get the total support for this rule (premise + consequence).
|
abstract int |
getTotalTransactions()
Get the total number of transactions in the data.
|
public abstract java.util.Collection<Item> getPremise()
public abstract java.util.Collection<Item> getConsequence()
public abstract java.lang.String getPrimaryMetricName()
public abstract double getPrimaryMetricValue()
public abstract double getNamedMetricValue(java.lang.String metricName) throws java.lang.Exception
metricName
- the metric to get the value forjava.lang.Exception
- if the requested metric is unknown for this rulepublic abstract int getNumberOfMetricsForRule()
public abstract java.lang.String[] getMetricNamesForRule()
public abstract double[] getMetricValuesForRule() throws java.lang.Exception
java.lang.Exception
- if a metric can't be computed for some reason.public abstract int getPremiseSupport()
public abstract int getConsequenceSupport()
public abstract int getTotalSupport()
public abstract int getTotalTransactions()
public int compareTo(AssociationRule other)
compareTo
in interface java.lang.Comparable<AssociationRule>
other
- the rule to compare to.public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
public boolean containsItems(java.util.ArrayList<Item> items, boolean useOr)