edu.udo.cs.yale.example
Class AbstractAttribute

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

All Implemented Interfaces:

Attribute, java.lang.Cloneable

Direct Known Subclasses:

BinaryAttribute, NominalAttribute, NumericalAttribute

public abstract class AbstractAttribute
extends java.lang.Object
implements Attribute

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: AbstractAttribute.java,v 2.7 2006/03/21 15:35:39 ingomierswa Exp $

Author:

Ingo Mierswa

See Also:

Ontology.ATTRIBUTE_VALUE_TYPE, Ontology.ATTRIBUTE_BLOCK_TYPE

Field Summary

private int	blockNumber All attributes belonging to the same block should have a common block number.
private int	blockType An int indicating the block type in terms of the Ontology.ATTRIBUTE_BLOCK_TYPE.
private Attribute[]	generatingFunctionArguments If this attribute was generated, this array of attributes holds the input arguments of the generation.
private boolean	generatingFunctionInfix This flag is true if the generating function should be displayed as infix operator.
private java.lang.String	generatingFunctionName Name of the function if this attribute was generated.
protected static int	HIGHEST_BLOCK_NUMBER The highest block number used so far.
private int	index Index of this attribute in its ExampleTable.
private java.lang.String	name Optionally contains the name of the attribute.
private int[]	unit Unit exponents.
private int	unknownCounter Number of undefined values of all attribute values in the data set.
private int	valueType An int indicating the value type in terms of the Ontology.ATTRIBUTE_VALUE_TYPE.

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

UNDEFINED_ATTRIBUTE_INDEX, UNDEFINED_BLOCK_NUMBER, UNIT_NAMES

Constructor Summary

protected	AbstractAttribute(java.lang.String name, int valueType) Creates a simple attribute which is not part of a series and does not provide a unit string.
protected	AbstractAttribute(java.lang.String name, int valueType, int blockType, int blockNumber, java.lang.String functionName, Attribute[] arguments, boolean infix, int[] units) Creates a new attribute.

Method Summary

void	clearConstructionDescription() Clears the construction description.
abstract java.lang.Object	clone() Explicite method definition is necessary to make clone method public.
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.
static int[]	divideUnits(int[] unit1, int[] unit2) Divides the first given units by the second.
boolean	equalConstructionDescription(Attribute a) Returns true if the attribute was constructed the same way a was constructed.
boolean	equals(java.lang.Object o) Returns true if the given attribute has the same name and table index.
Attribute[]	getArguments() Returns the arguments that were used to generate this attribute.
int	getBlockNumber() Get the value of block number.
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.
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.
java.lang.String	getName() Returns the name of the attribute.
int	getTableIndex() Returns the index 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	getValueType() Returns the value type of this attribute.
boolean	isBlockStart() Returns true if this attribute is the start attribute of its block.
boolean	isGenerated() Returns true iff this attribute was generated.
boolean	isInterval() Returns true if block type is a value series.
boolean	isSeries() Returns true if block type is a value series.
static int[]	multiplyUnits(int[] unit1, int[] unit2) Multiplies the first given units with the second.
static int[]	parseUnits(java.lang.String unitString) Reads the units from a string as generated by unitToString.
void	readAttributeData(java.io.DataInput in) Reads the attribute data and initializes the corresponding fields from the given input stream.
void	setArguments(Attribute[] arguments) Sets the arguments that were used to generate this attribute.
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	setName(java.lang.String v) 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) Parses and sets the unit string.
void	setUnknownCounter(int unknownCounter) Defines the number of undefined values for this attribute.
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.

Methods inherited from class java.lang.Object

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

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

clearMaps, getAsString, getAverage, getIndex, getMaximum, getMinimum, getMode, getNegativeIndex, getNumberOfValues, getPositiveIndex, getStatisticsString, getValueCount, getValues, getVariance, isBooleanClassification, isDefault, isNominal, isNumerical, mapIndex, mapString, replaceValue, setAverage, setIndexToCounterMap, setMaximum, setMinimum, setMode, setVariance, sortNominalMappings

Field Detail

HIGHEST_BLOCK_NUMBER

protected static int HIGHEST_BLOCK_NUMBER

The highest block number used so far.

name

private java.lang.String name

Optionally contains the name of the attribute.

generatingFunctionName

private java.lang.String generatingFunctionName

Name of the function if this attribute was generated.

generatingFunctionArguments

private Attribute[] generatingFunctionArguments

If this attribute was generated, this array of attributes holds the input arguments of the generation.

generatingFunctionInfix

private boolean generatingFunctionInfix

This flag is true if the generating function should be displayed as infix operator.

blockNumber

private int blockNumber

All attributes belonging to the same block should have a common block number. Single values should have a unique block number.

valueType

private int valueType

An int indicating the value type in terms of the Ontology.ATTRIBUTE_VALUE_TYPE.

blockType

private int blockType

An int indicating the block type in terms of the Ontology.ATTRIBUTE_BLOCK_TYPE.

index

private int index

Index of this attribute in its ExampleTable.

unit

private int[] unit

Unit exponents.

unknownCounter

private int unknownCounter

Number of undefined values of all attribute values in the data set.

Constructor Detail

AbstractAttribute

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

Creates a simple attribute which is not part of a series and does not provide a unit string. This constructor should only be used for attributes which were not generated with help of a Yale generator, i.e. this attribute has no function arguments.

AbstractAttribute

protected AbstractAttribute(java.lang.String name,
                            int valueType,
                            int blockType,
                            int blockNumber,
                            java.lang.String functionName,
                            Attribute[] arguments,
                            boolean infix,
                            int[] units)

Creates a new attribute.

Method Detail

clone

public abstract java.lang.Object clone()

Explicite method definition is necessary to make clone method public.

Specified by:

clone in interface Attribute

