edu.udo.cs.yale.example
Interface Attribute

All Superinterfaces:

java.lang.Cloneable

All Known Implementing Classes:

AbstractAttribute, BinaryAttribute, NominalAttribute, NumericalAttribute

public interface Attribute
extends java.lang.Cloneable

This class holds all information on a single attribute.

• the name
• the index, i.e. its column in the AbstractExampleTable and DataRow
• the value type (nominal, numerical, ...)
• the block type (single value, time series...)
• a number indicating the block it belongs to (important for time series only)
• minimum, maximum and average of the values of the attribute
• information about how the attribute was generated

Version:

$Id: Attribute.java,v 2.76 2006/08/03 14:39:28 ingomierswa Exp $

Author:

Ingo Mierswa

See Also:

Ontology.ATTRIBUTE_VALUE_TYPE, Ontology.ATTRIBUTE_BLOCK_TYPE

Field Summary

static int	UNDEFINED_ATTRIBUTE_INDEX Used to identify that this attribute is not part of any example table.
static int	UNDEFINED_BLOCK_NUMBER Indicates a block number which has not been set properly (for value series) or which need not to be used (single values).
static java.lang.String[]	UNIT_NAMES Names for SI-Units.

Method Summary

void	clearConstructionDescription() Clears the construction description.
void	clearMaps() Clears all mappings for nominal values.
java.lang.Object	clone() Clones this attribute.
boolean	compatible(Attribute a) Returns true if value and block types of this attribute are subtypes of value and block type of a.
boolean	compatibleUnit(Attribute a) Returns true if the units are equal.
void	copyProperties(Attribute attribute) Copies all properties from the given attribute.
boolean	equalConstructionDescription(Attribute o) Returns true if the attribute was constructed the same way a was constructed.
boolean	equals(java.lang.Object o) Returns true if the given object is an attribute with the same name and table index.
Attribute[]	getArguments() Returns the arguments that were used to generate this attribute.
java.lang.String	getAsString(double value, int numberOfDigits) Returns a string representation of value if type is numerical or maps the value to a string if type is nominal.
double	getAverage() Returns the average value of all attribute values in the example table.
int	getBlockNumber() Get the value of blockNumber.
int	getBlockType() Returns the block type of this attribute.
int	getConstructionDepth() Returns the depth of the syntax tree of the construction description.
java.lang.String	getConstructionDescription() Returns a string that describes how this attribute was generated from other attributes (infix).
java.lang.String	getConstructionDescription(boolean useInfix) Returns a string that describes how this attribute was generated from other attributes.
java.lang.String	getFunctionName() Returns the name of the function that generated this attribute.
int	getIndex(java.lang.String str) Returns the index of the given nominal value or -1 if this value was not mapped before by invoking the method mapIndex(int).
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() Returns the mode of all attribute values in the example table.
java.lang.String	getName() Returns the name of the attribute.
int	getNegativeIndex() Returns the index of the first value if this attribute is a classification attribute, i.e. if it is binominal.
int	getNumberOfValues() Returns the number of different values in case of a nominal attribute.
int	getPositiveIndex() Returns the index of the second value if this attribute is a classification attribute.
java.lang.String	getStatisticsString() Returns a string representation of the attribute statistics, i.e. the mean and range for numerical attributes or the mode and class values for nominal attributes.
int	getTableIndex() Returns the index of the column in the example table.
int	getUnit(int index) Returns the exponent of the unit.
int	getUnknownCounter() Returns the number of undefined values for this attribute.
int	getValueCount(java.lang.String value) Returns the number of occurences of the given nominal value.
java.util.Collection<java.lang.String>	getValues() Returns the values of the attribute as an enumeration of strings.
int	getValueType() Returns the value type of this attribute.
double	getVariance() Returns the variance of all attribute values in the example table.
boolean	isBlockStart() Returns true if this attribute is the start attribute of its block.
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	isGenerated() Returns true iff this attribute was generated.
boolean	isInterval() Returns true if block type is a value series.
boolean	isNominal() Returns true if this attribute is nominal.
boolean	isNumerical() Returns true if this attribute is nominal.
boolean	isSeries() Returns true if block type is a value series.
java.lang.String	mapIndex(int index) Returns the attribute value, that is associated with this index.
int	mapString(java.lang.String str) Returns the index for the nominal attribute value str.
void	readAttributeData(java.io.DataInput in) Reads the attribute data from the given input stream.
void	replaceValue(java.lang.String oldValue, java.lang.String newValue) Replaces the old value with the new one.
void	setArguments(Attribute[] arguments) Sets the arguments that were used to generate this attribute.
void	setAverage(double a) Sets the average value of all attribute values in the example table.
void	setBlockNumber(int blockNumber) Sets the block number.
void	setBlockType(int b) Sets the block type of this attribute.
void	setFunctionName(java.lang.String functionName) Sets the name of the function that generated this attribute.
void	setIndexToCounterMap(int[] indexToCounterMap) Sets the index to counter map, e.g. after recalculating the attribute statistics.
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) Sets the average value of all attribute values in the example table.
void	setName(java.lang.String name) Sets the name of the attribtue.
void	setTableIndex(int i) Sets the index in the example table.
void	setUnit(int index, int exponent) Sets the unit to given exponent.
void	setUnits(java.lang.String unitString) Reads the units from a string as generated by unitToString.
void	setUnknownCounter(int unknownCounter) Defines the number of undefined values for this attribute.
void	setVariance(double v) Sets the variance of all attribute values in the example table.
void	sortNominalMappings() This method rearranges the string to number mappings such that they are in alphabetical order.
java.lang.String	toString() Returns a human readable string that describes this attribute.
java.lang.String	unitToString() Returns a string representation of the units.
void	writeAttributeData(java.io.DataOutput out) Writes the (non transient) attribute data to an output stream.

