com.api.jsonata4java.expressions.utils

Class FunctionUtils

java.lang.Object

com.api.jsonata4java.expressions.utils.FunctionUtils

public class FunctionUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
FunctionUtils()

Method Summary

Modifier and Type	Method and Description
static MappingExpressionParser.ExprValuesContext	addArrayExprVarContext(MappingExpressionParser.ExprContext ctx, MappingExpressionParser.ExprValuesContext evc, com.fasterxml.jackson.databind.node.ArrayNode arrayNode) Extends a supplied MappingExpressionParser.ExprValuesContext using the supplied context and array node content
static MappingExpressionParser.ExprValuesContext	addIndexExprVarContext(MappingExpressionParser.ExprContext ctx, MappingExpressionParser.ExprValuesContext evc, Integer index) Extends an MappingExpressionParser.ExprValuesContext using the context containing the supplied index value
static MappingExpressionParser.ExprValuesContext	addObjectExprVarContext(MappingExpressionParser.ExprContext ctx, MappingExpressionParser.ExprValuesContext evc, com.fasterxml.jackson.databind.node.ObjectNode object) Extends an MappingExpressionParser.ExprValuesContext using the context containing the supplied object value
static MappingExpressionParser.ExprValuesContext	addStringExprVarContext(MappingExpressionParser.ExprContext ctx, MappingExpressionParser.ExprValuesContext evc, String string) Extends an MappingExpressionParser.ExprValuesContext using the context containing the supplied string value
static boolean	checkArgument(ExpressionsVisitor exprVisitor, MappingExpressionParser.ExprContext exprCtx, String signature) Tests whether the supplied exprCtx meets the signature expectations.
static MappingExpressionParser.ExprValuesContext	fillExprVarContext(int fctVarCount, MappingExpressionParser.ExprContext ctx, com.fasterxml.jackson.databind.JsonNode... elements) Creates an MappingExpressionParser.ExprValuesContext containing a parenthesized comma separated variable list of the supplied elements
static MappingExpressionParser.ExprValuesContext	fillExprVarContext(MappingExpressionParser.ExprContext ctx, String key, com.fasterxml.jackson.databind.JsonNode value) Sets up the MappingExpressionParser.ExprValuesContext variables for the function($v,$k) signature used in each call for pairs of values and keys
static MappingExpressionParser.Array_constructorContext	getArrayConstructorContext(MappingExpressionParser.ExprContext ctx, com.fasterxml.jackson.databind.node.ArrayNode array) Creates an MappingExpressionParser.Array_constructorContext from the supplied context and array
static com.fasterxml.jackson.databind.JsonNode	getContextVariable(ExpressionsVisitor exprVisitor) Retrieve the latest context variable from the ExpressionsVisitor stack, allowing for a null to be returned (in lieu of a NullNode)
static com.fasterxml.jackson.databind.JsonNode	getContextVariableOrNullNode(ExpressionsVisitor exprVisitor) Retrieve the latest context variable from the ExpressionsVisitor stack
static MappingExpressionParser.Object_constructorContext	getObjectConstructorContext(MappingExpressionParser.ExprContext ctx, com.fasterxml.jackson.databind.node.ObjectNode object) Creates an MappingExpressionParser.Object_constructorContext from the supplied context and object
static com.fasterxml.jackson.databind.JsonNode	getValuesListExpression(ExpressionsVisitor exprVisitor, MappingExpressionParser.Function_callContext ctx, int index) Gets the expression at the supplied index from the context's MappingExpressionParser.ExprValuesContext MappingExpressionParser.ExprListContext, preserving the null value (or returning null if the index is invalid)
static com.fasterxml.jackson.databind.JsonNode	getValuesListExpressionOrNullNode(ExpressionsVisitor exprVisitor, MappingExpressionParser.Function_callContext ctx, int index) Gets the expression at the supplied index from the context's {link ExprValuesContext} {link ExprListContext]
static com.fasterxml.jackson.databind.JsonNode	processFctCallVariables(ExpressionsVisitor exprVisitor, Function function, org.antlr.v4.runtime.tree.TerminalNode varid, MappingExpressionParser.Function_callContext ctx, com.fasterxml.jackson.databind.JsonNode value, String key, com.fasterxml.jackson.databind.node.ObjectNode object) Creates an MappingExpressionParser.ExprListContext containing the parenthesized comma separated variable list of JsonNode elements, sets it in the supplied context (ctx) and then executes the function to return its result.
static com.fasterxml.jackson.databind.JsonNode	processVariablesCallFunction(ExpressionsVisitor exprVisitor, Function function, org.antlr.v4.runtime.tree.TerminalNode varid, MappingExpressionParser.Function_callContext ctx, com.fasterxml.jackson.databind.JsonNode... elements) Creates an MappingExpressionParser.ExprListContext containing the parenthesized comma separated variable list of JsonNode elements, sets it in the supplied context (ctx) and then executes the function to return its result.
static boolean	useContextVariable(Function fct, MappingExpressionParser.Function_callContext ctx, String signature) Determine if the function should use the context variable as its first parameter
static void	validateArguments(String possibleException, ExpressionsVisitor exprVisitor, MappingExpressionParser.Function_callContext ctx, int index, String signature) Checks the expression at the supplied index from the context's MappingExpressionParser.ExprValuesContext MappingExpressionParser.ExprListContext, preserving the null value (or returning null if the index is invalid) to determine if the arguments are valid according to the supplied signature

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionUtils

