Attribute.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.Rule_Learning.ART;
import java.util.*;

/** 
 * Class to implement an attribute
 */
public class Attribute
{
	/** Continuous attribute. */
	public final static int CONTINUOUS = 0;
	
	/** Discret attribute. */
	public final static int DISCRET = 1;	
	
	/** The name.*/	
	private String name;					
	
	/** The type. */	
	private int type;			
	
	/** Values of a list attribute. */
	private Vector values;					
	
	/** The minor value of a numeric attribute. */	
	private float bottom;					
	
	/** The bigger value of a numeric attribute. */
	private float top;
	
	/** The index. */
	private int index;
	
	/** Is included in the inputs or outputs?. */	
	private boolean used;					

  	/** Constructor for continuous attributes. 
  	 * 
  	 */
  	public Attribute( String attributeName, int attributeIndex  ) 
	{
  		name = attributeName;
  		index = attributeIndex;
  		values = null;
  		type = CONTINUOUS;
  		used = false;
	}

  	/** Constructor for discret attributes.
  	 * 
  	 * @param attributeName		The name of the attribute.
  	 * @param attributeValues	The values of the attributes.
  	 * @param attributeIndex	The index of the attribute.
  	 */
  	public Attribute( String attributeName, Vector attributeValues, int attributeIndex ) 
	{
  		name = attributeName;
  		index = attributeIndex;
		type = DISCRET;
		values = new Vector( attributeValues.size() );
  		used = false;
  			
		for ( int i = 0; i < attributeValues.size(); i++ ) 
		{
			Object store = attributeValues.elementAt( i );
			values.addElement( store );
		}
	}

  	/** Function to get the index of a value in the list of values.
  	 * 
  	 * @param value 	The value.
  	 * 
  	 * @return			The index of the value.
  	 */
  	public final int valueIndex( String value ) 
	{
  		int i = 0;
  		if ( !isDiscret() )
  			return -1;
    
  		Enumeration enum2 = values.elements();
  		
  		while ( enum2.hasMoreElements() )
  		{
  			String element = (String)enum2.nextElement();
  			
  			if ( element.equalsIgnoreCase( value ) )
	  			return i;
  			 
  			i++;
  		}
  		
  		return -1;
	}

  	/** Returns if the attribute is discret or not.
  	 * 
  	 */
  	public final boolean isDiscret() 
	{
  		return ( type == DISCRET );
	}

  	/** Returns if the attribute is continuous or not.
  	 * 
  	 */
  	public final boolean isContinuous()
	{
  		return ( type == CONTINUOUS );
	}

  	/** Returns the name of the attribute.
  	 * 
  	 */
  	public final String name() 
	{
  		return name;
	}
  
   	/** Function to get the number of values of a discret attribute.
   	 * 
   	 * @return	The number of values of the attribute.
   	 */
  	public final int numValues()
	{
  		if ( !isDiscret() )
  			return 0;
  		else
  			return values.size();
	}

  	/** Returns the value with the given index.
  	 * 
  	 * @param valIndex	The index of the value.
  	 */
  	public final String value( int valIndex ) 
	{
  		if ( !isDiscret() )
  			return "";
  		else 
  		{
  			Object val = values.elementAt( valIndex );
      
  			return (String) val;
  		}
	}

  	/** Sets the range of a continuous attribute.
  	 * 
  	 * @param minRange	The minimum value of the range.
  	 * @param maxRange	The maximum value of the range.
  	 */ 
    final void setRange( float minRange, float maxRange ) 
  	{
    	if ( isDiscret() ) 
    		throw new IllegalArgumentException( "Can only set value of numeric attribute!" );
    	else 
    	{
    		bottom = minRange;
    		top = maxRange;
    	}
  	}

  	/** Sets the range of a continuous attribute. 
  	 * 
  	 * @param minRange	The minimum value of the range.
  	 * @param maxRange	The maximum value of the range.
  	 */
    final void setRange( int minRange, int maxRange ) 
  	{
    	if ( isDiscret() ) 
    		throw new IllegalArgumentException( "Can only set value of numeric attribute!" );
    	else 
    	{
    		bottom = minRange;
    		top = maxRange;
    	}
  	}

  	/** Returns the minor value of a continuous attribute. 
  	 * 
  	 */
    public final float getMinRange() 
  	{
    	if ( isDiscret() ) 
    		throw new IllegalArgumentException( "Can only set value of numeric attribute!" );
    	else
    		return bottom;
  	}

  	/** Gets the bigger value of a continuous attribute. 
  	 * 
  	 */
    public final float getMaxRange() 
  	{
    	if ( isDiscret() ) 
    		throw new IllegalArgumentException( "Can only set value of numeric attribute!" );
    	else
    		return top;
  	}
    
    /** Sets the attribute as used. 
     * 
     */
    public void activate()
	{
    	used = true;
    }
    
    /** Returns true if this attribute used in output or input clause. 
     * 
     */
    public boolean isActive()
	{
    	return used;
    }

    /** Returns the index of the attribute.
     * 
     */
    public int getIndex()
	{
    	return index;
    }
}