Field Detail

UNIT_NAMES

static final java.lang.String[] UNIT_NAMES

Names for SI-Units.

UNDEFINED_ATTRIBUTE_INDEX

static final int UNDEFINED_ATTRIBUTE_INDEX

Used to identify that this attribute is not part of any example table.

See Also:

Constant Field Values

UNDEFINED_BLOCK_NUMBER

static final int UNDEFINED_BLOCK_NUMBER

Indicates a block number which has not been set properly (for value series) or which need not to be used (single values).

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Returns the name of the attribute.

setName

void setName(java.lang.String name)

Sets the name of the attribtue.

getTableIndex

int getTableIndex()

Returns the index of the column in the example table.

setTableIndex

void setTableIndex(int i)

Sets the index in the example table.

setFunctionName

void setFunctionName(java.lang.String functionName)

Sets the name of the function that generated this attribute.

getFunctionName

java.lang.String getFunctionName()

Returns the name of the function that generated this attribute.

setArguments

void setArguments(Attribute[] arguments)

Sets the arguments that were used to generate this attribute.

getArguments

Attribute[] getArguments()

Returns the arguments that were used to generate this attribute.

clone

java.lang.Object clone()

Clones this attribute.

copyProperties

void copyProperties(Attribute attribute)

Copies all properties from the given attribute.

getAverage

double getAverage()

Returns the average value of all attribute values in the example table. In case of nominal attributes the method getMode() should be used which delivers the value which occurs most often in the data for this attribute.

setAverage

void setAverage(double a)

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

getMode

java.lang.String getMode()

Returns the mode of all attribute values in the example table. In case of numerical attributes the method getAverage() should be used which delivers the average of all values.

setMode

void setMode(java.lang.String mode)

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

getVariance

double getVariance()

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

setVariance

void setVariance(double v)

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

getMaximum

double getMaximum()

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

setMaximum

void setMaximum(double m)

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

getMinimum

double getMinimum()

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

setMinimum

void setMinimum(double m)

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

getUnknownCounter

int getUnknownCounter()

Returns the number of undefined values for this attribute.

setUnknownCounter

void setUnknownCounter(int unknownCounter)

Defines the number of undefined values for this attribute.

getBlockType

int getBlockType()

Returns the block type of this attribute.

See Also:

Ontology.ATTRIBUTE_BLOCK_TYPE

setBlockType

void setBlockType(int b)

Sets the block type of this attribute.

See Also:

Ontology.ATTRIBUTE_BLOCK_TYPE

getValueType

int getValueType()

Returns the value type of this attribute.

See Also:

Ontology.ATTRIBUTE_VALUE_TYPE

getBlockNumber

int getBlockNumber()

Get the value of blockNumber. The blocknumber can be used to distinguish between several different value series.

Returns:

value of blockNumber.

setBlockNumber

void setBlockNumber(int blockNumber)

Sets the block number.

clearConstructionDescription

void clearConstructionDescription()

Clears the construction description.

getConstructionDescription

