miningmodelassessment.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])
  * @version 1.0
  */

package com.prudsys.pdm.Automat;

import com.prudsys.pdm.Core.MiningException;
import com.prudsys.pdm.Core.MiningModel;
import com.prudsys.pdm.Core.MiningModelResult;

/**
 * Class for the assessment of a mining model.
 * The result is always a double value which can also be
 * infinite. <p>
 *
 * The class may contain child nodes of the same class
 * which calculate their own assessments which are then
 * used by this class. In this way, a tree structure
 * of such nodes can be defined.
 *
 * @see MiningAutomationCallback
 * @see MiningAutomationAssignment
 */
public abstract class MiningModelAssessment extends MiningModelResult
{
    // -----------------------------------------------------------------------
    //  Variables declarations
    // -----------------------------------------------------------------------
    /** Mining automation assignment object. */
    protected MiningAutomationAssignment miningAutomationAssignment;

    /** Mining model to be assessed. */
    protected MiningModel miningModel;

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

    }

    // -----------------------------------------------------------------------
    //  Getter and setter methods
    // -----------------------------------------------------------------------
    /**
     * Constructs MiningModelAssessment for a given mining model.
     *
     * @param miningModel mining model to be evaluated
     */
    public MiningModelAssessment( MiningModel miningModel )
    {
        this.miningModel = miningModel;
    }

    /**
     * Returns object of automation assignment.
     *
     * @return object of automation assignment
     */
    public MiningAutomationAssignment getMiningAutomationAssignment()
    {
      return miningAutomationAssignment;
    }

    /**
     * Sets object of automation assignment.
     *
     * @param miningAutomationAssignment new object of automation assignment
     */
    public void setMiningAutomationAssignment(MiningAutomationAssignment miningAutomationAssignment)
    {
      this.miningAutomationAssignment = miningAutomationAssignment;
    }

    /**
     * Returns mining model to be assessed.
     *
     * @return mining model to be assessed
     */
    public MiningModel getMiningModel()
    {
        return miningModel;
    }

    /**
     * Sets new mining model.
     *
     * @param miningModel new mining model to be assessed
     */
    public void setMiningModel(MiningModel miningModel)
    {
        this.miningModel = miningModel;
    }

    // -----------------------------------------------------------------------
    //  Assessment value calculation
    // -----------------------------------------------------------------------
    /**
     * Calculate assessment value for current model.
     *
     * @return assessment value
     * @exception MiningException if assessment could not be calculated
     */
    public abstract double calculateAssessment() throws MiningException;

}