org.geotools.util
Class NumberRange

Object
  Range
      NumberRange

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MeasurementRange

public class NumberRange
extends Range

A range of numbers. Union and intersection are computed as usual, except that widening conversions will be applied as needed.

Since:

2.0

Author:

Martin Desruisseaux

See Also:

Serialized Form

Module:

modules/library/metadata (gt2-metadata.jar) (Maven report) (SVN head)

Constructor Summary

NumberRange(byte minimum, boolean isMinIncluded, byte maximum, boolean isMaxIncluded)
Constructs a range of byte values.

NumberRange(byte minimum, byte maximum)
Constructs an inclusive range of byte values.

NumberRange(Class type, Number minimum, boolean isMinIncluded, Number maximum, boolean isMaxIncluded)
Constructs a range of Number objects.

NumberRange(Class type, Number minimum, Number maximum)
Constructs an inclusive range of Number objects.

NumberRange(double minimum, boolean isMinIncluded, double maximum, boolean isMaxIncluded)
Constructs a range of double values.

NumberRange(double minimum, double maximum)
Constructs an inclusive range of double values.

NumberRange(float minimum, boolean isMinIncluded, float maximum, boolean isMaxIncluded)
Constructs a range of float values.

NumberRange(float minimum, float maximum)
Constructs an inclusive range of float values.

NumberRange(int minimum, boolean isMinIncluded, int maximum, boolean isMaxIncluded)
Constructs a range of int values.

NumberRange(int minimum, int maximum)
Constructs an inclusive range of int values.

NumberRange(long minimum, boolean isMinIncluded, long maximum, boolean isMaxIncluded)
Constructs a range of long values.

NumberRange(long minimum, long maximum)
Constructs an inclusive range of long values.

NumberRange(Range range)
Constructs a range with the same type and the same values than the specified range.

NumberRange(short minimum, boolean isMinIncluded, short maximum, boolean isMaxIncluded)
Constructs a range of short values.

NumberRange(short minimum, short maximum)
Constructs an inclusive range of short values.

Method Summary

NumberRange	castTo(Class type) Casts this range to the specified type.
boolean	contains(Comparable value) Returns true if the specified value is within this range.
boolean	contains(Number value) Returns true if the specified value is within this range.
boolean	contains(Range range) Returns true if the supplied range is fully contained within this range.
double	getMaximum() Returns the maximum value as a double.
double	getMaximum(boolean inclusive) Returns the maximum value with the specified inclusive or exclusive state.
double	getMinimum() Returns the minimum value as a double.
double	getMinimum(boolean inclusive) Returns the minimum value with the specified inclusive or exclusive state.
Range	intersect(Range range) Returns the intersection of this range with the given range.
boolean	intersects(Range range) Returns true if this range intersects the given range.
Range[]	subtract(Range range) Returns the range of values that are in this range but not in the given range.
Range	union(Range range) Returns the union of this range with the given range.
static NumberRange	wrap(Range range) Wraps the specified Range in a NumberRange object.

Methods inherited from class Range

equals, getElementClass, getMaxValue, getMinValue, hashCode, isEmpty, isMaxIncluded, isMinIncluded, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NumberRange

public NumberRange(byte minimum,
                   byte maximum)

Constructs an inclusive range of byte values.

Parameters:

minimum - The minimum value, inclusive.

maximum - The maximum value, inclusive.

NumberRange

public NumberRange(byte minimum,
                   boolean isMinIncluded,
                   byte maximum,
                   boolean isMaxIncluded)

Constructs a range of byte values.

Parameters:

minimum - The minimum value.

isMinIncluded - Defines whether the minimum value is included in the Range.

maximum - The maximum value.

isMaxIncluded - Defines whether the maximum value is included in the Range.

NumberRange

public NumberRange(short minimum,
                   short maximum)

Constructs an inclusive range of short values.

Parameters:

minimum - The minimum value, inclusive.

maximum - The maximum value, inclusive.

NumberRange

public NumberRange(short minimum,
                   boolean isMinIncluded,
                   short maximum,
                   boolean isMaxIncluded)

Constructs a range of short values.

Parameters:

minimum - The minimum value.

isMinIncluded - Defines whether the minimum value is included in the Range.

maximum - The maximum value.

isMaxIncluded - Defines whether the maximum value is included in the Range.

NumberRange

public NumberRange(int minimum,
                   int maximum)

Constructs an inclusive range of int values.

Parameters:

minimum - The minimum value, inclusive.

maximum - The maximum value, inclusive.

NumberRange

public NumberRange(int minimum,
                   boolean isMinIncluded,
                   int maximum,
                   boolean isMaxIncluded)

Constructs a range of int values.

Parameters:

minimum - The minimum value.

isMinIncluded - Defines whether the minimum value is included in the Range.

maximum - The maximum value.

isMaxIncluded - Defines whether the maximum value is included in the Range.

NumberRange

public NumberRange(long minimum,
                   long maximum)

Constructs an inclusive range of long values.

Parameters:

