edu.udo.cs.yale.example
Class NumericalAttribute

java.lang.Object
  edu.udo.cs.yale.example.AbstractAttribute
      edu.udo.cs.yale.example.NumericalAttribute

All Implemented Interfaces:

Attribute, java.lang.Cloneable

public class NumericalAttribute
extends AbstractAttribute

This class holds all information on a single numerical attribute. In addition to the information of the superclass this is some statistics data like minimum, maximum and average of the values. If one of the methods designed for nominal attributes is invoked a RuntimeException will be thrown.

Version:

$Id: NumericalAttribute.java,v 2.8 2006/04/05 08:57:22 ingomierswa Exp $

Author:

Ingo Mierswa

Field Summary

private double	average Average of all attribute values.
private double	maximum Maximum of all attribute values.
private double	minimum Minimum of all attribute values.
private double	variance Variance of all attribute values.

Fields inherited from class edu.udo.cs.yale.example.AbstractAttribute

HIGHEST_BLOCK_NUMBER

Fields inherited from interface edu.udo.cs.yale.example.Attribute

UNDEFINED_ATTRIBUTE_INDEX, UNDEFINED_BLOCK_NUMBER, UNIT_NAMES

Constructor Summary

protected	NumericalAttribute(java.lang.String name) Creates a simple attribute which is not part of a series and does not provide a unit string.
protected	NumericalAttribute(java.lang.String name, int valueType) Creates a simple attribute which is not part of a series and does not provide a unit string.

Method Summary

void	clearMaps() Not supported by numerical attributes.
java.lang.Object	clone() Clones this attribute.
void	copyProperties(Attribute attribute) Copies all properties from the given attribute.
java.lang.String	getAsString(double value, int numberOfDigits) Returns a string representation of value.
double	getAverage() Returns the average value of all attribute values in the example table.
int	getIndex(java.lang.String str) Not supported by numerical attributes.
double	getMaximum() Returns the maximum value of all attribute values in the example table.
double	getMinimum() Returns the minimum value of all attribute values in the example table.
java.lang.String	getMode() Not supported by numerical attributes.
int	getNegativeIndex() Not supported by numerical attributes.
int	getNumberOfValues() Not supported by numerical attributes.
int	getPositiveIndex() Not supported by numerical attributes.
java.lang.String	getStatisticsString() Returns a string representation of the range (numerical attribute) or class values (nominal attribute).
int	getValueCount(java.lang.String value) Not supported by numerical attributes.
java.util.Collection<java.lang.String>	getValues() Not supported by numerical attributes.
double	getVariance() Returns the variance of all attribute values in the example table.
boolean	isBooleanClassification() Returns true if this attribute is nominal attribute with two different class values.
boolean	isDefault(double value) Returns true iff value is the default value for this attribute.
boolean	isNominal() Returns true if this attribute is nominal.
boolean	isNumerical() Returns true if this attribute is nominal.
java.lang.String	mapIndex(int index) Not supported by numerical attributes.
int	mapString(java.lang.String str) Not supported by numerical attributes.
void	replaceValue(java.lang.String oldValue, java.lang.String newValue) Not supported by numerical attributes.
void	setAverage(double a) Sets the average value of all attribute values in the example table.
void	setIndexToCounterMap(int[] indexToCounterMap) Not supported by numerical attributes.
void	setMaximum(double m) Sets the maximum value of all attribute values in the example table.
void	setMinimum(double m) Sets the minimum value of all attribute values in the example table.
void	setMode(java.lang.String mode) Not supported by numerical attributes.
void	setVariance(double v) Sets the variance of all attribute values in the example table.
void	sortNominalMappings() Not supported by numerical attributes.
private void	throwNonNominalException(java.lang.String message) Throws a runtime exception if this attribute is not nominal.

Methods inherited from class edu.udo.cs.yale.example.AbstractAttribute

