EvaluationContext (OpenMRS 1.8.5-SNAPSHOT API)

java.lang.Object
- org.openmrs.report.EvaluationContext

Deprecated.
see reportingcompatibility module
```
@Deprecated
public class EvaluationContext
extends Object
```
The EvaluationContext provides the following capabilities: - A baseCohort, i.e. the universe of patients relevant to this context (defaults to all patients) - An in-memory cache which can be used to persist and retrieve objects. Note that this cache is cleared whenever any changes are made to baseCohort or any parameter values. - Capabilities to add, remove, and retrieve parameter values - Capabilities to evaluate parametric expressions, e.g. ${someDateParameterName+30d}

Field Summary

Fields
Modifier and Type	Field and Description
`static Pattern`	`DATE_OPERATION_PATTERN` Deprecated.
`static String`	`END_OF_EXPRESSION` Deprecated.
`protected org.apache.commons.logging.Log`	`log` Deprecated.
`static String`	`START_OF_EXPRESSION` Deprecated.

Constructor Summary

Constructors
Constructor and Description

EvaluationContext()
Deprecated.

Constructors
Constructor and Description
`EvaluationContext()` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addParameterValue(Parameterizable obj, Parameter parameter, Object value)` Deprecated. Add a parameter to the context with the given value in the scope of the passed Parameterizable object
`void`	`addParameterValue(Parameter parameter, Object value)` Deprecated. Add a parameter to the context with the given value with global scope
`void`	`addToCache(String key, Object value)` Deprecated. Add a value to the cache with a given key
`void`	`clearCache()` Deprecated. Clear the entire cache
`Object`	`evaluateExpression(String expression)` Deprecated. This method will parse the passed expression and return a value based on the following criteria: Any string that matches a parameter within the EvaluationContext will be replaced by the value of that parameter ** CURRENTLY REPLACEMENT PARAMETERS MUST EXIST IN THE GLOBAL SCOPE If this date is followed by an expression, it will attempt to evaluate this by incrementing/decrementing days/weeks/months/years as specified Examples: Given 2 parameters: report.startDate = java.util.Date with value of [2007-01-10] report.gender = "male" The following should result:
`Cohort`	`getBaseCohort()` Deprecated.
`Map<String,Object>`	`getCache()` Deprecated. Get the cache property
`Object`	`getFromCache(String key)` Deprecated. Retrieve an entry from the cached with the given key
`Parameter`	`getParameter(Parameterizable obj, String parameterName)` Deprecated. Retrieve a Parameter by Name.
`Object`	`getParameter(String parameterName)` Deprecated. Retrieve Parameter from Global Scope only.
`Object`	`getParameterValue(Parameter parameter)` Deprecated. Retrieve parameter value in Global Scope only.
`Object`	`getParameterValue(Parameterizable obj, Parameter parameter)` Deprecated. Retrieve parameter value by Parameter.
`Object`	`getParameterValue(Parameterizable obj, String parameterName)` Deprecated. Retrieve parameter value by parameter name.
`Object`	`getParameterValue(String parameterName)` Deprecated. Retrieve global parameter value by name
`Map<Parameterizable,Map<Parameter,Object>>`	`getParameterValues()` Deprecated. Retrieve all parameter values
`boolean`	`isCached(String key)` Deprecated. Return true if a cache entry exists with the given key
`static boolean`	`isExpression(String s)` Deprecated.
`void`	`removeFromCache(String key)` Deprecated. Remove an entry cached with the given key
`void`	`setBaseCohort(Cohort baseCohort)` Deprecated.
`void`	`setCache(Map<String,Object> cache)` Deprecated. Set the cache property
`void`	`setParameterValues(Map<Parameterizable,Map<Parameter,Object>> parameterValues)` Deprecated. Set all parameter values

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - log
```
protected org.apache.commons.logging.Log log
```
    Deprecated.
  - START_OF_EXPRESSION
```
public static final String START_OF_EXPRESSION
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - END_OF_EXPRESSION
```
public static final String END_OF_EXPRESSION
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DATE_OPERATION_PATTERN
```
public static final Pattern DATE_OPERATION_PATTERN
```
    Deprecated.
- Constructor Detail
  - EvaluationContext
```
public EvaluationContext()
```
    Deprecated.
- Method Detail
  - isExpression
```
public static boolean isExpression(String s)
```
    Deprecated.
  - getCache
```
public Map<String,Object> getCache()
```
    Deprecated.
    
    Get the cache property
    
    Returns:
    
    Map
  - setCache
```
public void setCache(Map<String,Object> cache)
```
    Deprecated.
    
    Set the cache property
    
    Parameters:
    
    cache -
  - addToCache
```
public void addToCache(String key,
                       Object value)
