Package elki.result

Class AssociationRuleResult

  • All Implemented Interfaces:
    elki.result.textwriter.TextWriteable
    public class AssociationRuleResult
extends java.lang.Object
implements elki.result.textwriter.TextWriteable
    Result class for association rule mining
    Since:
    0.7.5
    Author:
    Frederic Sautter

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private elki.data.type.VectorFieldTypeInformation<elki.data.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 Description
      AssociationRuleResult​(java.util.List<AssociationRule> rules, elki.data.type.VectorFieldTypeInformation<elki.data.BitVector> meta)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      elki.data.type.VectorFieldTypeInformation<elki.data.BitVector> getMeta()
      Returns Metadata of the data relation, for item labels.
      java.util.List<AssociationRule> getRules()
      Returns the rules.
      void writeToText​(elki.result.textwriter.TextWriterStream out, java.lang.String label)  

      • 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 elki.data.type.VectorFieldTypeInformation<elki.data.BitVector> meta
        Metadata of the data relation, for item labels.

    • Constructor Detail

      • AssociationRuleResult

        public AssociationRuleResult​(java.util.List<AssociationRule> rules,
                             elki.data.type.VectorFieldTypeInformation<elki.data.BitVector> meta)
        Constructor.
        Parameters:
        rules - Association rules
        meta - Column metadata

    • Method Detail

      • getRules

        public java.util.List<AssociationRule> getRules()
        Returns the rules.
        Returns:
        the rules.

      • getMeta

        public elki.data.type.VectorFieldTypeInformation<elki.data.BitVector> getMeta()
        Returns Metadata of the data relation, for item labels.
        Returns:
        meta

      • writeToText

        public void writeToText​(elki.result.textwriter.TextWriterStream out,
                        java.lang.String label)
        Specified by:
        writeToText in interface elki.result.textwriter.TextWriteable