clearConstructionDescription, compatible, compatibleUnit, divideUnits, equalConstructionDescription, equals, getArguments, getBlockNumber, getBlockType, getConstructionDepth, getConstructionDescription, getConstructionDescription, getFunctionName, getName, getTableIndex, getUnit, getUnknownCounter, getValueType, isBlockStart, isGenerated, isInterval, isSeries, multiplyUnits, parseUnits, readAttributeData, setArguments, setBlockNumber, setBlockType, setFunctionName, setName, setTableIndex, setUnit, setUnits, setUnknownCounter, toString, unitToString, writeAttributeData

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

maximum

private double maximum

Maximum of all attribute values.

minimum

private double minimum

Minimum of all attribute values.

average

private double average

Average of all attribute values.

variance

private double variance

Variance of all attribute values.

Constructor Detail

NumericalAttribute

protected NumericalAttribute(java.lang.String name)

Creates a simple attribute which is not part of a series and does not provide a unit string.

NumericalAttribute

protected NumericalAttribute(java.lang.String name,
                             int valueType)

Creates a simple attribute which is not part of a series and does not provide a unit string.

Method Detail

clone

public java.lang.Object clone()

Clones this attribute.

Specified by:

clone in interface Attribute

Specified by:

clone in class AbstractAttribute

copyProperties

public void copyProperties(Attribute attribute)

Copies all properties from the given attribute.

Specified by:

copyProperties in interface Attribute

Overrides:

copyProperties in class AbstractAttribute

getAverage

public double getAverage()

Returns the average value of all attribute values in the example table. In case of a nominal attribute the mode is delivered, i.e. the value which occurs most often in the data for this attribute.

setAverage

public void setAverage(double a)

Sets the average value of all attribute values in the example table.

getVariance

public double getVariance()

Returns the variance of all attribute values in the example table.

setVariance

public void setVariance(double v)

Sets the variance of all attribute values in the example table.

getMaximum

public double getMaximum()

Returns the maximum value of all attribute values in the example table.

setMaximum

public void setMaximum(double m)

Sets the maximum value of all attribute values in the example table.

getMinimum

public double getMinimum()

Returns the minimum value of all attribute values in the example table.

setMinimum

public void setMinimum(double m)

Sets the minimum value of all attribute values in the example table.

isNominal

public boolean isNominal()

Returns true if this attribute is nominal.

isNumerical

public boolean isNumerical()

Returns true if this attribute is nominal.

isBooleanClassification

public boolean isBooleanClassification()

Returns true if this attribute is nominal attribute with two different class values.

isDefault

public boolean isDefault(double value)

Returns true iff value is the default value for this attribute. The default for numerical attributes is 0.

setMode

public void setMode(java.lang.String mode)

Not supported by numerical attributes.

getMode

public java.lang.String getMode()

Not supported by numerical attributes.

clearMaps

public void clearMaps()

Not supported by numerical attributes.

mapString

public int mapString(java.lang.String str)

Not supported by numerical attributes.

getIndex

public int getIndex(java.lang.String str)

Not supported by numerical attributes.

mapIndex

public java.lang.String mapIndex(int index)

Not supported by numerical attributes.

replaceValue

public void replaceValue(java.lang.String oldValue,
                         java.lang.String newValue)

Not supported by numerical attributes.

getValueCount

public int getValueCount(java.lang.String value)

Not supported by numerical attributes.

setIndexToCounterMap

public void setIndexToCounterMap(int[] indexToCounterMap)

Not supported by numerical attributes.

getNegativeIndex

public int getNegativeIndex()

Not supported by numerical attributes.

getPositiveIndex

public int getPositiveIndex()

Not supported by numerical attributes.

getValues

public java.util.Collection<java.lang.String> getValues()

Not supported by numerical attributes.

getNumberOfValues

public int getNumberOfValues()

Not supported by numerical attributes.

sortNominalMappings

public void sortNominalMappings()

Not supported by numerical attributes.

getAsString

public java.lang.String getAsString(double value,
                                    int numberOfDigits)

Returns a string representation of value. If the numberOfDigits is greater than 0 this number is used to format the string.

getStatisticsString

public java.lang.String getStatisticsString()

Returns a string representation of the range (numerical attribute) or class values (nominal attribute).

throwNonNominalException

private void throwNonNominalException(java.lang.String message)

Throws a runtime exception if this attribute is not nominal.