public FunctionUtils()

Method Detail

addArrayExprVarContext

public static MappingExpressionParser.ExprValuesContext addArrayExprVarContext(MappingExpressionParser.ExprContext ctx,
                                                                               MappingExpressionParser.ExprValuesContext evc,
                                                                               com.fasterxml.jackson.databind.node.ArrayNode arrayNode)

Extends a supplied MappingExpressionParser.ExprValuesContext using the supplied context and array node content

Parameters:

ctx - context to serve as a parent context and provide invoking state

evc - expression values context to be updated

arrayNode - array values to be added to the expression values context

Returns:

MappingExpressionParser.ExprValuesContext updated with the supplied context and array context

addIndexExprVarContext

public static MappingExpressionParser.ExprValuesContext addIndexExprVarContext(MappingExpressionParser.ExprContext ctx,
                                                                               MappingExpressionParser.ExprValuesContext evc,
                                                                               Integer index)

Extends an MappingExpressionParser.ExprValuesContext using the context containing the supplied index value

Parameters:

ctx - context to serve as a parent context and provide invoking state

evc - expression values context to be updated

index - value to be added to the expression values context

Returns:

MappingExpressionParser.ExprValuesContext updated using the context containing the supplied index value

addObjectExprVarContext

public static MappingExpressionParser.ExprValuesContext addObjectExprVarContext(MappingExpressionParser.ExprContext ctx,
                                                                                MappingExpressionParser.ExprValuesContext evc,
                                                                                com.fasterxml.jackson.databind.node.ObjectNode object)

Extends an MappingExpressionParser.ExprValuesContext using the context containing the supplied object value

Parameters:

ctx - context to serve as a parent context and provide invoking state

evc - expression values context to be updated

object - value to be added to the expression values context

Returns:

MappingExpressionParser.ExprValuesContext updated using the context containing the supplied index value

addStringExprVarContext

public static MappingExpressionParser.ExprValuesContext addStringExprVarContext(MappingExpressionParser.ExprContext ctx,
                                                                                MappingExpressionParser.ExprValuesContext evc,
                                                                                String string)

Extends an MappingExpressionParser.ExprValuesContext using the context containing the supplied string value

Parameters:

ctx - context to serve as the parent of the generated context

evc - expression values context

string - value to be added to the ExprValuesContext

Returns:

MappingExpressionParser.ExprValuesContext updated using the context containing the supplied index value

fillExprVarContext

public static MappingExpressionParser.ExprValuesContext fillExprVarContext(int fctVarCount,
                                                                           MappingExpressionParser.ExprContext ctx,
                                                                           com.fasterxml.jackson.databind.JsonNode... elements)

