org.ai_heuristic.def

Interface EvaluateMathDef

All Known Implementing Classes:

MathBOW, MathString, SimpleMathCompare

public interface EvaluateMathDef

This defines the methods that should be implemented by an evaluator of mathematical operations if they are typically comparisons or operations between two or more values.

Author:

Kieran Greer

Method Summary

Modifier and Type	Method and Description
<T> T	add(java.lang.String valueType, T value1, T value2) Add the two objects together and return.
<T> T	divide(java.lang.String valueType, T value1, T value2) Divide the first value by the second and return the result.
<T> boolean	mathCompare(java.lang.String valueType, T value1, T value2, java.lang.String operator) Evaluate the comparison expression.
<T> java.lang.Object	mathOperation(java.lang.String valueType, T value1, T value2, java.lang.String operator) Evaluate the mathematical expression.
<T> T	multiply(java.lang.String valueType, T value1, T value2) Multiply the first value by the second and return the result.
<T> T	subtract(java.lang.String valueType, T value1, T value2) Subtract the second value from the first and return the result.

Method Detail

mathOperation

<T> java.lang.Object mathOperation(java.lang.String valueType,
                                   T value1,
                                   T value2,
                                   java.lang.String operator)
                            throws java.lang.Exception

Evaluate the mathematical expression.

Parameters:

valueType - the type of the value. This is the object type classname.

value1 - first value.

value2 - second value.

operator - mathematical operator - can be add, subtract, multiply, divide. These are all defined in the AiHeuristicConst class.

Returns:

true if comparison is true and false otherwise.

Throws:

java.lang.Exception - any error.

mathCompare

<T> boolean mathCompare(java.lang.String valueType,
                        T value1,
                        T value2,
                        java.lang.String operator)
                 throws java.lang.Exception

Evaluate the comparison expression.

Parameters:

valueType - the type of the value. This is the object type classname.

value1 - first value.

value2 - second value.

operator - comparison operator, which evaluates 'value1 operator value2'. Operator can be greater than (GT), less than (LT), etc. These are all defined in the AiHeuristicConst class.

Returns:

true if comparison is true and false otherwise.

Throws:

java.lang.Exception - any error.

add

<T> T add(java.lang.String valueType,
          T value1,
          T value2)
   throws java.lang.Exception

Add the two objects together and return.

Parameters:

valueType - the type of the value.

value1 - first value.

value2 - second value.

Returns:

the two values added together.

Throws:

java.lang.Exception - any error.

subtract

<T> T subtract(java.lang.String valueType,
               T value1,
               T value2)
        throws java.lang.Exception

Subtract the second value from the first and return the result.

Parameters:

valueType - the type of the value.

value1 - first value.

value2 - second value.

Returns:

the second value subtracted from the first.

Throws:

java.lang.Exception - any error.

multiply

<T> T multiply(java.lang.String valueType,
               T value1,
               T value2)
        throws java.lang.Exception

Multiply the first value by the second and return the result.

Parameters:

valueType - the type of the value.

value1 - first value.

value2 - second value.

Returns:

the first value multiplied by the second.

Throws:

java.lang.Exception - any error.

divide

<T> T divide(java.lang.String valueType,
             T value1,
             T value2)
      throws java.lang.Exception

Divide the first value by the second and return the result.

Parameters:

valueType - the type of the value.

value1 - first value.

value2 - second value.

Returns:

the first value divided by the second.

Throws:

java.lang.Exception - any error.