readingendmessage.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.Core.Event.Status;

import java.lang.String;
import com.prudsys.pdm.Core.Event.AlgorithmStatusMessage;

/**
 * Object used as description in MiningEvent.
 * This message object is created by the algorithms to give the status report that reading of data is finished.
 *
 * @author Toni Volkmer
 */
public class ReadingEndMessage extends AlgorithmStatusMessage {
  /**
   * Number of rows that were read.
   */
  protected int rowsNumber;

  /**
   * Default constructor for level 0.
   * 
   * @param nRows number of rows
   */
  public ReadingEndMessage(int nRows) {
    this(nRows, 0);
  }
  
  /**
   * Constructor setting appropriate message description.
   *
   * @param nRows number of rows 
   * @param level number of parent algorithms
   */
  public ReadingEndMessage(int nRows, int level) {
    super(MESSAGE_READING_END, level, "");
    
    this.rowsNumber = nRows;
    
    if(level > 0)
      description = getDescription("LocalReadingFinished", new Object[]{new Integer(nRows)});    
    else
      description = getDescription("ReadingFinished", new Object[]{new Integer(nRows)});    
  }

  /**
   * Constructor.
   * 
   * @param nRows number of rows
   * @param level number of parent algorithms
   * @param msg message description
   */
  public ReadingEndMessage(int nRows, int level, String msg) {
    super(MESSAGE_READING_END, level, msg);
    
    this.rowsNumber = nRows;
  }
  
  /**
   * Constructor.
   * 
   * @param nRows number of rows
   * @param level number parent algorithms
   * @param key key value in resources
   * @param params parameter for resources, may be null
   */
  public ReadingEndMessage(int nRows, int level, String key, Object[] param) {
    super(MESSAGE_READING_END, level, key, param);
    
    this.rowsNumber = nRows;
  }

  /**
   * Returns the number of rows that were read.
   * @return number of rows
   */
  public int getNumberOfRows() {
    return rowsNumber;
  }
}