com.im.df.api 5.9

com.im.df.api.support
Class CalculableGroovyTemplate

java.lang.Object
  extended by com.im.df.api.support.CalculableGroovyTemplate
All Implemented Interfaces:
Calculable, Scriptable

public class CalculableGroovyTemplate
extends Object
implements Scriptable

Calculable with groovy support. format patter is groovy script where field values are represented by @@field_id@@


Nested Class Summary
static class CalculableGroovyTemplate.CalcOperation
           
static class CalculableGroovyTemplate.FieldDetails
          A CalculableGroovyTemplate argument.
 
Constructor Summary
CalculableGroovyTemplate(DFEntity ent, FieldInfo.Script script, Map<String,CalculableGroovyTemplate.FieldDetails> varNameToField, Class<?> returnType)
           
 
Method Summary
 void addField(String varNam, CalculableGroovyTemplate.FieldDetails field)
           
 Map<String,CalculableGroovyTemplate.FieldDetails> getFieldsMapping()
          Get parameters for groovy script.
 DFField[] getParams()
           
 FieldInfo.Script getScript()
           
 Object getTestValue(Map<String,Object> values)
          Get values without reading data from database.
 DFWrappedValue getValue(Map<String,Object> values)
           
 void setScript(FieldInfo.Script script)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CalculableGroovyTemplate

public CalculableGroovyTemplate(DFEntity ent,
                                FieldInfo.Script script,
                                Map<String,CalculableGroovyTemplate.FieldDetails> varNameToField,
                                Class<?> returnType)
Method Detail

setScript

public final void setScript(FieldInfo.Script script)

addField

public void addField(String varNam,
                     CalculableGroovyTemplate.FieldDetails field)

getValue

public DFWrappedValue getValue(Map<String,Object> values)
Specified by:
getValue in interface Calculable

getTestValue

public Object getTestValue(Map<String,Object> values)
                    throws ScriptException
Get values without reading data from database. Used for validation.

Parameters:
values - testing values
Returns:
result from script execution
Throws:
ScriptException - If the evaluation fails.

getScript

public FieldInfo.Script getScript()
Specified by:
getScript in interface Scriptable

getFieldsMapping

public Map<String,CalculableGroovyTemplate.FieldDetails> getFieldsMapping()
Get parameters for groovy script.

Returns:
variable name to FieldsDetail map

getParams

public DFField[] getParams()
Specified by:
getParams in interface Calculable
Returns:
fields used in script.

com.im.df.api 5.9