Package com.aquima.interactions.expressions.functions.convert

Class ConvertToNumericBase

java.lang.Object

com.aquima.interactions.expressions.functions.convert.ConvertToNumericBase

All Implemented Interfaces:

IFunction, Serializable

Direct Known Subclasses:

ConvertToCurrency, ConvertToInteger, ConvertToNumber, ConvertToPercentage

public abstract class ConvertToNumericBase
extends Object
implements IFunction

Base class to convert values to a numeric value

Since:

8.3.7

Author:

Jon van Leuven

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConvertToNumericBase(DataType fromType, DataType toType)

Method Summary

Modifier and Type	Method	Description
Type	determineResultType(ISemanticNode... arguments)	This method is used to determine the result type of the function using the type information of the parameters that will be passed to the function.
IValue	evaluate(IArgumentList arguments)	This method should execute the function using the supplied arguments.
IArgumentType[]	getArguments()	This method returns an array containing the definitions of the arguments the function expects.
boolean	isDeprecated()	This method returns a boolean indicating that the function is deprecated and should no longer be used.
abstract IPrimitiveValue	toValue(double doubleValue)
abstract IPrimitiveValue	toValue(IValue value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aquima.interactions.expressions.functions.IFunction

getName

Constructor Details

ConvertToNumericBase

protected ConvertToNumericBase(DataType fromType,
 DataType toType)

Method Details

evaluate

public IValue evaluate(IArgumentList arguments)

Description copied from interface: IFunction

This method should execute the function using the supplied arguments.

Specified by:

evaluate in interface IFunction

Parameters:

arguments - The arguments for the function.

Returns:

The result of the function.

toValue

public abstract IPrimitiveValue toValue(double doubleValue)

toValue

public abstract IPrimitiveValue toValue(IValue value)

isDeprecated

public boolean isDeprecated()

Description copied from interface: IFunction

This method returns a boolean indicating that the function is deprecated and should no longer be used. Functions that are not deprecated should return the value false.

Specified by:

isDeprecated in interface IFunction

Returns:

A message indicating that the function is deprecated.

getArguments

public IArgumentType[] getArguments()

Description copied from interface: IFunction

This method returns an array containing the definitions of the arguments the function expects. When the function does not accept any arguments at all, an empty array should be returned.

Specified by:

getArguments in interface IFunction

Returns:

Array containing the definitions of the parameters.

determineResultType

public Type determineResultType(ISemanticNode... arguments)

Description copied from interface: IFunction

This method is used to determine the result type of the function using the type information of the parameters that will be passed to the function.

Specified by:

determineResultType in interface IFunction

Parameters:

arguments - The type information of the parameters.

Returns:

The result type of the function.