groupingparameter.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 Victor Borichev
 * @version 1.0
 */

package com.prudsys.pdm.Models.Statistics;

/**
  * Definition of a grouping parameter.
  *
  * Contains the three attributes
  * attribute (number of grouping attribute),
  * maxGroups (maximum number of groups of attribute),
  * ordering (no ordering, increasing, decreasing).
  */
public class GroupingParameter {

  public final static int NO_ORDERING = 0;
  public final static int INCREASING = 1;
  public final static int DECREASING = 2;
  private int attribute;
  private int maxGroups;
  private int ordering;

  /**
   * Constructor with default values
   * attribute = -1, maxGroups = -1, ordering = NO_ORDER.
   */
  public GroupingParameter() {
    attribute = -1;
    maxGroups = -1;
    ordering = NO_ORDERING;
  }

  /**
   * Constructor with all parameters.
   *
   * @param attribute index of grouping attribute (0, ..., #attributes)
   * @param maxGroups maximum number of groups (-1: unbounded)
   * @param ordering ordering of group elements (NO_ORDER, INCREASING, DECREASING)
   */
  public GroupingParameter(int attribute, int maxGroups, int ordering) {

    this.attribute = attribute;
    this.maxGroups = maxGroups;
    this.ordering = ordering;
  }

  /**
   * Get attribute index.
   *
   * @return attribute index
   */
  public int getAttribute() {
    return attribute;
  }

  /**
   * Set attribute index.
   *
   * @param attribute attribute index
   */
  public void setAttribute(int attribute) {
    this.attribute = attribute;
  }

  /**
   * Get maximum number of groups.
   *
   * @return maximum number of groups
   */
  public int getMaxGroups() {
    return maxGroups;
  }

  /**
   * Set maximum number of groups.
   *
   * @param maxGroups maximum number of groups
   */
  public void setMaxGroups(int maxGroups) {
    this.maxGroups = maxGroups;
  }

  /**
   * Get ordering of group elements.
   *
   * @return ordering
   */
  public int getOrdering() {
    return ordering;
  }

  /**
   * Set ordering of group elements.
   *
   * @param ordering ordering
   */
  public void setOrdering(int ordering) {
    this.ordering = ordering;
  }
}