org.jpmml.evaluator.functions

Class AbstractFunction

java.lang.Object

org.jpmml.evaluator.functions.AbstractFunction

All Implemented Interfaces:

Function

Direct Known Subclasses:

AbstractNumericFunction, BinaryBooleanFunction, ComparisonFunction, EqualityFunction, StringFunction, UnaryBooleanFunction, ValueFunction, ValueListFunction

public abstract class AbstractFunction
extends Object
implements Function

Constructor Summary

Constructors

Constructor and Description
AbstractFunction(String name)

Method Summary

Modifier and Type	Method and Description
protected FieldValue	checkArgument(FieldValue argument, int index, String alias)
protected void	checkFixedArityArguments(List<FieldValue> arguments, int arity)
protected void	checkVariableArityArguments(List<FieldValue> arguments, int minArity)
protected void	checkVariableArityArguments(List<FieldValue> arguments, int minArity, int maxArity)
String	getName() Gets the default name of this function.
protected FieldValue	getOptionalArgument(List<FieldValue> arguments, int index)
protected FieldValue	getOptionalArgument(List<FieldValue> arguments, int index, String alias)
protected FieldValue	getRequiredArgument(List<FieldValue> arguments, int index)
protected FieldValue	getRequiredArgument(List<FieldValue> arguments, int index, String alias)

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(String name)

Method Detail

checkFixedArityArguments

protected void checkFixedArityArguments(List<FieldValue> arguments,
                                        int arity)

checkVariableArityArguments

protected void checkVariableArityArguments(List<FieldValue> arguments,
                                           int minArity)

checkVariableArityArguments

protected void checkVariableArityArguments(List<FieldValue> arguments,
                                           int minArity,
                                           int maxArity)

getOptionalArgument

protected FieldValue getOptionalArgument(List<FieldValue> arguments,
                                         int index)

getOptionalArgument

protected FieldValue getOptionalArgument(List<FieldValue> arguments,
                                         int index,
                                         String alias)

getRequiredArgument

protected FieldValue getRequiredArgument(List<FieldValue> arguments,
                                         int index)

getRequiredArgument

protected FieldValue getRequiredArgument(List<FieldValue> arguments,
                                         int index,
                                         String alias)

checkArgument

protected FieldValue checkArgument(FieldValue argument,
                                   int index,
                                   String alias)

getName

public 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