AssociationRulesProducer

All Known Implementing Classes:

Apriori, FilteredAssociator, FPGrowth
```
public interface AssociationRulesProducer
```
Interface to something that can provide a list of AssociationRules.

Version:

$Revision: 8034 $

Author:

Mark Hall (mhall{[at]}pentaho{[dot]}com)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`canProduceRules()`	Returns true if this AssociationRulesProducer can actually produce rules.
`AssociationRules`	`getAssociationRules()`	Gets the list of mined association rules.
`java.lang.String[]`	`getRuleMetricNames()`	Gets a list of the names of the metrics output for each rule.

- Method Detail
  - getAssociationRules
```
AssociationRules getAssociationRules()
```
    Gets the list of mined association rules.
    
    Returns:
    
    the list of association rules discovered during mining. Returns null if mining hasn't been performed yet.
  - getRuleMetricNames
```
java.lang.String[] getRuleMetricNames()
```
    Gets a list of the names of the metrics output for each rule. This list should be the same (in terms of the names and order thereof) as that produced by AssociationRule.getMetricNamesForRule().
    
    Returns:
    
    an array of the names of the metrics available for each rule learned by this producer.
  - canProduceRules
```
boolean canProduceRules()
```
    Returns true if this AssociationRulesProducer can actually produce rules. Most implementing classes will always return true from this method (obviously :-)). However, an implementing class that actually acts as a wrapper around things that may or may not implement AssociationRulesProducer will want to return false if the thing they wrap can't produce rules.
    
    Returns:
    
    true if this producer can produce rules in its current configuration