Item.java

/***********************************************************************

	This file is part of KEEL-software, the Data Mining tool for regression, 
	classification, clustering, pattern mining and so on.

	Copyright (C) 2004-2010
	
	F. Herrera (herrera@decsai.ugr.es)
    L. S�nchez (luciano@uniovi.es)
    J. Alcal�-Fdez (jalcala@decsai.ugr.es)
    S. Garc�a (sglopez@ujaen.es)
    A. Fern�ndez (alberto.fernandez@ujaen.es)
    J. Luengo (julianlm@decsai.ugr.es)

	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 3 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, see http://www.gnu.org/licenses/
  
**********************************************************************/

package keel.Algorithms.Associative_Classification.ClassifierFuzzyCFAR;

import java.util.*;

/**
 * This class contains the representation of a item
 *
 * @author Jesus Alcal� (University of Granada) 09/02/2010
 * @version 1.0
 * @since JDK1.5
 */
public class Item implements Comparable {
  int variable, value;

  /**
   * <p>
   * Default Constructor
   * </p>
   */
  public Item() {
  }


  /**
   * <p>
   * Parameters Constructor
   * </p>
   * @param variable Value which represents an input attribute of a rule
   * @param value Value attached to the variable
   */
  public Item(int variable, int value) {
	  this.variable = variable;
	  this.value = value;
  }


  /**
   * <p>
   * It sets the pair of values to the item
   * </p>
   * @param variable Value which represents an input attribute of a rule
   * @param value Value attached to the variable
   */
  public void setValues (int variable, int value) {
	  this.variable = variable;
	  this.value = value;
  }


  /**
   * <p>
   * It returns the variable of the item
   * </p>
   * @return Input attribute
   */
  public int getVariable () {
	  return (this.variable);
  }


  /**
   * <p>
   * It returns the value of the item
   * </p>
   * @return Value of the item
   */
  public int getValue () {
	  return (this.value);
  }


  /**
   * <p>
   * Clone function
   * </p>
   */
  public Item clone(){
    Item d = new Item();
    d.variable = this.variable;
    d.value = this.value;

	return d;
  }


  /**
   * <p>
   * Function to check if an item is equal to another given
   * </p>
   * @param a Item to compare with ours
   * @return boolean true = they are equal, false = they aren't.
   */
  public boolean isEqual(Item a) {
	  if ((this.variable == a.variable) && (this.value == a.value))  return (true);
	  else  return (false);
  }


  /**
   * Function to compare objects of the Item class
   * Necessary to be able to use "sort" function
   * It sorts in an decreasing order of attribute
   * If equals, in an decreasing order of attribute's value
   */
  public int compareTo(Object a) {
    if (((Item) a).variable > this.variable) {
      return -1;
    }
    else if (((Item) a).variable < this.variable) {
      return 1;
    }
    else if (((Item) a).value > this.value) {
      return -1;
    }
    else if (((Item) a).value < this.value) {
      return 1;
    }

    return 0;
  }

}