rulesminingmodel.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
 * @author Rolf Rossius
 * @version 1.2
 */

package com.prudsys.pdm.Models.Classification.Rules;

import java.io.Reader;
import java.io.Writer;

import com.prudsys.pdm.Core.MiningException;
import com.prudsys.pdm.Core.MiningModel;
import com.prudsys.pdm.Models.Classification.ClassificationMiningModel;

/**
  * Description of a classification rules model.
  * The classifier must be of the type RulesList. <p>
  *
  * From PDM CWM extension. <p>
  *
  * Superclasses:
  * <ul>
  *   <li> ClassificationMiningModel
  * </ul>
  *
  * @see MiningModel
  */
public class RulesMiningModel extends ClassificationMiningModel
{
    // -----------------------------------------------------------------------
    //  Constructor
    // -----------------------------------------------------------------------
    /**
     * Constructor sets function and algorithm parameters.
     */
    public RulesMiningModel()
    {
        function  = MiningModel.CLASSIFICATION_FUNCTION;
        algorithm = MiningModel.RULE_BASED_CLASSIFICATION_ALGORITHM;
    }

    // -----------------------------------------------------------------------
    //  Methods of PMML handling
    // -----------------------------------------------------------------------
    /**
     * Creates PMML document of rules model.
     * PMMLs new RuleModel will be used. Not implemented.
     *
     * @param writer writer for PMML model
     * @exception MiningException cannot write PMML model, always thrown
     */
    public void writePmml( Writer writer ) throws MiningException
    {
      throw new MiningException("still not implemented");
    }

    /**
     * Reads PMML document of rules model.
     * PMMLs new RuleModel will be used. Not implemented.
     *
     * @param reader reader for PMML model
     * @exception MiningException cannot read PMML model, always thrown
     */
    public void readPmml( Reader reader ) throws MiningException
    {
      throw new MiningException("still not implemented");
    }

    /**
     * Creates new PMML element RuleModel. Not implemented.
     *
     * @return PMML object RuleModel
     * @exception MiningException cannot write PMML object, always thrown
     */
    public Object createPmmlObject() throws MiningException
    {
      throw new MiningException("still not implemented");
    }

    /**
     * Reads new PMML element RuleModel element. Not implemented.
     *
     * @param pmml object of RuleModel type
     * @exception MiningException cannot write PMML object, always thrown
     */
    public void parsePmmlObject(Object pmml) throws MiningException
    {
       throw new MiningException("still not implemented");
    }

    /**
     * Writes tree model as plain text. Not supported.
     *
     * @param writer writer for plain text model
     * @exception MiningException always thrown
     */
    public void writePlainText( Writer writer ) throws MiningException
    {
      throw new MiningException( "not supported" );
    }

    /**
     * Returns string representation (just few words).
     *
     * @return string representation
     */
    public String toString()
    {
        return "Classification rules mining model";
    }
}