Package org.kie.pmml.api.enums

Enum BUILTIN_FUNCTIONS

java.lang.Object

java.lang.Enum<BUILTIN_FUNCTIONS>

org.kie.pmml.api.enums.BUILTIN_FUNCTIONS

All Implemented Interfaces:

Serializable, Comparable<BUILTIN_FUNCTIONS>, Named

public enum BUILTIN_FUNCTIONS
extends Enum<BUILTIN_FUNCTIONS>
implements Named

See Also:

Built-in functions

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABS
ACOS
AND
ASIN
ATAN
AVG
CEIL
CONCAT
COS
COSH
DATE_DAYS_SINCE_YEAR
DATE_SECONDS_SINCE_MIDNIGHT
DATE_SECONDS_SINCE_YEAR
DIVISION
EQUAL
ERF
EXP
EXPM1
FLOOR
FORMAT_DATE_TIME
FORMAT_NUMBER
GREATER_OR_EQUAL
GREATER_THAN
HYPOT
IF
IS_IN
IS_MISSING
IS_NOT_IN
IS_NOT_MISSING
IS_NOT_VALID
IS_VALID
LESS_OR_EQUAL
LESS_THAN
LN
LN1P
LOG10
LOWERCASE
MATCHES
MAX
MEDIAN
MIN
MINUS
MODULO
MULTI
NORMAL_CDF
NORMAL_IDF
NORMAL_PDF
NOT
NOT_EQUAL
OR
PLUS
POW
PRODUCT
REPLACE
RINT
ROUND
SIN
SINH
SQRT
STD_NORMAL_CDF
STD_NORMAL_IDF
STD_NORMAL_PDF
STRING_LENGTH
SUBSTRING
SUM
TAN
TANH
THRESHOLD
TRIM_BLANKS
UPPERCASE

Method Summary

