All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface aid.cbr.tools.core.cbrcase.IndiceType

public interface IndiceType

Defines the interface of type information access about a simple indice. The goal of this interface is not to represent types in a generic way, but it defines only the useful information for doing case base reasoning with CBR*Tools. In addition, we have taken into account primitive types (int and float) dyrectly into the interface for better performance and avoid the use of wrappers.

Version:: $Revision$, $Date$
Author:: M. Jaczynski

enum()

Returns the list of elements defining this type.

floatEnum()

Returns the list of elements defining this type.

getMaxFloatValue()

Returns the maximum value of this type.

getMaxIntValue()

Returns the maximum value of this type.

getMaxValue()

Returns the maximum value of this type.

getMinFloatValue()

Returns the minimum value of this type

Precondiftons:

 this.isBounded()==true
 this.isFloat()==true

getMinIntValue()

Returns the minimum value of this type

Precondiftons:

 this.isInt()==true
 this.isBounded()==true

getMinValue()

Returns the minimum value of this type

Precondiftons:

 this.isBounded()==true

getUndefFloatValue()

Returns the value used to indiquate that a value is undefined in this type.

getUndefIntValue()

Returns the value used to indiquate that a value is undefined in this type.

getUndefValue()

Returns the value used to indiquate that a value is undefined in this type.

getUnknownFloatValue()

Returns the value used to represents an unknown value.

getUnknownIntValue()

Returns the value used to represents an unknown value.

getUnknownValue()

Returns the value used to represents an unknown value.

greatherThan(Object, Object)

Defines the ordering function.

intEnum()

Returns the list of elements defining this type.

isBounded()

Indiquates if this type has upper and lower bounds.

isDefined(Object)

Tests if a given value is undefined in this type.

isEnumerated()

Indiquates if this type is defined by extension.

isFloat()

Indiquates if this type represents the primitive float type.

isFloatDefined(float)

Tests if a given value is undefined in this type.

isFloatUnknown(float)

Tests if a given value is unknown for this type.

isInt()

Indiquates if this type represents the primitive int type.

isIntDefined(int)

Tests if a given value is undefined in this type.

isIntUnknown(int)

Tests if a given value is unknown for this type.

isObject()

Indiquates if this this stores its elements as objects.

isOrdered()

Indiquates if the type is ordered i.e.

isUnknown(Object)

Tests if a given value is unknown for this type.

isValidFloatValue(float)

Indiquates if a float value is an element of this type.

isValidIntValue(int)

Indiquates if a int value is an element of this type.

isValidValue(Object)

Indiquates if a value is an element of this type.

isOrdered

 public abstract boolean isOrdered()

Indiquates if the type is ordered i.e. defines a function to order elements.

Returns:: true<\code> if the type is ordered false<\code> otherwise



greatherThan
 public abstract boolean greatherThan(Object o1,
                                      Object o2)


   Defines the ordering function.
 Precondiftons:
 this.isOrdered()==true
 

  

     Parameters:
    
 o1 - the first object
    
 o2 - the second object
    
 Returns:
    
 true<\code> if o1 < o2
          false<\code> otherwise
  



isValidValue
 public abstract boolean isValidValue(Object o)


   Indiquates if a value is an element of this type.

  

     Parameters:
    
 o - the object
    
 Returns:
    
 true<\code> if the object is element of this type or if it is undefined or unknown
          false<\code> otherwise
  



isValidFloatValue
 public abstract boolean isValidFloatValue(float f)


   Indiquates if a float value is an element of this type.
 Precondiftons:
 this.isFloat()==true
 

  

     Parameters:
    
 f - the float value
    
 Returns:
    
 true<\code> if the value is element of this type or if it is undefined or unknown
          false<\code> otherwise
  



isValidIntValue
 public abstract boolean isValidIntValue(int i)


   Indiquates if a int value is an element of this type.
 Precondiftons:
 this.isInt()==true
 

  

     Parameters:
    
 i - the value
    
 Returns:
    
 true<\code> if the value is element of this type or if it is undefined or unknown
          false<\code> otherwise
  



isBounded
 public abstract boolean isBounded()


   Indiquates if this type has upper and lower bounds.
 Precondiftons:
 this.isOrdered()==true
 

  

     Returns:
    
 true<\code> if this type has bounds
          false<\code> otherwise
  



getMinValue
 public abstract Object getMinValue()


   Returns the minimum value of this type
 Precondiftons:
 this.isBounded()==true
 

  

     Returns:
    
 Returns the minimum value of this type.
  


getMinIntValue
 public abstract int getMinIntValue()


   Returns the minimum value of this type
 Precondiftons:
 this.isInt()==true
 this.isBounded()==true
 

  

     Returns:
    
 the minimum
  


getMinFloatValue
 public abstract float getMinFloatValue()


   Returns the minimum value of this type
 Precondiftons:
 this.isBounded()==true
 this.isFloat()==true
 

  

     Returns:
    
 the minimum
  


getMaxValue
 public abstract Object getMaxValue()


   Returns the maximum value of this type.
 Precondiftons:
 this.isBounded()==true
 

  

     Returns:
    
 the minimum
  


