miningautomationassignment.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 Valentine Stepanenko ([e-mail])
  * @author Michael Thess
  * @version 1.0
  */
package com.prudsys.pdm.Automat;

import com.prudsys.pdm.Core.MiningAlgorithm;

/**
 * Mining automation means to build mining models by iteratively
 * evaluating these models (MiningModelAssessment),
 * changing their parameters (MiningAutomationCallback), and restarting
 * the mining algorithm again (MiningAlgorithm).
 * This class binds them all together and defines the target
 * values of the automation.
 *
 * The target values minAssesment and maxAssesment define
 * an interval [minAssesment, maxAssesment] for the mining
 * model evaluation result calculated by the method calculateAssessment
 * of the class MiningModelAssessment. The iteration continues
 * until the target value is in this interval or a given maximum number
 * of iterations is reached.
 *
 * @see MiningAlgorithm
 * @see MiningModelAssessment
 * @see MiningAutomationCallback
 */
public class MiningAutomationAssignment extends com.prudsys.pdm.Cwm.Core.Class
{
    // -----------------------------------------------------------------------
    //  Variables declarations
    // -----------------------------------------------------------------------
    /** Reference to assessment object. */
    private MiningModelAssessment miningModelAssessment;

    /** Reference to callback object. */
    private MiningAutomationCallback miningAutomationCallback;

    /** Minimum assessment value. */
    private double minAssessment;

    /** Maximum assessment value. */
    private double maxAssessment;

    /** Maximum number of iterations. */
    private int maxIterationNumber = 20;

    // -----------------------------------------------------------------------
    //  Constructor
    // -----------------------------------------------------------------------
    /**
     * Empty constructor.
     */
    public MiningAutomationAssignment() {

    }

    // -----------------------------------------------------------------------
    //  Getter and setter methods
    // -----------------------------------------------------------------------
    /**
     * Returns mining model assessment object.
     *
     * @return mining model assessment object
     */
    public MiningModelAssessment getMiningModelAssessment()
    {
        return miningModelAssessment;
    }

    /**
     * Sets mining model assessment object.
     *
     * @param miningModelAssessment new mining model assessment object
     */
    public void setMiningModelAssessment(MiningModelAssessment miningModelAssessment)
    {
        this.miningModelAssessment = miningModelAssessment;
        this.miningModelAssessment.setMiningAutomationAssignment(this);
    }

    /**
     * Returns mining automation callback object.
     *
     * @return mining automation callback object
     */
    public MiningAutomationCallback getMiningAutomationCallback()
    {
        return miningAutomationCallback;
    }

    /**
     * Sets mining automation callback object.
     *
     * @param miningAutomationCallback new mining automation callback object
     */
    public void setMiningAutomationCallback(MiningAutomationCallback miningAutomationCallback)
    {
        this.miningAutomationCallback = miningAutomationCallback;
        this.miningAutomationCallback.setMiningAutomationAssignment(this);
    }

    /**
     * Returns minimum assessment value, i.e. the lower bound for
     * the minimum assessment.
     *
     * @return minimum assessment bound, Double.NEGATIVE_INFINITY if unbounded
     */
    public double getMinAssessment()
    {
        return minAssessment;
    }

    /**
     * Sets minimum assessment value, i.e. the lower bound for
     * the minimum assessment.
     *
     * @param minAssessment new minimum assessment bound, Double.NEGATIVE_INFINITY if unbounded
     */
    public void setMinAssessment(double minAssessment)
    {
        this.minAssessment = minAssessment;
    }

    /**
     * Returns maximum assessment value, i.e. the upper bound for
     * the maximum assessment.
     *
     * @return maximum assessment bound, Double.POSITIVE_INFINITY if unbounded
     */
    public double getMaxAssessment()
    {
        return maxAssessment;
    }

    /**
     * Sets maximum assessment value, i.e. the upper bound for
     * the maximum assessment.
     *
     * @param maxAssessment new maximum assessment bound, Double.POSITIVE_INFINITY if unbounded
     */
    public void setMaxAssessment(double maxAssessment)
    {
        this.maxAssessment = maxAssessment;
    }

    /**
     * Returns maximum iteration number of the automation process.
     *
     * @return maximum iteration number, -1 if unbounded
     */
    public int getMaxIterationNumber()
    {
      return maxIterationNumber;
    }

    /**
     * Sets maximum iteration number of the automation process.
     *
     * @param maxIterationNumber new maximum iteration number, -1 if unbounded
     */
    public void setMaxIterationNumber(int maxIterationNumber)
    {
      this.maxIterationNumber = maxIterationNumber;
    }
}