Modifier and Type	Method	Description
static BUILTIN_FUNCTIONS	byName(String name)
static void	checkBoolean(Object object)
static void	checkBooleans(Object[] inputData, int expectedSize)
static void	checkDate(Object object)
static void	checkDates(Object[] inputData, int expectedSize)
static void	checkInteger(Object object)
static void	checkLength(Object[] inputData, int expectedSize)
static void	checkMinimumLength(Object[] inputData, int minimumLength)
static void	checkNumber(Object object)
static void	checkNumbers(Object[] inputData, int expectedSize)
static void	checkRangeLength(Object[] inputData, int minimumLength, int maximumLength)
static void	checkString(Object object)
static void	checkStrings(Object[] inputData, int expectedSize)
String	getName()
Object	getValue(Object[] inputData, MiningField referredByFieldRef)
static boolean	isBUILTIN_FUNCTIONS(String name)
static boolean	isBUILTIN_FUNCTIONS_VALIDATION(String name)
static BUILTIN_FUNCTIONS	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BUILTIN_FUNCTIONS[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PLUS

public static final BUILTIN_FUNCTIONS PLUS

MINUS

public static final BUILTIN_FUNCTIONS MINUS

MULTI

public static final BUILTIN_FUNCTIONS MULTI

DIVISION

public static final BUILTIN_FUNCTIONS DIVISION

MIN

public static final BUILTIN_FUNCTIONS MIN

MAX

public static final BUILTIN_FUNCTIONS MAX

SUM

public static final BUILTIN_FUNCTIONS SUM

AVG

public static final BUILTIN_FUNCTIONS AVG

MEDIAN

public static final BUILTIN_FUNCTIONS MEDIAN

PRODUCT

public static final BUILTIN_FUNCTIONS PRODUCT

LOG10

public static final BUILTIN_FUNCTIONS LOG10

LN

public static final BUILTIN_FUNCTIONS LN

SQRT

public static final BUILTIN_FUNCTIONS SQRT

ABS

public static final BUILTIN_FUNCTIONS ABS

EXP

public static final BUILTIN_FUNCTIONS EXP

POW

public static final BUILTIN_FUNCTIONS POW

THRESHOLD

public static final BUILTIN_FUNCTIONS THRESHOLD

FLOOR

public static final BUILTIN_FUNCTIONS FLOOR

CEIL

public static final BUILTIN_FUNCTIONS CEIL

ROUND

public static final BUILTIN_FUNCTIONS ROUND

MODULO

public static final BUILTIN_FUNCTIONS MODULO

IS_MISSING

public static final BUILTIN_FUNCTIONS IS_MISSING

IS_NOT_MISSING

public static final BUILTIN_FUNCTIONS IS_NOT_MISSING

IS_VALID

public static final BUILTIN_FUNCTIONS IS_VALID

IS_NOT_VALID

public static final BUILTIN_FUNCTIONS IS_NOT_VALID

EQUAL

public static final BUILTIN_FUNCTIONS EQUAL

NOT_EQUAL

public static final BUILTIN_FUNCTIONS NOT_EQUAL

LESS_THAN

public static final BUILTIN_FUNCTIONS LESS_THAN

LESS_OR_EQUAL

public static final BUILTIN_FUNCTIONS LESS_OR_EQUAL

GREATER_THAN

public static final BUILTIN_FUNCTIONS GREATER_THAN

GREATER_OR_EQUAL

public static final BUILTIN_FUNCTIONS GREATER_OR_EQUAL

AND

public static final BUILTIN_FUNCTIONS AND

OR

public static final BUILTIN_FUNCTIONS OR

NOT

public static final BUILTIN_FUNCTIONS NOT

IS_IN

public static final BUILTIN_FUNCTIONS IS_IN

IS_NOT_IN

public static final BUILTIN_FUNCTIONS IS_NOT_IN

IF

public static final BUILTIN_FUNCTIONS IF

UPPERCASE

public static final BUILTIN_FUNCTIONS UPPERCASE

LOWERCASE

public static final BUILTIN_FUNCTIONS LOWERCASE

STRING_LENGTH

public static final BUILTIN_FUNCTIONS STRING_LENGTH

SUBSTRING

public static final BUILTIN_FUNCTIONS SUBSTRING

TRIM_BLANKS

public static final BUILTIN_FUNCTIONS TRIM_BLANKS

CONCAT

public static final BUILTIN_FUNCTIONS CONCAT

REPLACE

public static final BUILTIN_FUNCTIONS REPLACE

MATCHES

public static final BUILTIN_FUNCTIONS MATCHES

FORMAT_NUMBER

public static final BUILTIN_FUNCTIONS FORMAT_NUMBER

FORMAT_DATE_TIME

public static final BUILTIN_FUNCTIONS FORMAT_DATE_TIME

DATE_DAYS_SINCE_YEAR

public static final BUILTIN_FUNCTIONS DATE_DAYS_SINCE_YEAR

DATE_SECONDS_SINCE_YEAR

public static final BUILTIN_FUNCTIONS DATE_SECONDS_SINCE_YEAR

DATE_SECONDS_SINCE_MIDNIGHT

public static final BUILTIN_FUNCTIONS DATE_SECONDS_SINCE_MIDNIGHT

NORMAL_CDF

public static final BUILTIN_FUNCTIONS NORMAL_CDF

NORMAL_PDF

public static final BUILTIN_FUNCTIONS NORMAL_PDF

STD_NORMAL_CDF

public static final BUILTIN_FUNCTIONS STD_NORMAL_CDF

STD_NORMAL_PDF

public static final BUILTIN_FUNCTIONS STD_NORMAL_PDF

ERF

public static final BUILTIN_FUNCTIONS ERF

NORMAL_IDF

public static final BUILTIN_FUNCTIONS NORMAL_IDF

STD_NORMAL_IDF

public static final BUILTIN_FUNCTIONS STD_NORMAL_IDF

EXPM1

public static final BUILTIN_FUNCTIONS EXPM1

HYPOT

public static final BUILTIN_FUNCTIONS HYPOT

LN1P

public static final BUILTIN_FUNCTIONS LN1P

RINT

public static final BUILTIN_FUNCTIONS RINT

SIN

public static final BUILTIN_FUNCTIONS SIN

ASIN

public static final BUILTIN_FUNCTIONS ASIN

SINH

public static final BUILTIN_FUNCTIONS SINH

COS

public static final BUILTIN_FUNCTIONS COS

ACOS

public static final BUILTIN_FUNCTIONS ACOS

COSH

public static final BUILTIN_FUNCTIONS COSH

TAN

public static final BUILTIN_FUNCTIONS TAN

ATAN

public static final BUILTIN_FUNCTIONS ATAN

TANH

public static final BUILTIN_FUNCTIONS TANH

Method Detail

values

public static BUILTIN_FUNCTIONS[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BUILTIN_FUNCTIONS c : BUILTIN_FUNCTIONS.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BUILTIN_FUNCTIONS valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isBUILTIN_FUNCTIONS

public static boolean isBUILTIN_FUNCTIONS(String name)

isBUILTIN_FUNCTIONS_VALIDATION

public static boolean isBUILTIN_FUNCTIONS_VALIDATION(String name)

byName

public static BUILTIN_FUNCTIONS byName(String name)

getName

public String getName()

Specified by:

getName in interface Named

getValue

public Object getValue(Object[] inputData,
                       MiningField referredByFieldRef)

checkNumbers

public static void checkNumbers(Object[] inputData,
                                int expectedSize)

checkNumber

public static void checkNumber(Object object)

checkInteger

public static void checkInteger(Object object)

checkStrings

public static void checkStrings(Object[] inputData,
                                int expectedSize)

checkString

public static void checkString(Object object)

checkBooleans

public static void checkBooleans(Object[] inputData,
                                 int expectedSize)

checkBoolean

public static void checkBoolean(Object object)

checkDates

public static void checkDates(Object[] inputData,
                              int expectedSize)

checkDate

public static void checkDate(Object object)

checkLength

public static void checkLength(Object[] inputData,
                               int expectedSize)

checkMinimumLength

public static void checkMinimumLength(Object[] inputData,
                                      int minimumLength)

checkRangeLength

public static void checkRangeLength(Object[] inputData,
                                    int minimumLength,
                                    int maximumLength)