rulesnumberassessment.java

一个数据挖掘软件ALPHAMINERR的整个过程的JAVA版源代码

/*
 *    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 2 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, write to the Free Software
 *    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

 /**
  * Title: XELOPES Data Mining Library
  * Description: The XELOPES library is an open platform-independent and data-source-independent library for Embedded Data Mining.
  * Copyright: Copyright (c) 2002 Prudential Systems Software GmbH
  * Company: ZSoft (www.zsoft.ru), Prudsys (www.prudsys.com)
  * @author Michael Thess
  * @version 1.1
  */
package com.prudsys.pdm.Models.AssociationRules;

import com.prudsys.pdm.Automat.IntrospectiveModelAssessment;
import com.prudsys.pdm.Core.MiningException;

/**
 * Calculates association rule model assessment which is simply the
 * number of association rules.
 */
public class RulesNumberAssessment extends IntrospectiveModelAssessment
{
  // -----------------------------------------------------------------------
  //  Variables declarations
  // -----------------------------------------------------------------------
  /** Assessment type (0 - number of rules, 1 - number of large itemsets). */
  private int ruleType = 0;

  // -----------------------------------------------------------------------
  //  Constructor
  // -----------------------------------------------------------------------
  /**
   * Empty constructor.
   */
  public RulesNumberAssessment()
  {
  }

  // -----------------------------------------------------------------------
  //  Getter and setter methods
  // -----------------------------------------------------------------------
  /**
   * Returns rule type (0 - number of rules, 1 - number of large itemsets).
   *
   * @return rule type
   */
  public int getRuleType()
  {
    return ruleType;
  }

  /**
   * Sets rule type (0 - number of rules, 1 - number of large itemsets).
   *
   * @param ruleType new rule type
   */
  public void setRuleType(int ruleType)
  {
    this.ruleType = ruleType;
  }

  // -----------------------------------------------------------------------
  //  Assessment value calculation
  // -----------------------------------------------------------------------
  /**
   * Calculate assessment value for current model.
   * This is simply the number of association rules.
   *
   * @return number of association rules
   * @exception MiningException if assessment could not be calculated
   */
  public double calculateAssessment() throws MiningException {

      if (miningModel == null)
        throw new MiningException("No mining model defined");

      if (! (miningModel instanceof AssociationRulesMiningModel) )
        throw new MiningException("Mining model no instance of AssociationRulesMiningModel");

      int numRule = 0;
      if (ruleType == 0)
        numRule = ((AssociationRulesMiningModel) miningModel).getAssociationRules().size();
      else if (ruleType == 1)
        numRule = ((AssociationRulesMiningModel) miningModel).getLargeItemSets().size();

      return numRule;
  }
}