Uses of Annotation Interface
com.pervasive.datarush.annotations.FunctionArgument

Packages that use FunctionArgument

Package	Description
com.pervasive.datarush.analytics.functions	Provides various statistics functions.
com.pervasive.datarush.functions	Provides classes and interfaces related to defining functions on records.
com.pervasive.datarush.matching.functions	Provides functions related to approximate matching.
com.pervasive.datarush.operators.group	Provides data aggregation components.

Uses of FunctionArgument in com.pervasive.datarush.analytics.functions

Method parameters in com.pervasive.datarush.analytics.functions with annotations of type FunctionArgument

Modifier and Type	Method	Description
static ScalarValuedFunction	StatsFunctions.minmax(ScalarValuedFunction expr, double min, double max)	Create a MinMax normalization function for the given subexpression.
static ScalarValuedFunction	StatsFunctions.minmax(ScalarValuedFunction expr, double min, double max)	Create a MinMax normalization function for the given subexpression.
static ScalarValuedFunction	StatsFunctions.minmax(ScalarValuedFunction expr, double min, double max)	Create a MinMax normalization function for the given subexpression.
static ScalarValuedFunction	StatsFunctions.minmax(ScalarValuedFunction expr, BigDecimal min, BigDecimal max)	Create a MinMax normalization function for the given subexpression.
static ScalarValuedFunction	StatsFunctions.minmax(ScalarValuedFunction expr, BigDecimal min, BigDecimal max)	Create a MinMax normalization function for the given subexpression.
static ScalarValuedFunction	StatsFunctions.minmax(ScalarValuedFunction expr, BigDecimal min, BigDecimal max)	Create a MinMax normalization function for the given subexpression.
static ScalarValuedFunction	StatsFunctions.zscore(ScalarValuedFunction expr, double mean, double stddev)	Create a Z-Score normalization function for the given input function.
static ScalarValuedFunction	StatsFunctions.zscore(ScalarValuedFunction expr, double mean, double stddev)	Create a Z-Score normalization function for the given input function.
static ScalarValuedFunction	StatsFunctions.zscore(ScalarValuedFunction expr, double mean, double stddev)	Create a Z-Score normalization function for the given input function.
static ScalarValuedFunction	StatsFunctions.zscore(ScalarValuedFunction expr, BigDecimal mean, BigDecimal stddev)	Create a Z-Score normalization function for the given input function.
static ScalarValuedFunction	StatsFunctions.zscore(ScalarValuedFunction expr, BigDecimal mean, BigDecimal stddev)	Create a Z-Score normalization function for the given input function.
static ScalarValuedFunction	StatsFunctions.zscore(ScalarValuedFunction expr, BigDecimal mean, BigDecimal stddev)	Create a Z-Score normalization function for the given input function.

Uses of FunctionArgument in com.pervasive.datarush.functions

Method parameters in com.pervasive.datarush.functions with annotations of type FunctionArgument

