net.obvj.jep

Class JEPContextFactory

java.lang.Object

net.obvj.jep.JEPContextFactory

public class JEPContextFactory
extends Object

A factory that creates JEP objects with extended functions and operators.

Author:

oswaldo.bapvic.jr

Method Summary

Modifier and Type	Method and Description
static void	addCustomFunctions(org.nfunk.jep.JEP jep, NamedPackage... namedPackages) Registers custom functions and operators into a given JEP object.
static void	addVariables(org.nfunk.jep.JEP jep, Map<String,Object> contextMap) Adds all entries from the contextMap as variables to the JEP context.
static org.nfunk.jep.JEP	newContext(Map<String,Object> contextMap, boolean traverse, boolean allowUndeclared, boolean implicitMultiplication, org.nfunk.jep.type.NumberFactory numberFactory, NamedPackage... namedPackages) Creates a new JEP object with custom functions and operators available, a collection of initial variables, and custom parameters.
static org.nfunk.jep.JEP	newContext(Map<String,Object> contextMap, NamedPackage... namedPackages) Creates a new JEP object with custom functions and operators available, and a collection of initial variables.
static org.nfunk.jep.JEP	newContext(NamedPackage... namedPackages) Creates a new JEP object with custom functions and operators available.

Methods inherited from class java.lang.Object

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

Method Detail

newContext

public static org.nfunk.jep.JEP newContext(NamedPackage... namedPackages)

Creates a new JEP object with custom functions and operators available.

For all functions available, simply pass no argument:

 JEP jep = JEPContextFactory.newContext();
 

For the standard JEP functions only, specify the core package as parameter:

 JEP jep = JEPContextFactory.newContext(NamedPackage.CORE);
 

For specific custom packages (in addition to the standard JEP functions), specify one or more custom package(s) as parameter:

 JEP jep = JEPContextFactory.newContext(NamedPackage.STRING, NamedPackage.WEB);
 

Parameters:

namedPackages - one or more packages which functions shall be added to the JEP context; if not specified, then all functions will be available

Returns:

a JEP object

newContext

public static org.nfunk.jep.JEP newContext(Map<String,Object> contextMap,
                                           NamedPackage... namedPackages)

Creates a new JEP object with custom functions and operators available, and a collection of initial variables.

Parameters:

contextMap - a map of variables to be used by the evaluation context; can be null

namedPackages - one or more packages which functions shall be added to the JEP context; if not specified, then all functions will be available

Returns:

a JEP object with a collection of initial variables available

See Also:

newContext(NamedPackage...)

newContext

public static org.nfunk.jep.JEP newContext(Map<String,Object> contextMap,
                                           boolean traverse,
                                           boolean allowUndeclared,
                                           boolean implicitMultiplication,
                                           org.nfunk.jep.type.NumberFactory numberFactory,
                                           NamedPackage... namedPackages)

Creates a new JEP object with custom functions and operators available, a collection of initial variables, and custom parameters.

Parameters:

contextMap - a map of variables to be used by the evaluation context; can be null

traverse - an optional to print expression trees (useful for debug)

allowUndeclared - the "allow undeclared variables" option

implicitMultiplication - the "implicit multiplication" option

numberFactory - the number factory to be used

namedPackages - one or more packages which functions shall be added to the JEP context; if not specified, then all functions will be available

Returns:

a new JEP object with custom functions and operators registered

See Also:

newContext(NamedPackage...)

addCustomFunctions

public static void addCustomFunctions(org.nfunk.jep.JEP jep,
                                      NamedPackage... namedPackages)

Registers custom functions and operators into a given JEP object.

For all custom functions available, simply pass no package as argument:

 JEPContextFactory.addCustomFunctions(jep);
 

For specific custom packages, specify one or more custom package(s) as parameter:

 JEPContextFactory.addCustomFunctions(jep, NamedPackage.STRING, NamedPackage.WEB);
 

Although it is assumed that standard JEP functions are already available in the specified JEP object, this method performs no action or validation on these features.

Note: This method updates JEP comparative operators regardless of the specified package. In other words, the comparative operators will always be enhanced with Date object capabilities after this method call.

Parameters:

jep - the JEP object to which custom functions and operations will be registered

namedPackages - one or more packages which functions shall be added to the JEP context; if not specified, then all functions will be available

addVariables

public static void addVariables(org.nfunk.jep.JEP jep,
                                Map<String,Object> contextMap)

Adds all entries from the contextMap as variables to the JEP context.

Parameters:

jep - the JEP object to be filled with variables, not null

contextMap - a map of variables to be used by the evaluation context

Throws:

IllegalArgumentException - if the specified JEP object is null