com.rapidminer.operator.ports.metadata
Class MDNumber<T extends java.lang.Number>

java.lang.Object
  com.rapidminer.operator.ports.metadata.MDNumber<T>

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MDNumber<T>>

Direct Known Subclasses:

MDInteger, MDReal

public abstract class MDNumber<T extends java.lang.Number>
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<MDNumber<T>>

A number which is not known exactly, but maybe only in terms of upper or lower bounds. E.g. after applying an attribute filter, the number of examples is at most the number it was before, but the exact value is unknown.

Author:

Simon Fischer

See Also:

Serialized Form

Nested Class Summary

static class

MDNumber.Relation

Constructor Summary

	MDNumber()
protected	MDNumber(MDNumber<T> other)
	MDNumber(T number)

Method Summary

abstract MDNumber<T>	add(T add)
int	compareTo(MDNumber<T> other)
abstract MDNumber<T>	copy()
MetaDataInfo	equals(T value)
T	getNumber() This returns the estimated number regardless of relation.
MDNumber.Relation	getRelation()
T	getValue() Returns the value.
void	increaseByUnknownAmount()
MetaDataInfo	isAtLeast(T value)
MetaDataInfo	isAtMost(T value)
boolean	isKnown()
abstract MDNumber<T>	multiply(double factor)
void	reduceByUnknownAmount()
protected void	setNumber(T number)
void	setUnkown()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MDNumber

public MDNumber()

MDNumber

protected MDNumber(MDNumber<T> other)

MDNumber

public MDNumber(T number)

Method Detail

equals

public MetaDataInfo equals(T value)

isAtMost

public MetaDataInfo isAtMost(T value)

isAtLeast

public MetaDataInfo isAtLeast(T value)

increaseByUnknownAmount

public void increaseByUnknownAmount()

reduceByUnknownAmount

public void reduceByUnknownAmount()

isKnown

public boolean isKnown()

setUnkown

public void setUnkown()

getValue

public T getValue()

Returns the value. Call this method only if isKnown() returns true. Otherwise, a runtime exception will be thrown.

getRelation

public MDNumber.Relation getRelation()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

copy

public abstract MDNumber<T> copy()

setNumber

protected void setNumber(T number)

getNumber

public T getNumber()

This returns the estimated number regardless of relation. Please take care to handle the relation correctly.

add

public abstract MDNumber<T> add(T add)

multiply

public abstract MDNumber<T> multiply(double factor)

compareTo

public int compareTo(MDNumber<T> other)

Specified by:

compareTo in interface java.lang.Comparable<MDNumber<T extends java.lang.Number>>