org.ai_heuristic.eval

Class MathString

java.lang.Object

org.ai_heuristic.eval.MathString

All Implemented Interfaces:

EvaluateMathDef

public class MathString
extends java.lang.Object
implements EvaluateMathDef

Provides one implementation of a String-based evaluation function that includes mathematical operations. This class can be used to compare one String value with another one and return a result. Because the mathematical comparisons are not well-defined, this is just one set of possibilities and those operations might be highly dubious.

If the value Object is a MetricValue, then this is checked for and the value stored in it used instead.

Author:

Kieran Greer

Constructor Summary

Constructors

Constructor and Description
MathString() Create a new instance of MathString.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	abs(java.lang.String valueType, java.lang.Object value1) Get the absolute value of the value passed in.
java.lang.Object	add(java.lang.String valueType, java.lang.Object value1, java.lang.Object value2) Add the two objects together and return.
protected java.lang.String	add(java.lang.String value1, java.lang.String value2) Add the two String values together by concatenating them.
java.lang.Object	divide(java.lang.String valueType, java.lang.Object value1, java.lang.Object value2) Divide the first value by the second and return the result.
protected java.lang.String	divide(java.lang.String value1, java.lang.String value2) Divide the second String value from the first by removing chars in value2 that are in value1.
protected boolean	evaluate(java.lang.String value1, java.lang.String value2, java.lang.String operator) Evaluate the expression and return true if true.
boolean	mathCompare(java.lang.String valueType, java.lang.Object value1, java.lang.Object value2, java.lang.String operator) Evaluate the expression.
java.lang.Object	mathOperation(java.lang.String valueType, java.lang.Object value1, java.lang.Object value2, java.lang.String operator) Evaluate the expression.
java.lang.Object	multiply(java.lang.String valueType, java.lang.Object value1, java.lang.Object value2) Multiply the first value by the second and return the result.
protected java.lang.String	multiply(java.lang.String value1, java.lang.String value2) Multiply the two String values together by repeating each char in value2, every time it occurs in value1.
java.lang.Object	numEquiv(java.lang.String valueType, long numerical) Get the equivalent of the integer numerical value for the data type.
static int	stringToNum(java.lang.String theStr) get a numerical representation of the string - the number of characters.
java.lang.Object	subtract(java.lang.String valueType, java.lang.Object value1, java.lang.Object value2) Subtract the second value from the first and return the result.
protected java.lang.String	subtract(java.lang.String value1, java.lang.String value2) Subtract the second String value from the first by removing chars in value2 that are in value1.

Methods inherited from class java.lang.Object

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

Constructor Detail

MathString

public MathString()

Create a new instance of MathString.

Method Detail

mathCompare

public boolean mathCompare(java.lang.String valueType,
                           java.lang.Object value1,
                           java.lang.Object value2,
                           java.lang.String operator)

Evaluate the expression.

Specified by:

mathCompare in interface EvaluateMathDef

Parameters:

valueType - the type of the value, assumed to be String.

value1 - first value. Must not be null.

value2 - second value. Must not be null.

operator - comparison operator - greater than (GT), less than (LT), etc. These are all defined in the AiHeuristicConst class.

Returns:

true if comparison is true and false otherwise.

mathOperation

public java.lang.Object mathOperation(java.lang.String valueType,
                                      java.lang.Object value1,
                                      java.lang.Object value2,
                                      java.lang.String operator)

Evaluate the expression.

Specified by:

mathOperation in interface EvaluateMathDef

Parameters:

valueType - the type of the value, assumed to be String.

value1 - first value. Must not be null.

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.

evaluate

protected boolean evaluate(java.lang.String value1,
                           java.lang.String value2,
                           java.lang.String operator)

Evaluate the expression and return true if true.

Parameters:

value1 - first value. Must not be null.

value2 - second value. Must not be null.

operator - comparison operator.

Returns:

true if comparison is true.

add

public java.lang.Object add(java.lang.String valueType,
                            java.lang.Object value1,
                            java.lang.Object value2)

Add the two objects together and return.

Specified by:

add in interface EvaluateMathDef

Parameters:

valueType - the type of the value, assumed to be String.

value1 - first value. Must not be null.

value2 - second value. Must not be null.

Returns:

the two values multiply together.

add

protected java.lang.String add(java.lang.String value1,
                               java.lang.String value2)

Add the two String values together by concatenating them. If either is null, then return the other one.

Parameters:

value1 - first value.

value2 - second value.

Returns:

the values multiply together.

subtract

public java.lang.Object subtract(java.lang.String valueType,
                                 java.lang.Object value1,
                                 java.lang.Object value2)

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

Specified by:

subtract in interface EvaluateMathDef

Parameters:

valueType - the type of the value, assumed to be String.

value1 - first value. Must not be null.

value2 - second value. Must not be null.

Returns:

the second value subtracted from the first.

subtract

protected java.lang.String subtract(java.lang.String value1,
                                    java.lang.String value2)

Subtract the second String value from the first by removing chars in value2 that are in value1. Get rid of first occurrence of each char in value2 from value1. If there is no intersection, then return a null value.

Parameters:

value1 - first value. Must not be null.

value2 - second value. Must not be null.

Returns:

the subtracted value.

multiply

public java.lang.Object multiply(java.lang.String valueType,
                                 java.lang.Object value1,
                                 java.lang.Object value2)

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

Specified by:

multiply in interface EvaluateMathDef

Parameters:

valueType - the type of the value, assumed to be String.

value1 - first value. Must not be null.

value2 - second value. Must not be null.

Returns:

the first value multiplied by the second.

multiply

protected java.lang.String multiply(java.lang.String value1,
                                    java.lang.String value2)

Multiply the two String values together by repeating each char in value2, every time it occurs in value1. Then add any remaining value2 chars to the end. If there is no intersection, then return a null value.

Parameters:

value1 - first value. Must not be null.

value2 - second value. Must not be null.

Returns:

the values multiply together.

divide

public java.lang.Object divide(java.lang.String valueType,
                               java.lang.Object value1,
                               java.lang.Object value2)

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

Specified by:

divide in interface EvaluateMathDef

Parameters:

valueType - the type of the value, assumed to be String.

value1 - first value. Must not be null.

value2 - second value. Must not be null.

Returns:

the first value divided by the second.

divide

protected java.lang.String divide(java.lang.String value1,
                                  java.lang.String value2)

Divide the second String value from the first by removing chars in value2 that are in value1. Get rid of all occurrences of a char set from value2 each time it occurs in value1. If there is no intersection, then return a null value.

Parameters:

value1 - first value. Must not be null.

value2 - second value. Must not be null.

Returns:

the division result.

abs

public java.lang.Object abs(java.lang.String valueType,
                            java.lang.Object value1)

Get the absolute value of the value passed in.

Parameters:

valueType - the type of the value, assumed to be String.

value1 - first value.

Returns:

the absolute (positive) value.

numEquiv

public java.lang.Object numEquiv(java.lang.String valueType,
                                 long numerical)

Get the equivalent of the integer numerical value for the data type.

Parameters:

valueType - the type of the value, assumed to be String.

numerical - an integer numerical value.

Returns:

the equivalent of the numerical value for the data type.

stringToNum

public static int stringToNum(java.lang.String theStr)

get a numerical representation of the string - the number of characters.

Parameters:

theStr - the string to process.

Returns:

the number of characters in the string.