Modifier and Type	Method	Description
static ScalarValuedFunction	Math.abs(ScalarValuedFunction expr)	Returns the absolute value of the given expression.
static ScalarValuedFunction	Math.acos(ScalarValuedFunction expr)	Returns the arc cosine of the given expression using radians.
static ScalarValuedFunction	DateTime.addTime(ScalarValuedFunction time, ScalarValuedFunction delta, DateTime.Granularity granularity)	Adds a time period to the specified date/time value.
static ScalarValuedFunction	DateTime.addTime(ScalarValuedFunction time, ScalarValuedFunction delta, DateTime.Granularity granularity)	Adds a time period to the specified date/time value.
static ScalarValuedFunction	DateTime.addTime(ScalarValuedFunction time, ScalarValuedFunction delta, DateTime.Granularity granularity)	Adds a time period to the specified date/time value.
static ScalarValuedFunction	DateTime.addTime(ScalarValuedFunction time, ScalarValuedFunction delta, DateTime.Granularity granularity, ZoneId zoneId)	Adds a time period to the specified date/time value.
static ScalarValuedFunction	DateTime.addTime(ScalarValuedFunction time, ScalarValuedFunction delta, DateTime.Granularity granularity, ZoneId zoneId)	Adds a time period to the specified date/time value.
static ScalarValuedFunction	DateTime.addTime(ScalarValuedFunction time, ScalarValuedFunction delta, DateTime.Granularity granularity, ZoneId zoneId)	Adds a time period to the specified date/time value.
static ScalarValuedFunction	DateTime.addTime(ScalarValuedFunction time, ScalarValuedFunction delta, DateTime.Granularity granularity, ZoneId zoneId)	Adds a time period to the specified date/time value.
static ScalarValuedFunction	Conversions.asBoolean(ScalarValuedFunction expr, int truth, int falsity)	Convert an int typed field into a boolean type.
static ScalarValuedFunction	Conversions.asBoolean(ScalarValuedFunction expr, int truth, int falsity)	Convert an int typed field into a boolean type.
static ScalarValuedFunction	Conversions.asBoolean(ScalarValuedFunction expr, int truth, int falsity)	Convert an int typed field into a boolean type.
static ScalarValuedFunction	Conversions.asDate(ScalarValuedFunction expr)	Convert a timestamp expression result into a date field.
static ScalarValuedFunction	Conversions.asDouble(ScalarValuedFunction expr)	Convert a numeric typed expression into a double type.
static ScalarValuedFunction	Conversions.asFloat(ScalarValuedFunction expr)	Convert a numeric typed expression into a float type.
static ScalarValuedFunction	Math.asin(ScalarValuedFunction expr)	Returns the arc sine of the given expression using radians.
static ScalarValuedFunction	Conversions.asInt(ScalarValuedFunction expr)	Convert a numeric typed expression into an integer type.
static ScalarValuedFunction	Conversions.asLong(ScalarValuedFunction expr)	Convert a numeric typed expression into a long type.
static ScalarValuedFunction	Conversions.asMoney(ScalarValuedFunction expr)	Convert a numeric typed expression into a money type.
static ScalarValuedFunction	Conversions.asNumeric(ScalarValuedFunction expr)	Convert a numeric typed expression into a numeric type.
static ScalarValuedFunction	Conversions.asTime(ScalarValuedFunction expr)	Convert a timestamp expression result into a time field.
static ScalarValuedFunction	Math.atan(ScalarValuedFunction expr)	Returns the arc tangent of the given expression using radians.
static ScalarValuedFunction	Math.atan2(ScalarValuedFunction y, ScalarValuedFunction x)	Returns the angle theta from the conversion of rectangular coordinates (x, y) to polar coordinates (r, theta).
static ScalarValuedFunction	Math.atan2(ScalarValuedFunction y, ScalarValuedFunction x)	Returns the angle theta from the conversion of rectangular coordinates (x, y) to polar coordinates (r, theta).
static ScalarValuedFunction	Math.cbrt(ScalarValuedFunction expr)	Returns the cube root of the given expression.
static ScalarValuedFunction	Math.ceil(ScalarValuedFunction expr)	Returns the ceiling of the given expression.
static ScalarValuedFunction	MapFunctions.containsKey(ScalarValuedFunction leftExpr, ScalarValuedFunction rightExpr)	Builds an expression to check if an expression contains a mapping for the key specified by the other expression.
static ScalarValuedFunction	MapFunctions.containsKey(ScalarValuedFunction leftExpr, ScalarValuedFunction rightExpr)	Builds an expression to check if an expression contains a mapping for the key specified by the other expression.
static ScalarValuedFunction	Math.copySign(ScalarValuedFunction magnitude, ScalarValuedFunction sign)	Returns magnitude with the sign of sign.
static ScalarValuedFunction	Math.copySign(ScalarValuedFunction magnitude, ScalarValuedFunction sign)	Returns magnitude with the sign of sign.
static ScalarValuedFunction	Math.cos(ScalarValuedFunction expr)	Returns the cosine of the given expression using radians.
static ScalarValuedFunction	Math.cosh(ScalarValuedFunction expr)	Returns the hyperbolic cosine of the given expression using radians.
static ScalarValuedFunction	DateTime.currentDate(ZoneId zoneId)	Returns the current date in the specified time zone.
static ScalarValuedFunction	DateTime.currentTime(ZoneId zoneId)	Returns the current time of day in the specified time zone.
static ScalarValuedFunction	DateTime.currentTimestamp(ZoneId zoneId)	Returns the current time stamp in the specified time zone.
static ScalarValuedFunction	Math.exp(ScalarValuedFunction expr)	Returns e raised to the power of the given expression.
static ScalarValuedFunction	Math.expm1(ScalarValuedFunction expr)	Returns e raised to the power of the given expression minus 1.
static ScalarValuedFunction	Actions.fail(ScalarValuedFunction expr, String message)	Will throw an exception if the expression evaluates to true.
static ScalarValuedFunction	Actions.fail(ScalarValuedFunction expr, String message)	Will throw an exception if the expression evaluates to true.
static ScalarValuedFunction	Strings.find(ScalarValuedFunction value, String pattern)	Builds a function returning the first index of the substring that matches the provided pattern in the string value to which the specified expression evaluates.
static ScalarValuedFunction	Strings.find(ScalarValuedFunction value, String pattern)	Builds a function returning the first index of the substring that matches the provided pattern in the string value to which the specified expression evaluates.
static ScalarValuedFunction	Math.floor(ScalarValuedFunction expr)	Returns the floor of the given expression.
static ScalarValuedFunction	Math.getExponent(ScalarValuedFunction expr)	Returns the unbiased exponent used in the representation of a double or float.
static ScalarValuedFunction	DateTime.getTextValue(ScalarValuedFunction expr, DateTime.DateTimeValue valueType)	Create a function that will extract the wanted date or time value as text from the given function applied to a record flow.
static ScalarValuedFunction	DateTime.getTextValue(ScalarValuedFunction expr, DateTime.DateTimeValue valueType)	Create a function that will extract the wanted date or time value as text from the given function applied to a record flow.
static ScalarValuedFunction	DateTime.getTextValue(ScalarValuedFunction expr, DateTime.DateTimeValue valueType, ZoneId zoneId)	Create a function that will extract the wanted date or time value as text from the given function applied to a record flow.
static ScalarValuedFunction	DateTime.getTextValue(ScalarValuedFunction expr, DateTime.DateTimeValue valueType, ZoneId zoneId)	Create a function that will extract the wanted date or time value as text from the given function applied to a record flow.
static ScalarValuedFunction	DateTime.getTextValue(ScalarValuedFunction expr, DateTime.DateTimeValue valueType, ZoneId zoneId)	Create a function that will extract the wanted date or time value as text from the given function applied to a record flow.
static ScalarValuedFunction	DateTime.getValue(ScalarValuedFunction expr, DateTime.DateTimeValue valueType)	Create a function that will extract the wanted date or time value from the given function applied to a record flow.
static ScalarValuedFunction	DateTime.getValue(ScalarValuedFunction expr, DateTime.DateTimeValue valueType)	Create a function that will extract the wanted date or time value from the given function applied to a record flow.
static ScalarValuedFunction	DateTime.getValue(ScalarValuedFunction expr, DateTime.DateTimeValue valueType, ZoneId zoneId)	Create a function that will extract the wanted date or time value from the given function applied to a record flow.
static ScalarValuedFunction	DateTime.getValue(ScalarValuedFunction expr, DateTime.DateTimeValue valueType, ZoneId zoneId)	Create a function that will extract the wanted date or time value from the given function applied to a record flow.
static ScalarValuedFunction	DateTime.getValue(ScalarValuedFunction expr, DateTime.DateTimeValue valueType, ZoneId zoneId)	Create a function that will extract the wanted date or time value from the given function applied to a record flow.
static ScalarValuedFunction	Math.hypot(ScalarValuedFunction x, ScalarValuedFunction y)	Returns sqrt(x2 + y2) without intermediate overflow or underflow.
static ScalarValuedFunction	Math.hypot(ScalarValuedFunction x, ScalarValuedFunction y)	Returns sqrt(x2 + y2) without intermediate overflow or underflow.
static ScalarValuedFunction	Math.IEEEremainder(ScalarValuedFunction dividend, ScalarValuedFunction divisor)	Returns the IEEE 754 standard remainder.
static ScalarValuedFunction	Math.IEEEremainder(ScalarValuedFunction dividend, ScalarValuedFunction divisor)	Returns the IEEE 754 standard remainder.
static ScalarValuedFunction	Conditionals.ifNull(ScalarValuedFunction value, ScalarValuedFunction replacement)	Build a conditional expression which evaluates to the value of the specified expression, if non-null.
static ScalarValuedFunction	Conditionals.ifNull(ScalarValuedFunction value, ScalarValuedFunction replacement)	Build a conditional expression which evaluates to the value of the specified expression, if non-null.
static ScalarValuedFunction	Conditionals.ifThenElse(ScalarValuedFunction predicate, ScalarValuedFunction trueValue, ScalarValuedFunction falseValue)	Builds a conditional expression which evaluates to one of two subexpressions based on the result of the given predicate.
static ScalarValuedFunction	Conditionals.ifThenElse(ScalarValuedFunction predicate, ScalarValuedFunction trueValue, ScalarValuedFunction falseValue)	Builds a conditional expression which evaluates to one of two subexpressions based on the result of the given predicate.
static ScalarValuedFunction	Conditionals.ifThenElse(ScalarValuedFunction predicate, ScalarValuedFunction trueValue, ScalarValuedFunction falseValue)	Builds a conditional expression which evaluates to one of two subexpressions based on the result of the given predicate.
static ScalarValuedFunction	Strings.indexOf(ScalarValuedFunction value, ScalarValuedFunction string)	Builds a function returning the first index of the specified string that occurs in the string value to which the specified expression evaluates.
static ScalarValuedFunction	Strings.indexOf(ScalarValuedFunction value, ScalarValuedFunction string)	Builds a function returning the first index of the specified string that occurs in the string value to which the specified expression evaluates.
static ScalarValuedFunction	Strings.lastIndexOf(ScalarValuedFunction value, ScalarValuedFunction string)	Builds a function returning the last index of the specified string that occurs in the string value to which the specified expression evaluates.
static ScalarValuedFunction	Strings.lastIndexOf(ScalarValuedFunction value, ScalarValuedFunction string)	Builds a function returning the last index of the specified string that occurs in the string value to which the specified expression evaluates.
static ScalarValuedFunction	Strings.length(ScalarValuedFunction expr)	Builds a function returning the length of the string value to which the given expression evaluates.
static ScalarValuedFunction	ListFunctions.listConcat(ScalarValuedFunction leftExpr, ScalarValuedFunction rightExpr)	Builds an expression concatenating the values of the two specified subexpressions.
static ScalarValuedFunction	ListFunctions.listConcat(ScalarValuedFunction leftExpr, ScalarValuedFunction rightExpr)	Builds an expression concatenating the values of the two specified subexpressions.
static ScalarValuedFunction	ListFunctions.listContains(ScalarValuedFunction leftExpr, ScalarValuedFunction rightExpr)	Builds an expression to check if an expression contains a value specified by a ScalarValuedFunction.
static ScalarValuedFunction	ListFunctions.listContains(ScalarValuedFunction leftExpr, ScalarValuedFunction rightExpr)	Builds an expression to check if an expression contains a value specified by a ScalarValuedFunction.
static ScalarValuedFunction	ListFunctions.listContainsAll(ScalarValuedFunction leftExpr, ScalarValuedFunction rightExpr)	Builds an expression to check if an expression contains a value specified by a ScalarValuedFunction.
static ScalarValuedFunction	ListFunctions.listContainsAll(ScalarValuedFunction leftExpr, ScalarValuedFunction rightExpr)	Builds an expression to check if an expression contains a value specified by a ScalarValuedFunction.
static ScalarValuedFunction	ListFunctions.listDistinct(ScalarValuedFunction expr)	Builds an expression to get distinct set of elements from a ScalarValuedFunction.
static ScalarValuedFunction	ListFunctions.listGet(ScalarValuedFunction leftExpr, ScalarValuedFunction rightExpr)	Builds an expression to get the value at a particular index from specified expression.
static ScalarValuedFunction	ListFunctions.listGet(ScalarValuedFunction leftExpr, ScalarValuedFunction rightExpr)	Builds an expression to get the value at a particular index from specified expression.
static ScalarValuedFunction	ListFunctions.listReverse(ScalarValuedFunction expr)	Builds an expression to reverse the order of the elements in the specified expression.
static ScalarValuedFunction	ListFunctions.listSize(ScalarValuedFunction expr)	Builds an expression to get the number of elements in specified ScalarValuedFunction expression.
static ScalarValuedFunction	ListFunctions.listSort(ScalarValuedFunction leftExpr, ScalarValuedFunction rightExpr)	Builds an expression to sort elements of a ScalarValuedFunction as specified by the other.
static ScalarValuedFunction	ListFunctions.listSort(ScalarValuedFunction leftExpr, ScalarValuedFunction rightExpr)	Builds an expression to sort elements of a ScalarValuedFunction as specified by the other.
static ScalarValuedFunction	ListFunctions.listToString(ScalarValuedFunction expr)	Builds an expression to get the string representation of a ScalarValuedFunction.
static ScalarValuedFunction	Math.log(ScalarValuedFunction expr)	Returns the natural logarithm of the given expression.
static ScalarValuedFunction	Math.log10(ScalarValuedFunction expr)	Returns the base 10 logarithm of the given expression.
static ScalarValuedFunction	Math.log1p(ScalarValuedFunction expr)	Returns the natural logarithm of 1 plus the given expression.
static ScalarValuedFunction	MapFunctions.mapGet(ScalarValuedFunction leftExpr, ScalarValuedFunction rightExpr)	Builds an expression to get the value mapped to a key from specified ScalarValuedFunction.
static ScalarValuedFunction	MapFunctions.mapGet(ScalarValuedFunction leftExpr, ScalarValuedFunction rightExpr)	Builds an expression to get the value mapped to a key from specified ScalarValuedFunction.
static ScalarValuedFunction	MapFunctions.mapSize(ScalarValuedFunction expr)	Builds an expression to get the number of kay-value mappings in ScalarValuedFunction expression.
static ScalarValuedFunction	MapFunctions.mapToString(ScalarValuedFunction expr)	Builds an expression to get the string representation of a ScalarValuedFunction.
static ScalarValuedFunction	Predicates.matches(ScalarValuedFunction expr, String pattern)	Builds a record predicate which tests whether the value of an expression matches a specified regular expression.
static ScalarValuedFunction	Predicates.matches(ScalarValuedFunction expr, String pattern)	Builds a record predicate which tests whether the value of an expression matches a specified regular expression.
static ScalarValuedFunction	Strings.mid(ScalarValuedFunction expr, ScalarValuedFunction index, ScalarValuedFunction length)	Builds a function returning a substring of the string value to which the specified expression evaluates.
static ScalarValuedFunction	Strings.mid(ScalarValuedFunction expr, ScalarValuedFunction index, ScalarValuedFunction length)	Builds a function returning a substring of the string value to which the specified expression evaluates.
static ScalarValuedFunction	Strings.mid(ScalarValuedFunction expr, ScalarValuedFunction index, ScalarValuedFunction length)	Builds a function returning a substring of the string value to which the specified expression evaluates.
static ScalarValuedFunction	Math.nextAfter(ScalarValuedFunction start, ScalarValuedFunction direction)	Returns the floating point number adjacent to the first argument in the direction of the second argument.
static ScalarValuedFunction	Math.nextAfter(ScalarValuedFunction start, ScalarValuedFunction direction)	Returns the floating point number adjacent to the first argument in the direction of the second argument.
static ScalarValuedFunction	Math.nextUp(ScalarValuedFunction start)	Returns the floating point number adjacent to the argument in the direction of positive infinity.
static ScalarValuedFunction	ConstantReference.nullValue(ScalarValuedFunction expr)	Deprecated. Untyped null tokens are now supported.
static ScalarValuedFunction	Math.pow(ScalarValuedFunction base, ScalarValuedFunction exponent)	Returns base raised to the exponent power.
static ScalarValuedFunction	Math.pow(ScalarValuedFunction base, ScalarValuedFunction exponent)	Returns base raised to the exponent power.
static ScalarValuedFunction	Math.precision(ScalarValuedFunction expr)	Return the precision of the given expression.
static ScalarValuedFunction	Strings.replaceAll(ScalarValuedFunction value, String pattern, ScalarValuedFunction replacement)	Builds a function replacing all occurrences of a given pattern in the result of a specified expression.
static ScalarValuedFunction	Strings.replaceAll(ScalarValuedFunction value, String pattern, ScalarValuedFunction replacement)	Builds a function replacing all occurrences of a given pattern in the result of a specified expression.
static ScalarValuedFunction	Strings.replaceAll(ScalarValuedFunction value, String pattern, ScalarValuedFunction replacement)	Builds a function replacing all occurrences of a given pattern in the result of a specified expression.
static ScalarValuedFunction	Strings.replaceFirst(ScalarValuedFunction value, String pattern, ScalarValuedFunction replacement)	Builds a function replacing the first occurrence of a given pattern in the result of a specified expression.
static ScalarValuedFunction	Strings.replaceFirst(ScalarValuedFunction value, String pattern, ScalarValuedFunction replacement)	Builds a function replacing the first occurrence of a given pattern in the result of a specified expression.
static ScalarValuedFunction	Strings.replaceFirst(ScalarValuedFunction value, String pattern, ScalarValuedFunction replacement)	Builds a function replacing the first occurrence of a given pattern in the result of a specified expression.
static ScalarValuedFunction	Math.rint(ScalarValuedFunction expr)	Returns the double value closest to the given expression and equal to a mathematical integer.
static ScalarValuedFunction	Math.round(ScalarValuedFunction expr)	Returns the expression rounded to the nearest whole number.
static ScalarValuedFunction	Math.scalb(ScalarValuedFunction expr, ScalarValuedFunction scaleFactor)	Returns expr × 2scaleFactor rounded as if performed by a single correctly rounded floating-point multiply to a member of the double or float value set.
static ScalarValuedFunction	Math.scalb(ScalarValuedFunction expr, ScalarValuedFunction scaleFactor)	Returns expr × 2scaleFactor rounded as if performed by a single correctly rounded floating-point multiply to a member of the double or float value set.
static ScalarValuedFunction	Math.scale(ScalarValuedFunction expr)	Return the scale of the given expression.
static ScalarValuedFunction	Arithmetic.scaledDiv(ScalarValuedFunction leftExpr, ScalarValuedFunction rightExpr, int scale)	Builds an expression dividing the values of the two specified subexpressions to the specified scale.
static ScalarValuedFunction	Arithmetic.scaledDiv(ScalarValuedFunction leftExpr, ScalarValuedFunction rightExpr, int scale)	Builds an expression dividing the values of the two specified subexpressions to the specified scale.
static ScalarValuedFunction	Arithmetic.scaledDiv(ScalarValuedFunction leftExpr, ScalarValuedFunction rightExpr, int scale)	Builds an expression dividing the values of the two specified subexpressions to the specified scale.
static ScalarValuedFunction	Math.signum(ScalarValuedFunction expr)	Returns the signum function of the expression: 0 if the expression is zero, 1 if it is greater than zero, or -1 if it is less than 0.
static ScalarValuedFunction	Math.sin(ScalarValuedFunction expr)	Returns the sine of the given expression using radians.
static ScalarValuedFunction	Math.sinh(ScalarValuedFunction expr)	Returns the hyperbolic sine of the given expression using radians.
static ScalarValuedFunction	Math.sqrt(ScalarValuedFunction expr)	Returns the square root of the given expression.
static ScalarValuedFunction	ListFunctions.subList(ScalarValuedFunction expr, ScalarValuedFunction fromIndexExpr, ScalarValuedFunction toIndexExpr)	Builds an expression finding a view of the portion of a ScalarValuedFunction between the specified fromIndex, inclusive, and toIndex, exclusive.
static ScalarValuedFunction	ListFunctions.subList(ScalarValuedFunction expr, ScalarValuedFunction fromIndexExpr, ScalarValuedFunction toIndexExpr)	Builds an expression finding a view of the portion of a ScalarValuedFunction between the specified fromIndex, inclusive, and toIndex, exclusive.
static ScalarValuedFunction	ListFunctions.subList(ScalarValuedFunction expr, ScalarValuedFunction fromIndexExpr, ScalarValuedFunction toIndexExpr)	Builds an expression finding a view of the portion of a ScalarValuedFunction between the specified fromIndex, inclusive, and toIndex, exclusive.
static ScalarValuedFunction	Strings.substr(ScalarValuedFunction expr, ScalarValuedFunction start)	Builds a function returning a substring of the string value to which the specified expression evaluates, starting at a specified index.
static ScalarValuedFunction	Strings.substr(ScalarValuedFunction expr, ScalarValuedFunction start)	Builds a function returning a substring of the string value to which the specified expression evaluates, starting at a specified index.
static ScalarValuedFunction	Strings.substr(ScalarValuedFunction expr, ScalarValuedFunction start, ScalarValuedFunction end)	Builds a function returning a substring of the string value to which the specified expression evaluates, between specified indexes.
static ScalarValuedFunction	Strings.substr(ScalarValuedFunction expr, ScalarValuedFunction start, ScalarValuedFunction end)	Builds a function returning a substring of the string value to which the specified expression evaluates, between specified indexes.
static ScalarValuedFunction	Strings.substr(ScalarValuedFunction expr, ScalarValuedFunction start, ScalarValuedFunction end)	Builds a function returning a substring of the string value to which the specified expression evaluates, between specified indexes.
static ScalarValuedFunction	DateTime.subtractTime(ScalarValuedFunction time, ScalarValuedFunction delta, DateTime.Granularity granularity)	Subtracts a time period from the specified date/time value.
static ScalarValuedFunction	DateTime.subtractTime(ScalarValuedFunction time, ScalarValuedFunction delta, DateTime.Granularity granularity)	Subtracts a time period from the specified date/time value.
static ScalarValuedFunction	DateTime.subtractTime(ScalarValuedFunction time, ScalarValuedFunction delta, DateTime.Granularity granularity)	Subtracts a time period from the specified date/time value.
static ScalarValuedFunction	DateTime.subtractTime(ScalarValuedFunction time, ScalarValuedFunction delta, DateTime.Granularity granularity, ZoneId zoneId)	Subtracts a time period from the specified date/time value.
static ScalarValuedFunction	DateTime.subtractTime(ScalarValuedFunction time, ScalarValuedFunction delta, DateTime.Granularity granularity, ZoneId zoneId)	Subtracts a time period from the specified date/time value.
static ScalarValuedFunction	DateTime.subtractTime(ScalarValuedFunction time, ScalarValuedFunction delta, DateTime.Granularity granularity, ZoneId zoneId)	Subtracts a time period from the specified date/time value.
static ScalarValuedFunction	DateTime.subtractTime(ScalarValuedFunction time, ScalarValuedFunction delta, DateTime.Granularity granularity, ZoneId zoneId)	Subtracts a time period from the specified date/time value.
static ScalarValuedFunction	Math.tan(ScalarValuedFunction expr)	Returns the tangent of the given expression using radians.
static ScalarValuedFunction	Math.tanh(ScalarValuedFunction expr)	Returns the hyperbolic tangent of the given expression using radians.
static ScalarValuedFunction	DateTime.timeDiff(ScalarValuedFunction startValue, ScalarValuedFunction endValue, DateTime.Granularity granularity)	Builds an expression measuring the time interval between two date/time expressions using a specified time unit.
static ScalarValuedFunction	DateTime.timeDiff(ScalarValuedFunction startValue, ScalarValuedFunction endValue, DateTime.Granularity granularity)	Builds an expression measuring the time interval between two date/time expressions using a specified time unit.
static ScalarValuedFunction	DateTime.timeDiff(ScalarValuedFunction startValue, ScalarValuedFunction endValue, DateTime.Granularity granularity)	Builds an expression measuring the time interval between two date/time expressions using a specified time unit.
static ScalarValuedFunction	DateTime.timeDiff(ScalarValuedFunction startValue, ScalarValuedFunction endValue, DateTime.Granularity granularity, int scale)	Builds an expression measuring the time interval between two date/time expressions using a specified time unit and scale.
static ScalarValuedFunction	DateTime.timeDiff(ScalarValuedFunction startValue, ScalarValuedFunction endValue, DateTime.Granularity granularity, int scale)	Builds an expression measuring the time interval between two date/time expressions using a specified time unit and scale.
static ScalarValuedFunction	DateTime.timeDiff(ScalarValuedFunction startValue, ScalarValuedFunction endValue, DateTime.Granularity granularity, int scale)	Builds an expression measuring the time interval between two date/time expressions using a specified time unit and scale.
static ScalarValuedFunction	DateTime.timeDiff(ScalarValuedFunction startValue, ScalarValuedFunction endValue, DateTime.Granularity granularity, int scale)	Builds an expression measuring the time interval between two date/time expressions using a specified time unit and scale.
static ScalarValuedFunction	Conversions.toBinary(ScalarValuedFunction expr)	Convert a string typed expression into a binary type.
static ScalarValuedFunction	Conversions.toBoolean(ScalarValuedFunction expr, String truth, String falsity)	Convert a string typed expression into a boolean type.
static ScalarValuedFunction	Conversions.toBoolean(ScalarValuedFunction expr, String truth, String falsity)	Convert a string typed expression into a boolean type.
static ScalarValuedFunction	Conversions.toBoolean(ScalarValuedFunction expr, String truth, String falsity)	Convert a string typed expression into a boolean type.
static ScalarValuedFunction	Conversions.toChar(ScalarValuedFunction expr)	Convert a string typed expression into a char type.
static ScalarValuedFunction	Conversions.toDate(ScalarValuedFunction expr)	Convert a string typed expression into a date type.
static ScalarValuedFunction	Conversions.toDate(ScalarValuedFunction expr, DateTimeFormatting format)	Convert a string typed expression into a date type using the given format.
static ScalarValuedFunction	Conversions.toDate(ScalarValuedFunction expr, DateTimeFormatting format)	Convert a string typed expression into a date type using the given format.
static ScalarValuedFunction	Math.toDegrees(ScalarValuedFunction expr)	Returns the radian expression in degrees.
static ScalarValuedFunction	Conversions.toDouble(ScalarValuedFunction expr)	Convert a string typed expression into a double type.
static ScalarValuedFunction	Conversions.toDouble(ScalarValuedFunction expr, NumberFormat format)	Convert a string typed expression into a double type using the given format.
static ScalarValuedFunction	Conversions.toDouble(ScalarValuedFunction expr, NumberFormat format)	Convert a string typed expression into a double type using the given format.
static ScalarValuedFunction	Conversions.toFloat(ScalarValuedFunction expr)	Convert a string typed expression into a float type.
static ScalarValuedFunction	Conversions.toFloat(ScalarValuedFunction expr, NumberFormat format)	Convert a string typed expression into a float type using the given format.
static ScalarValuedFunction	Conversions.toFloat(ScalarValuedFunction expr, NumberFormat format)	Convert a string typed expression into a float type using the given format.
static ScalarValuedFunction	Conversions.toInt(ScalarValuedFunction expr)	Convert a string typed expression into a integer type.
static ScalarValuedFunction	Conversions.toInt(ScalarValuedFunction expr, NumberFormat format)	Convert a string typed expression into a integer type using the given format.
static ScalarValuedFunction	Conversions.toInt(ScalarValuedFunction expr, NumberFormat format)	Convert a string typed expression into a integer type using the given format.
static ScalarValuedFunction	Conversions.toLong(ScalarValuedFunction expr)	Convert a string typed expression into a long type.
static ScalarValuedFunction	Conversions.toLong(ScalarValuedFunction expr, NumberFormat format)	Convert a string typed expression into a long type using the given format.
static ScalarValuedFunction	Conversions.toLong(ScalarValuedFunction expr, NumberFormat format)	Convert a string typed expression into a long type using the given format.
static ScalarValuedFunction	Strings.toLowerCase(ScalarValuedFunction expr)	Builds a function returning the lower case string value of the string to which the given expression evaluates.
static ScalarValuedFunction	DateTime.toMilliseconds(ScalarValuedFunction expr)	Converts the value of a date/time expression into the number of milliseconds since the epoch (January 1, 1970, 00:00:00 GMT).
static ScalarValuedFunction	Conversions.toMoney(ScalarValuedFunction expr)	Convert a string typed expression into a money type.
static ScalarValuedFunction	Conversions.toMoney(ScalarValuedFunction expr, NumberFormat format)	Convert a string typed expression into a money type using the given format.
static ScalarValuedFunction	Conversions.toMoney(ScalarValuedFunction expr, NumberFormat format)	Convert a string typed expression into a money type using the given format.
static ScalarValuedFunction	Conversions.toNumeric(ScalarValuedFunction expr)	Convert a string typed expression into a numeric type.
static ScalarValuedFunction	Conversions.toNumeric(ScalarValuedFunction expr, NumberFormat format)	Convert a string typed expression into a numeric type using the given format.
static ScalarValuedFunction	Conversions.toNumeric(ScalarValuedFunction expr, NumberFormat format)	Convert a string typed expression into a numeric type using the given format.
static ScalarValuedFunction	Math.toRadians(ScalarValuedFunction expr)	Returns the degree expression in radians.
static ScalarValuedFunction	Conversions.toString(ScalarValuedFunction expr)	Convert the value of an expression into a string value.
static ScalarValuedFunction	Conversions.toText(ScalarValuedFunction expr, String format)	Convert the value of an expression into text using the given format.
static ScalarValuedFunction	Conversions.toText(ScalarValuedFunction expr, String format)	Convert the value of an expression into text using the given format.
static ScalarValuedFunction	Conversions.toTime(ScalarValuedFunction expr)	Convert a string typed expression into a time type.
static ScalarValuedFunction	Conversions.toTime(ScalarValuedFunction expr, DateTimeFormatting format)	Convert a string typed expression into a time type using the given format.
static ScalarValuedFunction	Conversions.toTime(ScalarValuedFunction expr, DateTimeFormatting format)	Convert a string typed expression into a time type using the given format.
static ScalarValuedFunction	Conversions.toTimestamp(ScalarValuedFunction expr)	Convert a string typed expression into a timestamp type.
static ScalarValuedFunction	Conversions.toTimestamp(ScalarValuedFunction expr, DateTimeFormatting format)	Convert a string typed expression into a timestamp type using the given format.
static ScalarValuedFunction	Conversions.toTimestamp(ScalarValuedFunction expr, DateTimeFormatting format)	Convert a string typed expression into a timestamp type using the given format.
static ScalarValuedFunction	Strings.toUpperCase(ScalarValuedFunction expr)	Builds a function returning the upper case string value of the string to which the given expression evaluates.
static ScalarValuedFunction	Strings.trim(ScalarValuedFunction expr)	Builds a function returning the whitespace trimmed string value of the string to which the given expression evaluates.
static ScalarValuedFunction	Math.ulp(ScalarValuedFunction expr)	Returns the size of an ulp of the expression.
static ScalarValuedFunction	DateTime.useDefaultTimeZone(ScalarValuedFunction time)	Adjusts a time stamp value to use the time zone of the local machine.
static ScalarValuedFunction	DateTime.useTimeZone(ScalarValuedFunction time, ZoneId zoneId)	Adjusts a time stamp value to use the specified time zone.
static ScalarValuedFunction	DateTime.useTimeZone(ScalarValuedFunction time, ZoneId zoneId)	Adjusts a time stamp value to use the specified time zone.

