orderattribute.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.2
  */

package com.prudsys.pdm.Input.Multidimensional;


 /**
 * Class representing SQL-like ordering criteria for one attribute.
 */
public class OrderAttribute extends com.prudsys.pdm.Cwm.Core.Attribute
{
  // -----------------------------------------------------------------------
  //  Constants of ordering types
  // -----------------------------------------------------------------------
  /** Ordering by increasing values. */
  public static final int UP = 0;

  /** Ordering by decreasing values. */
  public static final int DOWN = 1;

  // -----------------------------------------------------------------------
  //  Variables declarations
  // -----------------------------------------------------------------------
  /** Ordering type. */
  private int orderType = UP;

  // -----------------------------------------------------------------------
  //  Constructor
  // -----------------------------------------------------------------------
  /**
   * Empty constructor.
   */
  public OrderAttribute() {
  }

  /**
   * Constructor with given attribute name and type.
   *
   * @param name name of ordering attribute
   * @param orderType type of ordering attribute
   */
  public OrderAttribute(String name, int orderType) {

    this.setName(name);
    this.orderType = orderType;
  }

  // -----------------------------------------------------------------------
  //  Getter and setter methods
  // -----------------------------------------------------------------------
  /**
   * Returns type of ordering (up, down).
   *
   * @return type of ordering
   */
  public int getOrderType()
  {
    return orderType;
  }

  /**
   * Sets type of ordering (up, down).
   *
   * @param orderType newtype of ordering
   */
  public void setOrderType(int orderType)
  {
    this.orderType = orderType;
  }

  // -----------------------------------------------------------------------
  //  java.lang.Object methods
  // -----------------------------------------------------------------------
  /**
   * Find out if two order attributes are equal.
   * They must have the same name and the same type.
   *
   * @param obj the order attribute to compare with
   * @return true if equal, otherwise false
  */
  public boolean equals(Object obj)
  {
      OrderAttribute oa = (OrderAttribute) obj;

      if ( !this.getName().equals( oa.getName() ) )
        return false;   // different names

      if ( this.type != oa.getType() )
        return false;   // different types

      return true;
  }

}