AssociationRule.java

/***********************************************************************

	This file is part of KEEL-software, the Data Mining tool for regression, 
	classification, clustering, pattern mining and so on.

	Copyright (C) 2004-2010
	
	F. Herrera (herrera@decsai.ugr.es)
    L. S�nchez (luciano@uniovi.es)
    J. Alcal�-Fdez (jalcala@decsai.ugr.es)
    S. Garc�a (sglopez@ujaen.es)
    A. Fern�ndez (alberto.fernandez@ujaen.es)
    J. Luengo (julianlm@decsai.ugr.es)

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation, either version 3 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program.  If not, see http://www.gnu.org/licenses/
  
**********************************************************************/

package keel.Algorithms.UnsupervisedLearning.AssociationRules.IntervalRuleLearning.Alatasetal;

/**
 * <p>
 * @author Written by Nicol� Flugy Pap� (Politecnico di Milano) 24/03/2009
 * @author Modified by Diana Mart�n (dmartin@ceis.cujae.edu.cu) 
 * @version 1.0
 * @since JDK1.6
 * </p>
 */

import java.util.*;


public class AssociationRule {
  /**
   * <p>
   * It is used for representing and handling an Association Rule.
   * It mainly wraps the methods of a chromosome to offer high-level features later
   * </p>
   */
	
  private Chromosome chr;
  
  /**
   * <p>
   * It creates a new association rule by setting up the chromosome which is based on
   * </p>
   * @param chr The chromosome which this association rule is based on
   */
  public AssociationRule(Chromosome chr) {
	  this.chr = chr;
  }

  /**
   * <p>
   * It allows to clone correctly an association rule
   * </p>
   * @return A copy of the association rule
   */
  public AssociationRule copy() {
	AssociationRule rule = new AssociationRule(this.chr);
	
	return rule;
  }
  
  /**
   * <p>
   * It retrieves the antecedent part of an association rule
   * </p>
   * @return An array of genes only representing antecedent attributes
   */
  public Gene[] getAntecedents() {
	int i, g;
	ArrayList<Integer> indexes;
	Gene[] ants;
	
	indexes = this.chr.getIndexOfAntecedentGenes();
	ants = new Gene[ indexes.size() ];
	
	for (i=0; i < indexes.size(); i++) {
		g = indexes.get(i);
		ants[i] = this.chr.getGene(g);
	}
	  
	return ants;
  }
  
  /**
   * <p>
   * It retrieves the consequent part of an association rule
   * </p>
   * @return An array of genes only representing consequent attributes
   */
  public Gene[] getConsequents() {
	int i, g;
	ArrayList<Integer> indexes;
	Gene[] cons;
	
	indexes = this.chr.getIndexOfConsequentGenes();
	cons = new Gene[ indexes.size() ];
	
	for (i=0; i < indexes.size(); i++) {
		g = indexes.get(i);
		cons[i] = this.chr.getGene(g);
	}	
	  
	return cons;
  }
  
  /**
   * <p>
   * It indicates the attributes which act as antecedents within an association rule
   * </p>
   * @return An array of IDs for the attributes acting as antecedents
   */
  public ArrayList<Integer> getIdOfAntecedents() {
	return ( this.chr.getIndexOfAntecedentGenes() );
  }
  
  /**
   * <p>
   * It indicates the attributes which act as consequents within an association rule
   * </p>
   * @return An array of IDs for the attributes acting as consequents
   */
  public ArrayList<Integer> getIdOfConsequents() {
	return ( this.chr.getIndexOfConsequentGenes() );
  }
  
  /**
   * <p>
   * It indicates the dataset records which have been covered by an association rule
   * </p>
   * @return An array of IDs representing the covered records in the dataset
   */
  public ArrayList<Integer> getCoveredTIDs() {
	return ( this.chr.getCoveredTIDs() );
  }
  
  /**
   * <p>
   * It returns the support of an association rule
   * </p>
   * @return A value representing the support of the association rule
   */
  public double getSupport() {
	return ( this.chr.getRuleSupport() );
  }

  /**
   * <p>
   * It returns the confidence of an association rule
   * </p>
   * @return A value representing the confidence of the association rule
   */
  public double getConfidence() {
	return ( this.chr.getRuleConfidence() );
  }
  
  public double getAntecedentSupport(){
		return ( this.chr.getAntecedentSupport() ); 
  }
  
  public double getConsequentSupport(){
	  return ( this.chr.getConsequentSupport() ); 
  }
  
  
  
  /**
   * <p>
   * It returns the lift of an association rule
   * </p>
   * @return A value representing the lift of the association rule
   */
  public double getLift() {
	return ( this.chr.getRuleLift() );
  }
  /**
   * <p>
   * It returns the conviction of an association rule
   * </p>
   * @return A value representing the conviction of the association rule
   */
  public double getConv() {
	return ( this.chr.getRuleConv() );
  }
  /**
   * <p>
   * It returns the certain factor of an association rule
   * </p>
   * @return A value representing the certain factor of the association rule
   */
  public double getCF() {
	return ( this.chr.getRuleCF());
  }
  
  /**
   * <p>
   * It returns the Netconf of an association rule
   * </p>
   * @return A value representing the netConf of the association rule
   */
  public double getnetConf() {
	return ( this.chr.getRuleNetconf());
  }
  
  public double getyulesQ() {
		return ( this.chr.getRuleYulesQ());
	  }
  
  /**
   * <p>
   * It returns a raw string representation of an association rule
   * </p>
   * @return A raw string representation of the association rule
   */  
  public String toString() {
	return ( this.chr.toString() );
  }
  
}