Creates an MappingExpressionParser.ExprValuesContext containing a parenthesized comma separated variable list of the supplied elements

Parameters:

fctVarCount - the maximum number of parameters the receiving function will accept

ctx - context used to create the MappingExpressionParser.ExprValuesContext

elements - the values to be added to the list

Returns:

MappingExpressionParser.ExprValuesContext containing a parenthesized comma separated variable list of the supplied elements

fillExprVarContext

public static MappingExpressionParser.ExprValuesContext fillExprVarContext(MappingExpressionParser.ExprContext ctx,
                                                                           String key,
                                                                           com.fasterxml.jackson.databind.JsonNode value)

Sets up the MappingExpressionParser.ExprValuesContext variables for the function($v,$k) signature used in each call for pairs of values and keys

Parameters:

ctx - context to be used to create the new MappingExpressionParser.ExprListContext to contain the key, value pair

key - key used to relate the supplied value in the ExprValuesContext

value - content to be added to the ExprValuesContext

Returns:

MappingExpressionParser.ExprValuesContext containing the key and value in its parenthesized comma separated variable MappingExpressionParser.ExprListContext

getArrayConstructorContext

public static MappingExpressionParser.Array_constructorContext getArrayConstructorContext(MappingExpressionParser.ExprContext ctx,
                                                                                          com.fasterxml.jackson.databind.node.ArrayNode array)

Creates an MappingExpressionParser.Array_constructorContext from the supplied context and array

Parameters:

ctx - context to serve as parent of generated context.

array - ArrayNode whose content is used to create the Array_constructor context

Returns:

MappingExpressionParser.Array_constructorContext created from the supplied context and array

getContextVariable

public static com.fasterxml.jackson.databind.JsonNode getContextVariable(ExpressionsVisitor exprVisitor)

Retrieve the latest context variable from the ExpressionsVisitor stack, allowing for a null to be returned (in lieu of a NullNode)

Parameters:

exprVisitor - the expression visitor whose stack is being used

Returns:

the latest context variable, or a NullNode if none are available.

getContextVariableOrNullNode

public static com.fasterxml.jackson.databind.JsonNode getContextVariableOrNullNode(ExpressionsVisitor exprVisitor)

Retrieve the latest context variable from the ExpressionsVisitor stack

Parameters:

exprVisitor -

Returns:

the latest context variable, or a NullNode if none are available.

getObjectConstructorContext

public static MappingExpressionParser.Object_constructorContext getObjectConstructorContext(MappingExpressionParser.ExprContext ctx,
                                                                                            com.fasterxml.jackson.databind.node.ObjectNode object)

Creates an MappingExpressionParser.Object_constructorContext from the supplied context and object

Parameters:

ctx - ObjectConstructorContext

object - ObjectNode whose context is sought

Returns:

MappingExpressionParser.Object_constructorContext created from the supplied context and object

getValuesListExpression

public static com.fasterxml.jackson.databind.JsonNode getValuesListExpression(ExpressionsVisitor exprVisitor,
                                                                              MappingExpressionParser.Function_callContext ctx,
                                                                              int index)

Gets the expression at the supplied index from the context's MappingExpressionParser.ExprValuesContext MappingExpressionParser.ExprListContext, preserving the null value (or returning null if the index is invalid)

Parameters:

exprVisitor - used to visit the context's values

ctx - context providing MappingExpressionParser.ExprValuesContext MappingExpressionParser.ExprListContext

index - non-negative index into the MappingExpressionParser.ExprListContext

Returns:

value of the interpretation of the index-th expression from the context's MappingExpressionParser.ExprValuesContext MappingExpressionParser.ExprListContext, or a NullNode if none exists

validateArguments

public static void validateArguments(String possibleException,
                                     ExpressionsVisitor exprVisitor,
                                     MappingExpressionParser.Function_callContext ctx,
                                     int index,
                                     String signature)

Checks the expression at the supplied index from the context's MappingExpressionParser.ExprValuesContext MappingExpressionParser.ExprListContext, preserving the null value (or returning null if the index is invalid) to determine if the arguments are valid according to the supplied signature