minimum - The minimum value, inclusive.

maximum - The maximum value, inclusive.

NumberRange

public NumberRange(long minimum,
                   boolean isMinIncluded,
                   long maximum,
                   boolean isMaxIncluded)

Constructs a range of long values.

Parameters:

minimum - The minimum value.

isMinIncluded - Defines whether the minimum value is included in the Range.

maximum - The maximum value.

isMaxIncluded - Defines whether the maximum value is included in the Range.

NumberRange

public NumberRange(float minimum,
                   float maximum)

Constructs an inclusive range of float values.

Parameters:

minimum - The minimum value, inclusive.

maximum - The maximum value, inclusive.

NumberRange

public NumberRange(float minimum,
                   boolean isMinIncluded,
                   float maximum,
                   boolean isMaxIncluded)

Constructs a range of float values.

Parameters:

minimum - The minimum value.

isMinIncluded - Defines whether the minimum value is included in the Range.

maximum - The maximum value.

isMaxIncluded - Defines whether the maximum value is included in the Range.

NumberRange

public NumberRange(double minimum,
                   double maximum)

Constructs an inclusive range of double values.

Parameters:

minimum - The minimum value, inclusive.

maximum - The maximum value, inclusive.

NumberRange

public NumberRange(double minimum,
                   boolean isMinIncluded,
                   double maximum,
                   boolean isMaxIncluded)

Constructs a range of double values.

Parameters:

minimum - The minimum value.

isMinIncluded - Defines whether the minimum value is included in the Range.

maximum - The maximum value.

isMaxIncluded - Defines whether the maximum value is included in the Range.

NumberRange

public NumberRange(Class type,
                   Number minimum,
                   Number maximum)

Constructs an inclusive range of Number objects.

Parameters:

type - The element class, usually one of Byte, Short, Integer, Long, Float or Double.

minimum - The minimum value, inclusive.

maximum - The maximum value, inclusive.

NumberRange

public NumberRange(Class type,
                   Number minimum,
                   boolean isMinIncluded,
                   Number maximum,
                   boolean isMaxIncluded)

Constructs a range of Number objects.

Parameters:

type - The element class, usually one of Byte, Short, Integer, Long, Float or Double.

minimum - The minimum value.

isMinIncluded - Defines whether the minimum value is included in the Range.

maximum - The maximum value.

isMaxIncluded - Defines whether the maximum value is included in the Range.

NumberRange

public NumberRange(Range range)
            throws ClassCastException

Constructs a range with the same type and the same values than the specified range. This is a copy constructor.

Parameters:

range - The range to copy. The elements must be Number instances.

Throws:

ClassCastException - if some elements are not instances of Number.

Since:

2.4

Method Detail

wrap

public static NumberRange wrap(Range range)

Wraps the specified Range in a NumberRange object. If the specified range is already an instance of NumberRange, then it is returned unchanged.

Parameters:

range - The range to wrap

Returns:

The same range than range as a NumberRange object.

castTo

public NumberRange castTo(Class type)

Casts this range to the specified type.

Parameters:

type - The class to cast to. Must be one of Byte, Short, Integer, Long, Float or Double.

Returns:

The casted range, or this if this range already uses the specified type.

contains

public boolean contains(Comparable value)

Returns true if the specified value is within this range.

Overrides:

contains in class Range

contains

public boolean contains(Number value)

Returns true if the specified value is within this range.

contains

public boolean contains(Range range)

Returns true if the supplied range is fully contained within this range.

Overrides:

contains in class Range

intersects

public boolean intersects(Range range)

Returns true if this range intersects the given range.

Overrides:

intersects in class Range

union

public Range union(Range range)

Returns the union of this range with the given range. Widening conversions will be applied as needed.

Overrides:

union in class Range

intersect

public Range intersect(Range range)

Returns the intersection of this range with the given range. Widening conversions will be applied as needed.

Overrides:

intersect in class Range

subtract

public Range[] subtract(Range range)

Returns the range of values that are in this range but not in the given range.

Overrides:

subtract in class Range

getMinimum

public double getMinimum()

Returns the minimum value as a double. If this range is unbounded, then Double.NEGATIVE_INFINITY is returned.

getMinimum

public double getMinimum(boolean inclusive)

Returns the minimum value with the specified inclusive or exclusive state. If this range is unbounded, then Double.NEGATIVE_INFINITY is returned.

Parameters:

inclusive - true for the minimum value inclusive, or false for the minimum value exclusive.

Returns:

The minimum value, inclusive or exclusive as requested.

getMaximum

public double getMaximum()

Returns the maximum value as a double. If this range is unbounded, then Double.POSITIVE_INFINITY is returned.

getMaximum

public double getMaximum(boolean inclusive)

Returns the maximum value with the specified inclusive or exclusive state. If this range is unbounded, then Double.POSITIVE_INFINITY is returned.

Parameters:

inclusive - true for the maximum value inclusive, or false for the maximum value exclusive.

Returns:

The maximum value, inclusive or exclusive as requested.