java.lang.String getConstructionDescription()

Returns a string that describes how this attribute was generated from other attributes (infix).

getConstructionDescription

java.lang.String getConstructionDescription(boolean useInfix)

Returns a string that describes how this attribute was generated from other attributes.

Parameters:

useInfix - Whether or not to use infix notation for binary generators

getConstructionDepth

int getConstructionDepth()

Returns the depth of the syntax tree of the construction description.

setUnit

void setUnit(int index,
             int exponent)

Sets the unit to given exponent.

getUnit

int getUnit(int index)

Returns the exponent of the unit.

equals

boolean equals(java.lang.Object o)

Returns true if the given object is an attribute with the same name and table index.

Overrides:

equals in class java.lang.Object

equalConstructionDescription

boolean equalConstructionDescription(Attribute o)

Returns true if the attribute was constructed the same way a was constructed.

compatible

boolean compatible(Attribute a)

Returns true if value and block types of this attribute are subtypes of value and block type of a.

compatibleUnit

boolean compatibleUnit(Attribute a)

Returns true if the units are equal.

isGenerated

boolean isGenerated()

Returns true iff this attribute was generated.

isSeries

boolean isSeries()

Returns true if block type is a value series.

isInterval

boolean isInterval()

Returns true if block type is a value series.

isNominal

boolean isNominal()

Returns true if this attribute is nominal.

isNumerical

boolean isNumerical()

Returns true if this attribute is nominal.

isBooleanClassification

boolean isBooleanClassification()

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

isBlockStart

boolean isBlockStart()

Returns true if this attribute is the start attribute of its block.

clearMaps

void clearMaps()

Clears all mappings for nominal values.

getIndex

int getIndex(java.lang.String str)

Returns the index of the given nominal value or -1 if this value was not mapped before by invoking the method mapIndex(int).

mapString

int mapString(java.lang.String str)

Returns the index for the nominal attribute value str. If the string is unknown, a new index value is assigned. Returns -1, if str is null.

mapIndex

java.lang.String mapIndex(int index)

Returns the attribute value, that is associated with this index. Index counting starts with 0. WARNING: It is not assured that all indices are used. To iterate over all values please use the collection returned by getValues().

replaceValue

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

Replaces the old value with the new one. Ensures that the new value gets the same value index.

getValueCount

int getValueCount(java.lang.String value)

Returns the number of occurences of the given nominal value.

setIndexToCounterMap

void setIndexToCounterMap(int[] indexToCounterMap)

Sets the index to counter map, e.g. after recalculating the attribute statistics.

getAsString

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

Returns a string representation of value if type is numerical or maps the value to a string if type is nominal. If numberOfDigits is greater than 0 the result must have the given number of digits if the value is numerical.

getNegativeIndex

int getNegativeIndex()

Returns the index of the first value if this attribute is a classification attribute, i.e. if it is binominal.

getPositiveIndex

int getPositiveIndex()

Returns the index of the second value if this attribute is a classification attribute. Works for all binominal attributes.

getValues

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

Returns the values of the attribute as an enumeration of strings. Attribute must have nominal value type.

getNumberOfValues

int getNumberOfValues()

Returns the number of different values in case of a nominal attribute.

getStatisticsString

java.lang.String getStatisticsString()

Returns a string representation of the attribute statistics, i.e. the mean and range for numerical attributes or the mode and class values for nominal attributes.

toString

java.lang.String toString()

Returns a human readable string that describes this attribute.

Overrides:

toString in class java.lang.Object

unitToString

java.lang.String unitToString()

Returns a string representation of the units.

setUnits

void setUnits(java.lang.String unitString)

Reads the units from a string as generated by unitToString.

isDefault

boolean isDefault(double value)

Returns true iff value is the default value for this attribute.

writeAttributeData

void writeAttributeData(java.io.DataOutput out)
                        throws java.io.IOException

Writes the (non transient) attribute data to an output stream.

Throws:

java.io.IOException

readAttributeData

void readAttributeData(java.io.DataInput in)
                       throws java.io.IOException

Reads the attribute data from the given input stream. The name and the value type do not need to be read since this is done by the attribute factory.

Throws:

java.io.IOException

sortNominalMappings

void sortNominalMappings()

This method rearranges the string to number mappings such that they are in alphabetical order.
VERY IMPORTANT NOTE: Do not call this method when this attribute is already associated with an AbstractExampleTable and it already contains Examples. All examples will be messed up!