Uses of FunctionArgument in com.pervasive.datarush.matching.functions

Method parameters in com.pervasive.datarush.matching.functions with annotations of type FunctionArgument

Modifier and Type	Method	Description
static ScalarValuedFunction	StringEncodings.caverphone(ScalarValuedFunction value)	Builds a function phonetically encoding the string value to which the specified expression evaluates using the Caverphone algorithm.
static ScalarValuedFunction	Similarity.contains(ScalarValuedFunction left, ScalarValuedFunction right)	Builds a function testing whether either of the specified string valued expressions contains the other.
static ScalarValuedFunction	Similarity.contains(ScalarValuedFunction left, ScalarValuedFunction right)	Builds a function testing whether either of the specified string valued expressions contains the other.
static ScalarValuedFunction	Similarity.damerauLevenshtein(ScalarValuedFunction left, ScalarValuedFunction right)	Builds a function computing the Damerau-Levenshtein distance between the specified string valued expressions.
static ScalarValuedFunction	Similarity.damerauLevenshtein(ScalarValuedFunction left, ScalarValuedFunction right)	Builds a function computing the Damerau-Levenshtein distance between the specified string valued expressions.
static ScalarValuedFunction	StringEncodings.doubleMetaphone(ScalarValuedFunction value)	Builds a function phonetically encoding the string value to which the specified expression evaluates using the Double Metaphone algorithm.
static ScalarValuedFunction	Similarity.exact(ScalarValuedFunction left, ScalarValuedFunction right)	Builds a function testing whether the specified string valued expressions are equal.
static ScalarValuedFunction	Similarity.exact(ScalarValuedFunction left, ScalarValuedFunction right)	Builds a function testing whether the specified string valued expressions are equal.
static ScalarValuedFunction	Similarity.jaro(ScalarValuedFunction left, ScalarValuedFunction right)	Builds a function computing the Jaro distance between the specified string valued expressions.
static ScalarValuedFunction	Similarity.jaro(ScalarValuedFunction left, ScalarValuedFunction right)	Builds a function computing the Jaro distance between the specified string valued expressions.
static ScalarValuedFunction	Similarity.jaroWinkler(ScalarValuedFunction left, ScalarValuedFunction right, int prefixLen, float scaling)	Builds a function computing the Jaro-Winkler distance between the specified string valued expressions.
static ScalarValuedFunction	Similarity.jaroWinkler(ScalarValuedFunction left, ScalarValuedFunction right, int prefixLen, float scaling)	Builds a function computing the Jaro-Winkler distance between the specified string valued expressions.
static ScalarValuedFunction	Similarity.jaroWinkler(ScalarValuedFunction left, ScalarValuedFunction right, int prefixLen, float scaling)	Builds a function computing the Jaro-Winkler distance between the specified string valued expressions.
static ScalarValuedFunction	Similarity.jaroWinkler(ScalarValuedFunction left, ScalarValuedFunction right, int prefixLen, float scaling)	Builds a function computing the Jaro-Winkler distance between the specified string valued expressions.
static ScalarValuedFunction	Similarity.levenshtein(ScalarValuedFunction left, ScalarValuedFunction right)	Builds a function computing the Levenshtein distance between the specified string valued expressions.
static ScalarValuedFunction	Similarity.levenshtein(ScalarValuedFunction left, ScalarValuedFunction right)	Builds a function computing the Levenshtein distance between the specified string valued expressions.
static ScalarValuedFunction	StringEncodings.metaphone(ScalarValuedFunction value)	Builds a function phonetically encoding the string value to which the specified expression evaluates using the Metaphone algorithm.
static ScalarValuedFunction	Similarity.positionalQgram(ScalarValuedFunction left, ScalarValuedFunction right, int q, int maxDist)	Builds a function computing the percentage of q-grams in common between the specified string valued expressions.
static ScalarValuedFunction	Similarity.positionalQgram(ScalarValuedFunction left, ScalarValuedFunction right, int q, int maxDist)	Builds a function computing the percentage of q-grams in common between the specified string valued expressions.
static ScalarValuedFunction	Similarity.positionalQgram(ScalarValuedFunction left, ScalarValuedFunction right, int q, int maxDist)	Builds a function computing the percentage of q-grams in common between the specified string valued expressions.
static ScalarValuedFunction	Similarity.positionalQgram(ScalarValuedFunction left, ScalarValuedFunction right, int q, int maxDist)	Builds a function computing the percentage of q-grams in common between the specified string valued expressions.
static ScalarValuedFunction	Similarity.proximity(ScalarValuedFunction left, ScalarValuedFunction right)	Builds a function computing an adjusted quotient of the numeric values of the specified fields.
static ScalarValuedFunction	Similarity.proximity(ScalarValuedFunction left, ScalarValuedFunction right)	Builds a function computing an adjusted quotient of the numeric values of the specified fields.
static ScalarValuedFunction	Similarity.qgram(ScalarValuedFunction left, ScalarValuedFunction right, int q)	Builds a function computing the percentage of q-grams in common between the specified string valued expressions.
static ScalarValuedFunction	Similarity.qgram(ScalarValuedFunction left, ScalarValuedFunction right, int q)	Builds a function computing the percentage of q-grams in common between the specified string valued expressions.
static ScalarValuedFunction	Similarity.qgram(ScalarValuedFunction left, ScalarValuedFunction right, int q)	Builds a function computing the percentage of q-grams in common between the specified string valued expressions.
static ScalarValuedFunction	StringEncodings.refinedSoundex(ScalarValuedFunction value)	Builds a function phonetically encoding the string value to which the specified expression evaluates using the refined Soundex algorithm.
static ScalarValuedFunction	Similarity.shorthand(ScalarValuedFunction left, ScalarValuedFunction right)	Builds a function testing shorthand equivalence between the specified string valued expressions.
static ScalarValuedFunction	Similarity.shorthand(ScalarValuedFunction left, ScalarValuedFunction right)	Builds a function testing shorthand equivalence between the specified string valued expressions.
static ScalarValuedFunction	StringEncodings.soundex(ScalarValuedFunction value)	Builds a function phonetically encoding the string value to which the specified expression evaluates using the Soundex algorithm.