Overrides:

clone in class java.lang.Object

copyProperties

public void copyProperties(Attribute attribute)

Copies all properties from the given attribute. The value type must be handled by the objects itself and will not be copied by this method!

Specified by:

copyProperties in interface Attribute

equals

public boolean equals(java.lang.Object o)

Returns true if the given attribute has the same name and table index. Of course it would be still possible that both attributes are part of different AbstractExampleTables.

Specified by:

equals in interface Attribute

Overrides:

equals in class java.lang.Object

equalConstructionDescription

public boolean equalConstructionDescription(Attribute a)

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

Specified by:

equalConstructionDescription in interface Attribute

getName

public java.lang.String getName()

Returns the name of the attribute.

Specified by:

getName in interface Attribute

setName

public void setName(java.lang.String v)

Sets the name of the attribtue.

Specified by:

setName in interface Attribute

getTableIndex

public int getTableIndex()

Returns the index in the example table.

Specified by:

getTableIndex in interface Attribute

setTableIndex

public void setTableIndex(int i)

Sets the index in the example table.

Specified by:

setTableIndex in interface Attribute

compatible

public boolean compatible(Attribute a)

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

Specified by:

compatible in interface Attribute

compatibleUnit

public boolean compatibleUnit(Attribute a)

Returns true if the units are equal.

Specified by:

compatibleUnit in interface Attribute

getUnknownCounter

public int getUnknownCounter()

Returns the number of undefined values for this attribute.

Specified by:

getUnknownCounter in interface Attribute

setUnknownCounter

public void setUnknownCounter(int unknownCounter)

Defines the number of undefined values for this attribute.

Specified by:

setUnknownCounter in interface Attribute

getBlockType

public int getBlockType()

Returns the block type of this attribute.

Specified by:

getBlockType in interface Attribute

See Also:

Ontology.ATTRIBUTE_BLOCK_TYPE

setBlockType

public void setBlockType(int b)

Sets the block type of this attribute.

Specified by:

setBlockType in interface Attribute

See Also:

Ontology.ATTRIBUTE_BLOCK_TYPE

getValueType

public int getValueType()

Returns the value type of this attribute.

Specified by:

getValueType in interface Attribute

See Also:

Ontology.ATTRIBUTE_VALUE_TYPE

getBlockNumber

public int getBlockNumber()

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

Specified by:

getBlockNumber in interface Attribute

Returns:

value of blockNumber.

setBlockNumber

public void setBlockNumber(int blockNumber)

Sets the block number.

Specified by:

setBlockNumber in interface Attribute

setUnits

public void setUnits(java.lang.String unitString)

Parses and sets the unit string.

Specified by:

setUnits in interface Attribute

setUnit

public void setUnit(int index,
                    int exponent)

Sets the unit to given exponent.

Specified by:

setUnit in interface Attribute

getUnit

public int getUnit(int index)

Returns the exponent of the unit.

Specified by:

getUnit in interface Attribute

isSeries

public boolean isSeries()

Returns true if block type is a value series.

Specified by:

isSeries in interface Attribute

isInterval

public boolean isInterval()

Returns true if block type is a value series.

Specified by:

isInterval in interface Attribute

isBlockStart

public boolean isBlockStart()

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

Specified by:

isBlockStart in interface Attribute

setFunctionName

public void setFunctionName(java.lang.String functionName)

Sets the name of the function that generated this attribute.

Specified by:

setFunctionName in interface Attribute

getFunctionName

public java.lang.String getFunctionName()

Returns the name of the function that generated this attribute.

Specified by:

getFunctionName in interface Attribute

setArguments

public void setArguments(Attribute[] arguments)

Sets the arguments that were used to generate this attribute.

Specified by:

setArguments in interface Attribute

getArguments

public Attribute[] getArguments()

Returns the arguments that were used to generate this attribute.

Specified by:

getArguments in interface Attribute

clearConstructionDescription

public void clearConstructionDescription()

Clears the construction description.

Specified by:

clearConstructionDescription in interface Attribute

getConstructionDescription

public java.lang.String getConstructionDescription()

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

Specified by:

getConstructionDescription in interface Attribute

getConstructionDescription

public java.lang.String getConstructionDescription(boolean useInfix)

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

Specified by:

getConstructionDescription in interface Attribute

Parameters:

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

getConstructionDepth

public int getConstructionDepth()

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

Specified by:

getConstructionDepth in interface Attribute

isGenerated

public boolean isGenerated()

Returns true iff this attribute was generated.

Specified by:

isGenerated in interface Attribute

toString

public java.lang.String toString()

Returns a human readable string that describes this attribute.

Specified by:

toString in interface Attribute

Overrides:

toString in class java.lang.Object

unitToString

public java.lang.String unitToString()

Returns a string representation of the units.

Specified by:

unitToString in interface Attribute

parseUnits

public static int[] parseUnits(java.lang.String unitString)

Reads the units from a string as generated by unitToString.

writeAttributeData

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

Writes the (non transient) attribute data to an output stream. Sublasses which has to overwrite this method should first invoke super.writeAttributeData(DataOutput).

Specified by:

writeAttributeData in interface Attribute

Throws:

java.io.IOException

readAttributeData

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

Reads the attribute data and initializes the corresponding fields from the given input stream. The name and the valuetype are not read since this information was already used by the attribute factory to create the correct attribute instance. Subclasses which has to overwrite this method should first invoke super.readAttributeData(DataInput).

Specified by:

readAttributeData in interface Attribute

Throws:

java.io.IOException

multiplyUnits

public static int[] multiplyUnits(int[] unit1,
                                  int[] unit2)

Multiplies the first given units with the second.

divideUnits

public static int[] divideUnits(int[] unit1,
                                int[] unit2)

Divides the first given units by the second.