io.rapidpro.expressions

Class EvaluationContext

java.lang.Object

io.rapidpro.expressions.EvaluationContext

public class EvaluationContext
extends Object

The evaluation context, i.e. date options and the variables accessible in an expression

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EvaluationContext.Deserializer JSON de-serializer for evaluation contexts

Field Summary

Fields

Modifier and Type	Field and Description
protected DateStyle	m_dateStyle
protected org.threeten.bp.Instant	m_now
protected org.threeten.bp.ZoneId	m_timezone
protected Map<String,Object>	m_variables
protected static com.google.gson.Gson	s_gson

Constructor Summary

Constructors

Constructor and Description
EvaluationContext()
EvaluationContext(Map<String,Object> variables, org.threeten.bp.ZoneId timezone, DateStyle dateStyle)
EvaluationContext(Map<String,Object> variables, org.threeten.bp.ZoneId timezone, DateStyle dateStyle, org.threeten.bp.Instant now)

Method Summary

Methods

Modifier and Type	Method and Description
protected static Object	coerceToSupportedType(Object value) Since we let users populate the context with whatever they want, this ensures the resolved value is something which the expression engine understands.
static EvaluationContext	fromJson(String json)
org.threeten.bp.format.DateTimeFormatter	getDateFormatter(boolean incTime)
DateParser	getDateParser()
DateStyle	getDateStyle()
org.threeten.bp.Instant	getNow()
org.threeten.bp.ZoneId	getTimezone()
Map<String,Object>	getVariables()
void	putVariable(String key, Object value)
Object	resolveVariable(String path) Returns a named variable, e.g.
protected Object	resolveVariableInContainer(Map<String,Object> container, String path, String originalPath)
void	setDateStyle(DateStyle dateStyle)

Methods inherited from class java.lang.Object

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

Field Detail

s_gson

protected static com.google.gson.Gson s_gson

m_variables

protected Map<String,Object> m_variables

m_timezone

protected org.threeten.bp.ZoneId m_timezone

m_dateStyle

protected DateStyle m_dateStyle

m_now

protected org.threeten.bp.Instant m_now

Constructor Detail

EvaluationContext

public EvaluationContext()

EvaluationContext

public EvaluationContext(Map<String,Object> variables,
                 org.threeten.bp.ZoneId timezone,
                 DateStyle dateStyle)

EvaluationContext

public EvaluationContext(Map<String,Object> variables,
                 org.threeten.bp.ZoneId timezone,
                 DateStyle dateStyle,
                 org.threeten.bp.Instant now)

Method Detail

fromJson

public static EvaluationContext fromJson(String json)

getVariables

public Map<String,Object> getVariables()

resolveVariable

public Object resolveVariable(String path)

Returns a named variable, e.g. contact, contact.name

Parameters:

path - the dot notation variable path

Returns:

the variable value

Throws:

EvaluationError - if variable is not defined

putVariable

public void putVariable(String key,
               Object value)

getTimezone

public org.threeten.bp.ZoneId getTimezone()

getDateStyle

public DateStyle getDateStyle()

setDateStyle

public void setDateStyle(DateStyle dateStyle)

getNow

public org.threeten.bp.Instant getNow()

getDateFormatter

public org.threeten.bp.format.DateTimeFormatter getDateFormatter(boolean incTime)

getDateParser

public DateParser getDateParser()

resolveVariableInContainer

protected Object resolveVariableInContainer(Map<String,Object> container,
                                String path,
                                String originalPath)

coerceToSupportedType

protected static Object coerceToSupportedType(Object value)

Since we let users populate the context with whatever they want, this ensures the resolved value is something which the expression engine understands.

Parameters:

value - the resolved value

Returns:

the value converted to a supported data type