Parameters:

exprVisitor - used to visit the context's values

ctx - context providing MappingExpressionParser.ExprValuesContext MappingExpressionParser.ExprListContext

index - non-negative index into the MappingExpressionParser.ExprListContext

signature - the acceptable arguments signature

Throws:

EvaluateRuntimeException - if the variables do not match the signature

checkArgument

public static boolean checkArgument(ExpressionsVisitor exprVisitor,
                                    MappingExpressionParser.ExprContext exprCtx,
                                    String signature)

Tests whether the supplied exprCtx meets the signature expectations. Note: $ or $$ references to context are not explicitly tested as they are resolved after this point. This test is for explicit variable declarations.

Parameters:

exprCtx - argument to be tested

signature - test to be performed

Returns:

true if the argument meets the test

getValuesListExpressionOrNullNode

public static com.fasterxml.jackson.databind.JsonNode getValuesListExpressionOrNullNode(ExpressionsVisitor exprVisitor,
                                                                                        MappingExpressionParser.Function_callContext ctx,
                                                                                        int index)

Gets the expression at the supplied index from the context's {link ExprValuesContext} {link ExprListContext]

Parameters:

exprVisitor - used to visit the context's values

ctx - context providing MappingExpressionParser.ExprValuesContext MappingExpressionParser.ExprListContext

index - non-negative index into the MappingExpressionParser.ExprListContext

Returns:

value of the interpretation of the index-th expression from the context's MappingExpressionParser.ExprValuesContext MappingExpressionParser.ExprListContext, or a NullNode if none exists

processVariablesCallFunction

public static com.fasterxml.jackson.databind.JsonNode processVariablesCallFunction(ExpressionsVisitor exprVisitor,
                                                                                   Function function,
                                                                                   org.antlr.v4.runtime.tree.TerminalNode varid,
                                                                                   MappingExpressionParser.Function_callContext ctx,
                                                                                   com.fasterxml.jackson.databind.JsonNode... elements)

Creates an MappingExpressionParser.ExprListContext containing the parenthesized comma separated variable list of JsonNode elements, sets it in the supplied context (ctx) and then executes the function to return its result.

Parameters:

exprVisitor - used to invoke the function after updating its context variables

function - the function to be invoked

varid - the variable to be associated with the elements

ctx - the context to be updated and used by the function when invoked

elements - the values to be set in the MappingExpressionParser.ExprValuesContext used by the function when invoked

Returns:

the result of calling the function with the updated context

processFctCallVariables

public static com.fasterxml.jackson.databind.JsonNode processFctCallVariables(ExpressionsVisitor exprVisitor,
                                                                              Function function,
                                                                              org.antlr.v4.runtime.tree.TerminalNode varid,
                                                                              MappingExpressionParser.Function_callContext ctx,
                                                                              com.fasterxml.jackson.databind.JsonNode value,
                                                                              String key,
                                                                              com.fasterxml.jackson.databind.node.ObjectNode object)

Creates an MappingExpressionParser.ExprListContext containing the parenthesized comma separated variable list of JsonNode elements, sets it in the supplied context (ctx) and then executes the function to return its result.

Parameters:

exprVisitor - used to invoke the function after updating its context variables

function - the function to be invoked

varid - the variable to be associated with the elements

ctx - the context to be updated and used by the function when invoked

value - the value to be set in the MappingExpressionParser.ExprValuesContext used by the function when invoked

key - the key to be set in the MappingExpressionParser.ExprValuesContext used by the function when invoked

object - the object to be set in the MappingExpressionParser.ExprValuesContext used by the function when invoked

Returns:

the result of calling the function with the updated context

useContextVariable

public static boolean useContextVariable(Function fct,
                                         MappingExpressionParser.Function_callContext ctx,
                                         String signature)

Determine if the function should use the context variable as its first parameter

Parameters:

fct - the function checking whether to use the context variable

ctx - the context used to invoke the function

signature - the function signature for the function being tested. If this contains a hyphen, then it can use the context

Returns:

true if the context variable should be used as the first parameter