partitioningclusteringsettings.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.0
 */

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

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

/**
 * Settings for partitioning clustering.
 */
public class PartitioningClusteringSettings extends ClusteringSettings
{
  // -----------------------------------------------------------------------
  //  Variables declarations
  // -----------------------------------------------------------------------
  /** Linkage value. */
  private int linkage = 1;

  /** Threshold for connecting clusters. */
  private double threshold = 0.1;

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

  // -----------------------------------------------------------------------
  //  Getter and setter methods
  // -----------------------------------------------------------------------
  /**
   * Returns value of linkage.
   *
   * @return value of linkage
   */
  public int getLinkage()
  {
    return linkage;
  }

  /**
   * Sets new value of linkage.
   *
   * @param linkage new linkage value
   */
  public void setLinkage(int linkage)
  {
    this.linkage = linkage;
  }

  /**
   * Returns value of threshold.
   *
   * @return threshold value
   */
  public double getThreshold()
  {
    return threshold;
  }

  /**
   * Sets new threshold value.
   *
   * @param threshold new threshold value
   */
  public void setThreshold(double threshold)
  {
    this.threshold = threshold;
  }

  // -----------------------------------------------------------------------
  //  Verify settings
  // -----------------------------------------------------------------------
  /**
   * Verify settings. Call super class method (of ClusteringSettings) for
   * verifying settings and it checks if linkage and threshold are
   * admissible. 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 (linkage < 1)
        throw new IllegalArgumentException("linkage must be greater than zero");
      if (threshold <= 0.0)
        throw new IllegalArgumentException("threshold must be positive");
  }

}