```
    Deprecated.
    
    Add a value to the cache with a given key
  - removeFromCache
```
public void removeFromCache(String key)
```
    Deprecated.
    
    Remove an entry cached with the given key
    
    Parameters:
    
    key -
  - getFromCache
```
public Object getFromCache(String key)
```
    Deprecated.
    
    Retrieve an entry from the cached with the given key
    
    Parameters:
    
    key -
  - isCached
```
public boolean isCached(String key)
```
    Deprecated.
    
    Return true if a cache entry exists with the given key
    
    Parameters:
    
    key -
  - clearCache
```
public void clearCache()
```
    Deprecated.
    
    Clear the entire cache
  - addParameterValue
```
public void addParameterValue(Parameter parameter,
                              Object value)
```
    Deprecated.
    
    Add a parameter to the context with the given value with global scope
    
    Parameters:
    
    parameter -
    
    value -
  - addParameterValue
```
public void addParameterValue(Parameterizable obj,
                              Parameter parameter,
                              Object value)
```
    Deprecated.
    
    Add a parameter to the context with the given value in the scope of the passed Parameterizable object
    
    Parameters:
    
    obj - Parametrizable object
    
    parameter -
    
    value -
  - getParameterValues
```
public Map<Parameterizable,Map<Parameter,Object>> getParameterValues()
```
    Deprecated.
    
    Retrieve all parameter values
    
    Returns:
    
    Map
  - setParameterValues
```
public void setParameterValues(Map<Parameterizable,Map<Parameter,Object>> parameterValues)
```
    Deprecated.
    
    Set all parameter values
    
    Parameters:
    
    parameterValues -
  - getParameter
```
public Parameter getParameter(Parameterizable obj,
                              String parameterName)
```
    Deprecated.
    
    Retrieve a Parameter by Name. If a parameterizable is passed in, it will check scope local to the Parameterizable first, and if not found, check global scope It will return null if not found in either scope
    
    Parameters:
    
    obj - Parametrizable object to get from
    
    parameterName -
  - getParameter
```
public Object getParameter(String parameterName)
```
    Deprecated.
    
    Retrieve Parameter from Global Scope only. It will return null if not found
    
    Parameters:
    
    parameterName - String name for parameter to get
  - getParameterValue
```
public Object getParameterValue(Parameterizable obj,
                                Parameter parameter)
```
    Deprecated.
    
    Retrieve parameter value by Parameter. If a parameterizable is passed in, it will check scope local to the Parameterizable first, and if not found, check global scope It will return null if not found in either scope
    
    Parameters:
    
    obj - Parametrizable object
    
    parameter -
  - getParameterValue
```
public Object getParameterValue(Parameter parameter)
```
    Deprecated.
    
    Retrieve parameter value in Global Scope only. It will return null if not found
    
    Parameters:
    
    parameter -
  - getParameterValue
```
public Object getParameterValue(Parameterizable obj,
                                String parameterName)
```
    Deprecated.
    
    Retrieve parameter value by parameter name. If a parameterizable is passed in, it will check scope local to the Parameterizable first, and if not found, check global scope It will return null if not found in either scope
    
    Parameters:
    
    obj - Parametrizable object
    
    parameterName - key of the parameter to look for
    
    Returns:
    
    Object value of the parameter named by parameterName
  - getParameterValue
```
public Object getParameterValue(String parameterName)
```
    Deprecated.
    
    Retrieve global parameter value by name
    
    Parameters:
    
    parameterName - key of the parameter to look for
    
    Returns:
    
    Object value of the parameter named by parameterName
  - evaluateExpression
```
public Object evaluateExpression(String expression)
                          throws ParameterException
```
    Deprecated.
    This method will parse the passed expression and return a value based on the following criteria:
    - Any string that matches a parameter within the EvaluationContext will be replaced by the value of that parameter ** CURRENTLY REPLACEMENT PARAMETERS MUST EXIST IN THE GLOBAL SCOPE
    - If this date is followed by an expression, it will attempt to evaluate this by incrementing/decrementing days/weeks/months/years as specified
    - Examples: Given 2 parameters:
      
      report.startDate = java.util.Date with value of [2007-01-10]
      report.gender = "male"
      The following should result:
      
      evaluateExpression("${report.startDate}") -> "2007-01-10" as Date evaluateExpression("${report.startDate+5d}") -> "2007-01-15" as Date evaluateExpression("${report.startDate-1w}") -> "2007-01-03" as Date evaluateExpression("${report.startDate+3m}") -> "2007-04-15" as Date evaluateExpression("${report.startDate+1y}") -> "2008-01-10" as Date
    Parameters:
    
    expression -
    
    Returns:
    
    value for given expression, as an Object
    
    Throws:
    
    ParameterException
  - getBaseCohort
```
public Cohort getBaseCohort()
```
    Deprecated.
  - setBaseCohort
```
public void setBaseCohort(Cohort baseCohort)
```
    Deprecated.

Class EvaluationContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

START_OF_EXPRESSION

END_OF_EXPRESSION

DATE_OPERATION_PATTERN

Constructor Detail

EvaluationContext

Method Detail

isExpression

getCache

setCache

addToCache

removeFromCache

getFromCache

isCached

clearCache

addParameterValue

addParameterValue

getParameterValues

setParameterValues

getParameter

getParameter

getParameterValue

getParameterValue

getParameterValue

getParameterValue

evaluateExpression

getBaseCohort

setBaseCohort