org.knime.core.data
Interface IntervalValue

All Superinterfaces:

DataValue

All Known Implementing Classes:

IntervalCell

public interface IntervalValue
extends DataValue

Interface supporting interval cells holding minimum and maximum boundaries.

Author:

Thomas Gabriel, University of Konstanz

Nested Class Summary

static class

IntervalValue.IntervalUtilityFactory Implementations of the meta information of this value class.

Nested classes/interfaces inherited from interface org.knime.core.data.DataValue

DataValue.UtilityFactory

Field Summary

static DataValue.UtilityFactory

UTILITY Meta information to this value type.

Method Summary

int	compare(double value) Determines if the given double value is contained in this interval, to the left or to the right.
int	compare(DoubleValue value) Determines if the given double value is contained in this interval, to the left or to the right.
double	getLeftBound()
double	getRightBound()
boolean	includes(IntervalValue value) Determines if the given IntervalValue is contained in this interval.
boolean	leftBoundIncluded()
boolean	rightBoundIncluded()

Field Detail

UTILITY

static final DataValue.UtilityFactory UTILITY

Meta information to this value type.

See Also:

DataValue.UTILITY

Method Detail

getLeftBound

double getLeftBound()

Returns:

minimum border

getRightBound

double getRightBound()

Returns:

maximum border

leftBoundIncluded

boolean leftBoundIncluded()

Returns:

whether the left bound is included in the interval

rightBoundIncluded

boolean rightBoundIncluded()

Returns:

whether the right bound is included in the interval

compare

int compare(double value)

Determines if the given double value is contained in this interval, to the left or to the right.

Parameters:

value - the value to check

Returns:

-1 if value is left to the interval, 0 if it is included an 1 if it is to the right of the interval

compare

int compare(DoubleValue value)

Determines if the given double value is contained in this interval, to the left or to the right.

Parameters:

value - the value to check

Returns:

-1 if value is left to the interval, 0 if it is included an 1 if it is to the right of the interval

includes

boolean includes(IntervalValue value)

Determines if the given IntervalValue is contained in this interval.

Parameters:

value - the interval to check

Returns:

true if the value is completely contained in the interval