Main Page | Class Hierarchy | Class List | Class Members

kddml.Core.Scalar.IntegerRangeType Class Reference

Inheritance diagram for kddml.Core.Scalar.IntegerRangeType:

kddml.Core.Scalar.RangeType kddml.Core.Scalar.KDDMLScalarType List of all members.

Public Member Functions

 IntegerRangeType (Comparable< Integer > comparable, boolean is_min_included, Comparable< Integer > comparable1, boolean is_max_included)
boolean isMinIncluded ()
boolean isMaxIncluded ()
Class getElementClass ()
Comparable getMinValue ()
Comparable getMaxValue ()
boolean checkValue (String value)
byte getType ()
boolean contains (Comparable< Integer > comparable)
boolean isEmpty ()
String toString ()

Detailed Description

A class to represent ranges of values. A range is defined to contain all the values between the minimum and maximum values, where the minimum/maximum value can be considered either included or excluded from the range. This example creates a range of Integers whose minimum value is 1 and the maximum value is 5. The range is inclusive at both ends:
Range intRange = new Range(Integer.class, new Integer(1), new Integer(5));
A Range can be unbounded at either or both of its ends. An unbounded end is specified by passing null for the value of that end. A Range unbounded at both of its ends represents a range of all possible values for the Class of elements in that Range. The isMinIncluded() method will always return true for a Range unbounded on the minimum side and correspondingly the isMaxIncluded() method will always return true for a Range unbounded on the maximum side. An empty range is defined as a Range whose minimum value is greater than it's maximum value if the ends are included, or as a Range whose minimum value is greater than or equal to it's maximum value, if the minimum or the maximum value is excluded.

Title: KDDML

Description: Knowledge Discovery in Database Environment

Copyright: Copyright (c) 2003 - 2005

Company: Universita' di Pisa - Dipartimento di Informatica

Author:
Andrea Romei (romei@di.unipi.it)
Version:
2.0.16


Constructor & Destructor Documentation

kddml.Core.Scalar.IntegerRangeType.IntegerRangeType Comparable< Integer >  comparable,
boolean  is_min_included,
Comparable< Integer >  comparable1,
boolean  is_max_included
 

Constructs an Integer range given the minimum value and the maximum value. Whether the minimum value and the maximum value are considered inclusive is specified via the is_min_included and is_max_included variables. An unbounded range can be specified by passing in a null for either of the two values, in which case the Range is unbounded at one end, or for both, in which case the Range represents an all inclusive set. If null is passed in for either variable, the boolean variables have no effect.

Parameters:
comparable Comparable
is_min_included boolean
comparable1 Comparable
is_max_included boolean


Member Function Documentation

boolean kddml.Core.Scalar.IntegerRangeType.isMinIncluded  ) 
 

Returns true if the minimum value is included within this Range. If the range is unbounded at this end, this method will return true.

Returns:
boolean

boolean kddml.Core.Scalar.IntegerRangeType.isMaxIncluded  ) 
 

Returns true if the maximum value is included within this Range. If the range is unbounded at this end, this method will return true.

Returns:
boolean

Class kddml.Core.Scalar.IntegerRangeType.getElementClass  ) 
 

Returns the Class of the elements of this Range.

Returns:
Class

Reimplemented from kddml.Core.Scalar.RangeType.

Comparable kddml.Core.Scalar.IntegerRangeType.getMinValue  ) 
 

Returns the minimum value of this Range. Returns null if the Range is unbounded at this end.

Returns:
Comparable

Comparable kddml.Core.Scalar.IntegerRangeType.getMaxValue  ) 
 

Returns the maximum value of this Range. Returns null if the Range is unbounded at this end.

Returns:
Comparable

boolean kddml.Core.Scalar.IntegerRangeType.checkValue String  value  )  [virtual]
 

Checks if the input value have the right type. Input value is given as java.lang.String. Returns true if the type is correct; returns false otherwise.

Parameters:
value String
Returns:
boolean

Implements kddml.Core.Scalar.RangeType.

byte kddml.Core.Scalar.IntegerRangeType.getType  )  [virtual]
 

Returns the type related to this class as value of KDDMLScalarTypeEnum.

Returns:
byte

Implements kddml.Core.Scalar.KDDMLScalarType.

boolean kddml.Core.Scalar.IntegerRangeType.contains Comparable< Integer >  comparable  ) 
 

Returns true if the specified value is within this Range, i.e. is either equal to or greater than the minimum value of this Range and is either lesser than or equal to the maximum value of this Range.

Parameters:
comparable Comparable The value to be checked for being within this Range.
Returns:
boolean if the Class of the value parameter is not the same as the elementClass of this Range.

boolean kddml.Core.Scalar.IntegerRangeType.isEmpty  ) 
 

Returns true if this Range is empty, i.e. if the minimum value is greater than the maximum value, if both are included, or if the minimum value is greater than equal to the maximum value if either the minimum or maximum value is excluded.

Returns:
boolean

String kddml.Core.Scalar.IntegerRangeType.toString  )  [virtual]
 

Returns a representation of this object as string.

Returns:
String

Implements kddml.Core.Scalar.KDDMLScalarType.


Generated on Thu Feb 23 13:04:46 2006 for kddml by  doxygen 1.4.3