Package com.im.df.api.support

Interface DFNewTypeWellKnownOptions.NewCalulatedField

All Superinterfaces:

DFNewTypeOptions, DFNewTypeWellKnownOptions.FieldOptions, DFNewTypeWellKnownOptions.NewDBField, DFNewTypeWellKnownOptions.SingleDFItem

Enclosing interface:

DFNewTypeWellKnownOptions

public static interface DFNewTypeWellKnownOptions.NewCalulatedField
extends DFNewTypeWellKnownOptions.NewDBField

Options for creating new calculated field, you need to validate calc field by using validateScript method.

Field Summary

Fields inherited from interface com.im.df.api.support.DFNewTypeOptions

PROP_ERROR_MESSAGE, PROP_VALID

Fields inherited from interface com.im.df.api.support.DFNewTypeWellKnownOptions.SingleDFItem

PROP_DESCRIPTION, PROP_NEW_DFITEM_NAME

Method Summary

Modifier and Type	Method	Description
CalculatedReturnType	getCalculatedReturnType()
com.im.ijcs.api.ddl.dto.FieldInfo.Script	getExpression()
java.util.Map<java.lang.String,CalculableGroovyTemplate.FieldDetails>	getFieldsMapping()
void	setExpression(com.im.ijcs.api.ddl.dto.FieldInfo.Script expression)
void	setFieldsMapping(java.util.Map<java.lang.String,CalculableGroovyTemplate.FieldDetails> fieldsMapping)	Set parameters for calculations.
java.lang.String	validateScript(java.util.Map<java.lang.String,java.lang.Object> testValues, java.lang.Object[] retValue)	Validate calculated field for predefined values.

Methods inherited from interface com.im.df.api.support.DFNewTypeOptions

addPropertyChangeListener, getErrorMessage, isValid, removePropertyChangeListener

Methods inherited from interface com.im.df.api.support.DFNewTypeWellKnownOptions.FieldOptions

createInsertOptions, getConvertor

Methods inherited from interface com.im.df.api.support.DFNewTypeWellKnownOptions.NewDBField

getColumns, getDefaultValue, getRequired, isDisctinctValues, setColumnBaseName, setDefaultValue, setDisctinctValues, setRequired

Methods inherited from interface com.im.df.api.support.DFNewTypeWellKnownOptions.SingleDFItem

getDescription, getNewDFItemName, setDescription, setNewDFItemName, setNewDFItemNameSafe

Method Detail

setExpression

void setExpression(com.im.ijcs.api.ddl.dto.FieldInfo.Script expression)

getExpression

com.im.ijcs.api.ddl.dto.FieldInfo.Script getExpression()

setFieldsMapping

void setFieldsMapping(java.util.Map<java.lang.String,CalculableGroovyTemplate.FieldDetails> fieldsMapping)

Set parameters for calculations.

Parameters:

fieldsMapping - key is variable name.

getFieldsMapping

java.util.Map<java.lang.String,CalculableGroovyTemplate.FieldDetails> getFieldsMapping()

getCalculatedReturnType

CalculatedReturnType getCalculatedReturnType()

validateScript

java.lang.String validateScript(java.util.Map<java.lang.String,java.lang.Object> testValues,
                                java.lang.Object[] retValue)

Validate calculated field for predefined values.

Parameters:

testValues - field id to value map

retValue - array with size 1 in order to return calculated value

Returns:

error message if validation failed. Otherwise it returns null.