creationmodelendmessageassociationrules.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-2004 prudsys AG
  * Company: ZSoft (www.zsoft.ru), Prudsys (www.prudsys.com)
  * @author Toni Volkmer
  * @version 1.0
  */

package com.prudsys.pdm.Models.AssociationRules.Event;

import java.lang.String;

import com.prudsys.pdm.Core.Event.Status.CreationModelEndMessage;

/**
 * Object used as description in MiningEvent.
 * This message object is created by the algorithms to give the status report that association rules model creation is finished.
 *
 * @author Toni Volkmer
 */
public class CreationModelEndMessageAssociationRules extends CreationModelEndMessage {
  /**
   * Number of large item sets found.
   */
  protected int nLITS;
  
  /**
   * Number of association rules found.
   */
  protected int nRules;

  /**
   * Default constructor for level 0 setting appropriate message description.
   * 
   * @param rules number of association rules
   * @param lits number of large item sets
   */
  public CreationModelEndMessageAssociationRules(int rules, int lits) {
    this(rules, lits, 0);
  }

  /**
   * Constructor setting appropriate message description.
   * 
   * @param rules number of association rules
   * @param lits number of large item sets
   * @param level number of parent algorithms
   */
  public CreationModelEndMessageAssociationRules(int rules, int lits, int level) {
    this(rules, lits, level, "");
    
    if(level > 0)
      description = getDescription("LocalAssociationRulesModelCreated", new Object[]{new Integer(rules), new Integer(lits)});
    else
      description = getDescription("AssociationRulesModelCreated", new Object[]{new Integer(rules), new Integer(lits)});
  }

  /**
   * Constructor.
   * 
   * @param rules number of association rules
   * @param lits number of large item sets
   * @param level number of parent algorithms
   * @param msg message description
   */
  public CreationModelEndMessageAssociationRules(int rules, int lits, int level, String msg) {
    super(level, msg);
    
    this.nRules = rules;
    this.nLITS = lits;
  }
  
  /**
   * Constructor.
   * 
   * @param rules number of association rules
   * @param lits number of large item sets
   * @param level number of parent algorithms
   * @param key key value in resources
   * @param params parameter for resources, may be null
   */
  public CreationModelEndMessageAssociationRules(int rules, int lits, int level, String key, Object[] params) {
    super(level, key, params);
    
    this.nRules = rules;
    this.nLITS = lits;
  }

  /**
   * Returns number of large item sets found.
   * @return number of large item sets
   */
  public int getNumberOfLargeItemSets() {
    return nLITS;
  }

  /**
   * Returns number of association rules found.
   * @return number of rules
   */
  public int getNumberOfRules() {
    return nRules;
  }
}