Package com.singularsys.extensions.field

Class AbstractComparativeField

java.lang.Object

com.singularsys.extensions.field.AbstractComparativeField

All Implemented Interfaces:

FieldI, Serializable

Direct Known Subclasses:

ComplexFieldWithTotalOrder, ExtDocsTest.StringField2, GenericField, StringField

public abstract class AbstractComparativeField
extends Object
implements FieldI

An abstract base class for fields where comparison methods are implemented using a single cmp(a,b) method. Subclasses just need to implement a single method and not the full set of comparison methods.

Not all types want to extend this class, for instance with doubles it fails to work with NaN values.

Since Jep 4.1 extensions 2.2 this has been moved to the com.singularsys.extensions.field.implementations package from the the com.singularsys.extensions.field package.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractComparativeField()

Method Summary

Modifier and Type	Method	Description
abstract Integer	cmp(Object l, Object r)	Compare two elements, return -1,0,1 if the comparison can be carried out, null otherwise.
Boolean	eq(Object l, Object r)	Equals
Boolean	ge(Object l, Object r)	Greater or equal to
Boolean	gt(Object l, Object r)	Greater than
Boolean	le(Object l, Object r)	Less than or equals to
Boolean	lt(Object l, Object r)	Less than
Boolean	ne(Object l, Object r)	Not Equals

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.singularsys.extensions.field.FieldI

add, and, div, getOne, getZero, mod, mul, neg, not, or, pow, sub

Constructor Details

AbstractComparativeField

public AbstractComparativeField()

Method Details

cmp

public abstract Integer cmp(Object l,
 Object r)
                     throws EvaluationException

Compare two elements, return -1,0,1 if the comparison can be carried out, null otherwise.

Parameters:

l -

r -

Returns:

-1, 0, 1 if l < r, l==r or l > r respectively, or null if comparison cannot be carried out or

Throws:

EvaluationException

eq

public Boolean eq(Object l,
 Object r)
           throws EvaluationException

Description copied from interface: FieldI

Equals

Specified by:

eq in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

an object representing the result or null if it can not be evaluated.

Throws:

EvaluationException - on error

ne

public Boolean ne(Object l,
 Object r)
           throws EvaluationException

Description copied from interface: FieldI

Not Equals

Specified by:

ne in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

an object representing the result or null if it can not be evaluated.

Throws:

EvaluationException - on error

gt

public Boolean gt(Object l,
 Object r)
           throws EvaluationException

Description copied from interface: FieldI

Greater than

Specified by:

gt in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

an object representing the result or null if it can not be evaluated.

Throws:

EvaluationException - on error

ge

public Boolean ge(Object l,
 Object r)
           throws EvaluationException

Description copied from interface: FieldI

Greater or equal to

Specified by:

ge in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

an object representing the result or null if it can not be evaluated.

Throws:

EvaluationException - on error

lt

public Boolean lt(Object l,
 Object r)
           throws EvaluationException

Description copied from interface: FieldI

Less than

Specified by:

lt in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

an object representing the result or null if it can not be evaluated.

Throws:

EvaluationException - on error

le

public Boolean le(Object l,
 Object r)
           throws EvaluationException

Description copied from interface: FieldI

Less than or equals to

Specified by:

le in interface FieldI

Parameters:

l - left-hand argument

r - right-hand argument

Returns:

an object representing the result or null if it can not be evaluated.

Throws:

EvaluationException - on error