hierarchicalclusteringsettings.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 Michael Thess
 * @version 1.1
 */

package com.prudsys.pdm.Models.Clustering.Hierarchical;

import com.prudsys.pdm.Core.MiningModel;
import com.prudsys.pdm.Models.Clustering.ClusteringSettings;

/**
 * Settings for hierarchical clustering.
 */
public class HierarchicalClusteringSettings extends ClusteringSettings
{
    // -----------------------------------------------------------------------
    //  Constructor
    // -----------------------------------------------------------------------
    /**
     * Empty constructor.
     */
    public HierarchicalClusteringSettings()
    {
        this.setFunction( MiningModel.CLUSTERING_FUNCTION );
        this.setDistance( new ClusterDistance() );
    }

    // -----------------------------------------------------------------------
    //  Verify settings
    // -----------------------------------------------------------------------
    /**
     * Verify settings. Call super class method (of ClusteringSettings) for
     * verifying settings and it checks if distance is instance of
     * ClusterDistance class. If settings are incomplete an illegal argument
     * exception is thrown.
     *
     * @exception IllegalArgumentException exception that is thrown for incomplete settings
     */
    public void verifySettings() throws IllegalArgumentException
    {
        super.verifySettings();
        if (! (getDistance() instanceof ClusterDistance) )
          throw new IllegalArgumentException("distance must be instance of ClusterDistance class");
    }

    // -----------------------------------------------------------------------
    //  Export methods
    // -----------------------------------------------------------------------
    /**
     * Returns string representation of clustering settings.
     *
     * @return string representation of clustering settings
     */
    public String toString()
    {
        return "Hierarchical Clustering";
    }

    /**
     * Returns HTML string representation of clustering settings.
     *
     * @return HTML string representation of clustering settings
     */
    public String toHtmlString()
    {
        String description = "Model type:<br>Hierarchical Clustering<br>";
        return description;
    }
}