Uses of FunctionArgument in com.pervasive.datarush.operators.group

Method parameters in com.pervasive.datarush.operators.group with annotations of type FunctionArgument

Modifier and Type	Method	Description
static Aggregation	Aggregation.avg(ScalarValuedFunction input)	Create an average value aggregation for the given input.
static Aggregation	Aggregation.corr(ScalarValuedFunction input1, ScalarValuedFunction input2)	Create a correlation aggregation for the given inputs.
static Aggregation	Aggregation.corr(ScalarValuedFunction input1, ScalarValuedFunction input2)	Create a correlation aggregation for the given inputs.
static Aggregation	Aggregation.count(ScalarValuedFunction input)	Create a value count aggregation for the given input.
static Aggregation	Aggregation.covar(ScalarValuedFunction input1, ScalarValuedFunction input2)	Create a covariance aggregation for the given inputs.
static Aggregation	Aggregation.covar(ScalarValuedFunction input1, ScalarValuedFunction input2)	Create a covariance aggregation for the given inputs.
static Aggregation	Aggregation.covar(ScalarValuedFunction input1, ScalarValuedFunction input2, boolean sample)	Create a covariance aggregation for the given inputs.
static Aggregation	Aggregation.covar(ScalarValuedFunction input1, ScalarValuedFunction input2, boolean sample)	Create a covariance aggregation for the given inputs.
static Aggregation	Aggregation.covar(ScalarValuedFunction input1, ScalarValuedFunction input2, boolean sample)	Create a covariance aggregation for the given inputs.
static Aggregation	Aggregation.geoAvg(ScalarValuedFunction input)	Create a geometric average value aggregation for the given input.
static Aggregation	Aggregation.harmAvg(ScalarValuedFunction input)	Create an harmonic average value aggregation for the given input.
static Aggregation	Aggregation.kurtosis(ScalarValuedFunction input)	Create a kurtosis aggregation for the given input.
static Aggregation	Aggregation.kurtosis(ScalarValuedFunction input, boolean sample)	Create a kurtosis aggregation for the given input.
static Aggregation	Aggregation.kurtosis(ScalarValuedFunction input, boolean sample)	Create a kurtosis aggregation for the given input.
static Aggregation	Aggregation.max(ScalarValuedFunction input)	Create a maximum value aggregation for the given input.
static Aggregation	Aggregation.min(ScalarValuedFunction input)	Create a minimum value aggregation for the given input.
static Aggregation	Aggregation.moment(ScalarValuedFunction input, int k)	Create a central moment aggregation for the given input.
static Aggregation	Aggregation.moment(ScalarValuedFunction input, int k)	Create a central moment aggregation for the given input.
static Aggregation	Aggregation.skewness(ScalarValuedFunction input)	Create a skewness aggregation for the given input.
static Aggregation	Aggregation.skewness(ScalarValuedFunction input, boolean sample)	Create a skewness aggregation for the given input.
static Aggregation	Aggregation.skewness(ScalarValuedFunction input, boolean sample)	Create a skewness aggregation for the given input.
static Aggregation	Aggregation.stddev(ScalarValuedFunction input)	Create a standard deviation aggregation for the given input.
static Aggregation	Aggregation.stddev(ScalarValuedFunction input, boolean sample)	Create a standard deviation aggregation for the given input.
static Aggregation	Aggregation.stddev(ScalarValuedFunction input, boolean sample)	Create a standard deviation aggregation for the given input.
static Aggregation	Aggregation.sum(ScalarValuedFunction input)	Create a value summation aggregation for the given input.
static Aggregation	Aggregation.sumSquares(ScalarValuedFunction input)	Create a sum-squares aggregation for the given input.
static Aggregation	Aggregation.var(ScalarValuedFunction input)	Create a variance aggregation for the given input.
static Aggregation	Aggregation.var(ScalarValuedFunction input, boolean sample)	Create a variance aggregation for the given input.
static Aggregation	Aggregation.var(ScalarValuedFunction input, boolean sample)	Create a variance aggregation for the given input.