org.jpmml.evaluator.functions

Class AbstractFunction

java.lang.Object

org.jpmml.evaluator.functions.AbstractFunction

All Implemented Interfaces:

Function

Direct Known Subclasses:

AggregateFunction, ArithmeticFunction, BinaryBooleanFunction, ComparisonFunction, EqualityFunction, MathFunction, StringFunction, TrigonometricFunction, UnaryBooleanFunction, ValueFunction, ValueListFunction

public abstract class AbstractFunction
extends java.lang.Object
implements Function

Constructor Summary

Constructors

Constructor and Description
AbstractFunction(java.lang.String name)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkArguments(java.util.List<FieldValue> arguments, int size)
protected void	checkArguments(java.util.List<FieldValue> arguments, int size, boolean allowNulls) Validates arguments for a function that has a fixed number of formal parameters.
protected void	checkVariableArguments(java.util.List<FieldValue> arguments, int minSize)
protected void	checkVariableArguments(java.util.List<FieldValue> arguments, int minSize, boolean allowNulls) Validates arguments for a function that has a variable number ("n or more") of formal parameters.
java.lang.String	getName() Gets the default name of this function.
protected static org.dmg.pmml.DataType	integerToDouble(org.dmg.pmml.DataType dataType)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jpmml.evaluator.Function

evaluate

Constructor Detail

AbstractFunction

public AbstractFunction(java.lang.String name)

Method Detail

checkArguments

protected void checkArguments(java.util.List<FieldValue> arguments,
                  int size)

checkArguments

protected void checkArguments(java.util.List<FieldValue> arguments,
                  int size,
                  boolean allowNulls)

Validates arguments for a function that has a fixed number of formal parameters.

Parameters:

size - The number of arguments.

allowNulls - true if missing arguments are permitted, false otherwise.

Throws:

FunctionException - If the validation fails.

checkVariableArguments

protected void checkVariableArguments(java.util.List<FieldValue> arguments,
                          int minSize)

checkVariableArguments

protected void checkVariableArguments(java.util.List<FieldValue> arguments,
                          int minSize,
                          boolean allowNulls)

Validates arguments for a function that has a variable number ("n or more") of formal parameters.

Parameters:

minSize - The minimum number of arguments.

allowNulls - true if missing arguments are allowed, false otherwise.

Throws:

FunctionException - If the validation fails.

getName

public java.lang.String getName()

Description copied from interface: Function

Gets the default name of this function.

The default name should be unique in application scope. Currently, the JPMML library does not check or enforce this constraint in any way.

Specified by:

getName in interface Function

integerToDouble

protected static org.dmg.pmml.DataType integerToDouble(org.dmg.pmml.DataType dataType)