javax.datamining.association
Interface AssociationRule

public interface AssociationRule

The interface AssociationRule defines a relationship between two itemsets where the antecendent implies the consequent.

Author:

JSR-73 Java Data Mining Expert Group

Method Summary

int	getAbsoluteSupport() Returns the support for this association in terms of absolute count of transactions supporting this rule.
Itemset	getAntecedent() Returns the antecedent of the association rule.
double	getConfidence() Returns the confidence for this association as the total number of transactions with antecendent and consequent divided by the number of transactions with the antecedent as a percentage between 0 and 100, denoted as (0,100] where 100 is included.
Itemset	getConsequent() Returns the consequent of the association rule.
int	getLength() Returns the length of the rule, which includes both antecedent and consequent itemsets.
double	getLift() Returns the lift for this association defined as the number of transactions with the confidence of the rule divided by the number of transactions with the consequent.
double	getSupport() Returns the support for this association as a percentage of the total number of transactions as a number between 0 and 100, denoted as (0,100] where 100 is included.

Method Detail

getAbsoluteSupport

public int getAbsoluteSupport()

Returns the support for this association in terms of absolute count of transactions supporting this rule. The returned number must be greater than 1.

Returns:

int

getAntecedent

public Itemset getAntecedent()

Returns the antecedent of the association rule. This method cannot return null.

Returns:

Itemset

getConfidence

public double getConfidence()

Returns the confidence for this association as the total number of transactions with antecendent and consequent divided by the number of transactions with the antecedent as a percentage between 0 and 100, denoted as (0,100] where 100 is included. This has the same interpretation as present in PMML and SQL/MM DM standards.

Returns:

double

getConsequent

public Itemset getConsequent()

Returns the consequent of the association rule. This method cannot return null.

Returns:

Itemset

getLength

public int getLength()

Returns the length of the rule, which includes both antecedent and consequent itemsets. The returned value must be an integer greater than or equal to 2.

Returns:

int

getLift

public double getLift()

Returns the lift for this association defined as the number of transactions with the confidence of the rule divided by the number of transactions with the consequent. This has the same interpretation as present in PMML and SQL/MM DM standards. The returned value must be a non-negative number.

Returns:

double

getSupport

public double getSupport()

Returns the support for this association as a percentage of the total number of transactions as a number between 0 and 100, denoted as (0,100] where 100 is included. This has the same interpretation as present in PMML and SQL/MM DM standards.

Returns:

double