de.lmu.ifi.dbs.elki.result

Class AssociationRuleResult

java.lang.Object

de.lmu.ifi.dbs.elki.result.AbstractHierarchicalResult

de.lmu.ifi.dbs.elki.result.BasicResult

de.lmu.ifi.dbs.elki.result.AssociationRuleResult

All Implemented Interfaces:

HierarchicalResult, Result, TextWriteable

public class AssociationRuleResult
extends BasicResult
implements TextWriteable

Result class for association rule mining

Since:

0.7.5

Author:

Frederic Sautter

Field Summary

Fields

Modifier and Type	Field and Description
private VectorFieldTypeInformation<BitVector>	meta Metadata of the data relation, for item labels.
private java.util.List<AssociationRule>	rules Association rules together with the interestingness measure.

Constructor Summary

Constructors

Constructor and Description
AssociationRuleResult(java.lang.String name, java.lang.String shortname, java.util.List<AssociationRule> rules, VectorFieldTypeInformation<BitVector> meta) Constructor.

Method Summary

Modifier and Type	Method and Description
VectorFieldTypeInformation<BitVector>	getMeta() Returns Metadata of the data relation, for item labels.
java.util.List<AssociationRule>	getRules() Returns the rules.
void	writeToText(TextWriterStream out, java.lang.String label) Write self to the given TextWriterStream

Methods inherited from class de.lmu.ifi.dbs.elki.result.BasicResult

getLongName, getShortName

Methods inherited from class de.lmu.ifi.dbs.elki.result.AbstractHierarchicalResult

addChildResult, getHierarchy, setHierarchy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

rules

private java.util.List<AssociationRule> rules

Association rules together with the interestingness measure.

meta

private VectorFieldTypeInformation<BitVector> meta

Metadata of the data relation, for item labels.

Constructor Detail

AssociationRuleResult

public AssociationRuleResult(java.lang.String name,
                             java.lang.String shortname,
                             java.util.List<AssociationRule> rules,
                             VectorFieldTypeInformation<BitVector> meta)

Constructor.

Parameters:

name -

shortname -

Method Detail

getRules

public java.util.List<AssociationRule> getRules()

Returns the rules.

Returns:

the rules.

getMeta

public VectorFieldTypeInformation<BitVector> getMeta()

Returns Metadata of the data relation, for item labels.

Returns:

meta

writeToText

public void writeToText(TextWriterStream out,
                        java.lang.String label)

Description copied from interface: TextWriteable

Write self to the given TextWriterStream

Specified by:

writeToText in interface TextWriteable

Parameters:

out - Output writer

label - Label