clusteringsettings.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.Clustering;

import com.prudsys.pdm.Core.MiningModel;
import com.prudsys.pdm.Core.MiningSettings;

/**
  * Parameters for computing a clustering model partitioning the
  * input records into segments. <p>
  *
  * From CWM Data Mining. <p>
  *
  * Superclasses:
  * <ul>
  *   <li> MiningSettings
  * </ul>
  * Attributes:
  * <ul>
  *   <li> <i>maxNumberOfClusters</i>: Upper limit for the number of computed clusters. <br>
  *     - type: Integer <br>
  *     - multiplicity: exactly one
  *   <li> <i>clusterIdAttributeName</i>: Attribute name for output of cluster id values. <br>
  *     - type: String <br>
  *     - multiplicity: exactly one
  *   <li> <i>distance</i>: Distance measure between two vectors. <br>
  *     - type: Distance <br>
  *     - multiplicity: exactly one
  * </ul>
  * Constraints:
  * <ul>
  *   <li> Function must specify "Clustering". maxNumberOfClusters must be
  *   positive.
  * </ul>
  */
public class ClusteringSettings extends MiningSettings
{
    // -----------------------------------------------------------------------
    //  Variables declarations
    // -----------------------------------------------------------------------
    /**
     * Upper limit for the number of computed clusters.
     */
    private int maxNumberOfClusters;

    /**
     * Attribute name for output of cluster id values.
     */
    private String clusterIdAttributeName = "";

    /**
     * Distance between vectors to be clustered, also refered to as
     * comparison measure (PMML) or aggregation function (JDM).
     */
    private Distance distance = new Distance();

    // -----------------------------------------------------------------------
    //  Constructor
    // -----------------------------------------------------------------------
    /**
     * Empty constructor
     */
    public ClusteringSettings()
    {
        this.setFunction( MiningModel.CLUSTERING_FUNCTION );
    }

    // -----------------------------------------------------------------------
    //  Getter and setter methods
    // -----------------------------------------------------------------------
    /**
     * Returns name of cluster id attribute.
     *
     * @return name of cluster id attribute
     */
    public String getClusterIdAttributeName()
    {
        return clusterIdAttributeName;
    }

    /**
     * Sets name of cluster id attribute.
     *
     * @param clusterIdAttributeName name of cluster id attribute
     */
    public void setClusterIdAttributeName(String clusterIdAttributeName)
    {
        this.clusterIdAttributeName = clusterIdAttributeName;
    }

    /**
     * Returns the maximum number of clusters allowed.
     *
     * @return maximum number of clusters
     */
    public int getMaxNumberOfClusters()
    {
        return maxNumberOfClusters;
    }

    /**
     * Sets the maximum number of clusters allowed.
     *
     * @param maxNumberOfClusters maximum number of clusters
     */
    public void setMaxNumberOfClusters(int maxNumberOfClusters)
    {
        this.maxNumberOfClusters = maxNumberOfClusters;
    }

    /**
     * Set distances definition. Distance between vectors is also
     * refered to as comparison measure (PMML) or aggregation function (JDM).
     *
     * @param distance new distances
     */
    public void setDistance(Distance distance)
    {
      this.distance = distance;
    }

   /**
    * Returns distances definition. Distance between vectors is also
    * refered to as comparison measure (PMML) or aggregation function (JDM).
    *
    * @return distances
    */
    public Distance getDistance()
    {
      return distance;
    }

    // -----------------------------------------------------------------------
    //  Verify settings
    // -----------------------------------------------------------------------
    /**
     * Verify clustering settings. First, verify method of super class
     * MiningSettings is called. Then it is checked, that the
     * clusterIdAttributeName and distance are not null.
     *
     * @exception IllegalArgumentException thrown if wrong arguments
     */
    public void verifySettings() throws IllegalArgumentException
    {
        super.verifySettings();
        if( clusterIdAttributeName == null )
        {
            throw new IllegalArgumentException( "Attribute clusterIdAttributeName can't be null." );
        };
        if( distance == null )
        {
            throw new IllegalArgumentException( "Attribute distance can't be null." );
        };
    }

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

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

}