miningeventmessage.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;

import java.text.DateFormat;
import java.util.Date;

/**
 * Object used as description in MiningEvent. 
 *
 * @author Toni Volkmer
 *
 */
public class MiningEventMessage {

  /**
   * Contains the time of calling the constructor. 
   */
  public Date creationTime;
  
  /**
   * Contains a description as String representation.
   */
  protected String description;

  /**
   * Default constructor creating empty description.
   *
   */
  public MiningEventMessage() {
  	this(null);
  }
  
  /**
   * Constructor with description.
   * @param msg description for message as String representation.
   */
  public MiningEventMessage(String msg) {
  	if(msg==null)
  	  msg = "";

  	this.description = msg;
  	creationTime = new Date();
  }

  /**
   * Returns the time this instance was created.
   * @return creation time
   */
  public Date getMessageCreationTime() {
    return creationTime;
  }
  
  /**
   * Returns description of this event message.
   * @return description as String representation, empty String if none is available
   */
  public String getDescription() {
    return description;
  }

  /**
   * Returns creationTime and description combined in one String.
   */
  public String toString() {
    return DateFormat.getDateTimeInstance().format(creationTime) + ": " + description;
  }
}