getMaxIntValue
 public abstract int getMaxIntValue()


   Returns the maximum value of this type.
 Precondiftons:
 this.isBounded()==true
 this.isInt()==true
 

  

     Returns:
    
 the minimum
  


getMaxFloatValue
 public abstract float getMaxFloatValue()


   Returns the maximum value of this type.
 Precondiftons:
 this.isBounded()==true
 this.isFloat()==true
 

  

     Returns:
    
 the minimum
  


isEnumerated
 public abstract boolean isEnumerated()


   Indiquates if this type is defined by extension.

  

     Returns:
    
 true<\code> if the type is defined by extension
          false<\code> otherwise
  



enum
 public abstract List enum()


   Returns the list of elements defining this type.
 Precondiftons:
 this.isEnumerated()==true
 

  

     Returns:
    
 the list of elements
  


intEnum
 public abstract int[] intEnum()


   Returns the list of elements defining this type.
 Precondiftons:
 this.isEnumerated()==true
 this.isInt()==true
 

  

     Returns:
    
 the list of elements
  


floatEnum
 public abstract float[] floatEnum()


   Returns the list of elements defining this type.
 Precondiftons:
 this.isEnumerated()==true
 this.isFloat()==true
 

  

     Returns:
    
 the list of elements
  


getUnknownValue
 public abstract Object getUnknownValue()


   Returns the value used to represents an unknown value.

  

     Returns:
    
 the unknown value
  


getUnknownIntValue
 public abstract int getUnknownIntValue()


   Returns the value used to represents an unknown value.
 Precondiftons:
 this.isInt()==true
 

  

     Returns:
    
 the unknown value
  


getUnknownFloatValue
 public abstract float getUnknownFloatValue()


   Returns the value used to represents an unknown value.
 Precondiftons:
 this.isInt()==true
 

  

     Returns:
    
 the unknown value
  


isUnknown
 public abstract boolean isUnknown(Object value)


   Tests if a given value is unknown for this type.

  

     Parameters:
    
 value - the value
    
 Returns:
    
 true<\code> if the value is unknown
          false<\code> otherwise
  



isIntUnknown
 public abstract boolean isIntUnknown(int i)


   Tests if a given value is unknown for this type.
 Precondiftons:
 this.isInt()==true
 

  

     Parameters:
    
 i - the int value
    
 Returns:
    
 true<\code>  if the value is unknown
          false<\code> otherwise
  



isFloatUnknown
 public abstract boolean isFloatUnknown(float f)


   Tests if a given value is unknown for this type.
 Precondiftons:
 this.isFloat()==true
 

  

     Parameters:
    
 f - the float value
    
 Returns:
    
 true<\code>  if the value is unknown
          false<\code> otherwise
  



getUndefValue
 public abstract Object getUndefValue()


   Returns the value used to indiquate that a value is undefined in this type.

  

     Returns:
    
 the undefined value
  


getUndefIntValue
 public abstract int getUndefIntValue()


   Returns the value used to indiquate that a value is undefined in this type.
 Precondiftons:
 this.isInt()==true
 

  

     Returns:
    
 the undefined value
  


getUndefFloatValue
 public abstract float getUndefFloatValue()


   Returns the value used to indiquate that a value is undefined in this type.
 Precondiftons:
 this.isFloat()==true
 

  

     Returns:
    
 the undefined value
  


isDefined
 public abstract boolean isDefined(Object v)


   Tests if a given value is undefined in this type.

  

     Parameters:
    
 v - the value
    
 Returns:
    
 true<\code> if the value is undefined
          false<\code> otherwise
  



isIntDefined
 public abstract boolean isIntDefined(int i)


   Tests if a given value is undefined in this type.
 Precondiftons:
 this.isInt()==true
 

  

     Parameters:
    
 i - the int value
    
 Returns:
    
 true<\code>  if the value is undefined
          false<\code> otherwise
  



isFloatDefined
 public abstract boolean isFloatDefined(float f)


   Tests if a given value is undefined in this type.
 Precondiftons:
 this.isFloat()==true
 

  

     Parameters:
    
 f - the float value
    
 Returns:
    
 true<\code> if the value is undefined
          false<\code> otherwise
  



isObject
 public abstract boolean isObject()


   Indiquates if this this stores its elements as objects.
 Invariant:
 this.isObject()==true implies this.isFloat()==false && isInt()==false
 

  

     Returns:
    
 true<\code> if objects are used
          false<\code> otherwise
  



isFloat
 public abstract boolean isFloat()


   Indiquates if this type represents the primitive float type.
 Invariant:
 this.isObject()==true implies to this.isFloat()==false && isInt()==false
 

  

     Returns:
    
 true<\code> if this type is the primitive float type
          false<\code> otherwise
  



isInt
 public abstract boolean isInt()


   Indiquates if this type represents the primitive int type.
 Invariant:
 this.isInt()==true implies this.isFloat()==false && isObject()==false
 

  

     Returns:
    
 true<\code> if this type is the int primitive type
          false<\code> otherwise
  



All Packages  Class Hierarchy  This Package  Previous  Next  Index