supervisedminingalgorithm.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.Models.Supervised;

import com.prudsys.pdm.Core.MiningAlgorithm;
import com.prudsys.pdm.Core.MiningAttribute;
import com.prudsys.pdm.Core.MiningException;
import com.prudsys.pdm.Core.MiningModel;
import com.prudsys.pdm.Core.MiningSettings;

/**
 * Base class for supervised mining algorithms.
 */
public abstract class SupervisedMiningAlgorithm extends MiningAlgorithm
{
    // -----------------------------------------------------------------------
    //  Variables declarations
    // -----------------------------------------------------------------------
    /** Target attribute. */
    protected MiningAttribute target;

    /** Name of confidence attribute. */
    protected String confidenceAttributeName;

    /** Name of predicted attribute. */
    protected String predictedAttributeName;

    /** Name of cost function. */
    protected String costFunction;

    // -----------------------------------------------------------------------
    //  Constructor
    // -----------------------------------------------------------------------
    /**
     * Empty constructor.
     */
    public SupervisedMiningAlgorithm()
    {
    }

    // -----------------------------------------------------------------------
    //  Getter and setter methods
    // -----------------------------------------------------------------------
    /**
     * Creates an instance of the supervised mining settings class that is required
     * to run the algorithm. The mining settings are assigned through the
     * setMiningSettings method.
     *
     * @return new instance of the supervised mining settings class of the algorithm
     */
    public MiningSettings createMiningSettings() {

      return new SupervisedMiningSettings();
    }

    /**
     * Sets supervised mining settings.
     *
     * @param miningSettings new supervised mining settings
     * @exception IllegalArgumentException mining settings not supervised mining settings
     */
    public void setMiningSettings( MiningSettings miningSettings ) throws IllegalArgumentException
    {
        if( miningSettings instanceof SupervisedMiningSettings )
        {
            super.setMiningSettings( miningSettings );
            SupervisedMiningSettings supervisedMiningSettings = (SupervisedMiningSettings)miningSettings;
            this.target = supervisedMiningSettings.getTarget();
            this.confidenceAttributeName = supervisedMiningSettings.getConfidenceAttributeName();
            this.predictedAttributeName = supervisedMiningSettings.getPredictedAttributeName();
            this.costFunction = supervisedMiningSettings.getCostFunction();
        }
        else
        {
            throw new IllegalArgumentException( "MiningSettings have to be a SupervisedMiningSettings." );
        }
    }

    /**
     * Returns classifier object.
     *
     * @return classifier object
     */
    protected abstract Classifier getClassifier();

    // -----------------------------------------------------------------------
    //  Run supervised mining algorithm and build mining model
    // -----------------------------------------------------------------------
    /**
     * Runs supervised mining algorithm.
     *
     * @exception MiningException could not run algorithm
     */
    protected abstract void runAlgorithm() throws MiningException;

    /**
     * Builds mining model by running the supervised algorithm internally.
     * (I.e. the runAlgorithm method is usally applied internally.)
     *
     * @return supervised mining model generated by the algorithm
     * @exception MiningException could not build model
     */
    public abstract MiningModel buildModel() throws MiningException;

}