org.openlowcode.design.data.properties.basic

Class ComputedDecimal

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.design.data.ObjectElement

org.openlowcode.design.data.Property<ComputedDecimal>

org.openlowcode.design.data.properties.basic.ComputedDecimal

All Implemented Interfaces:

FormulaDefinitionElement, NamedInterface

public class ComputedDecimal
extends Property<ComputedDecimal>
implements FormulaDefinitionElement

A computed decimal is a stored decimal field that is computed based on information on the object or on adjacent objects

Author:

Open Lowcode SAS

Nested Class Summary

Nested classes/interfaces inherited from class org.openlowcode.design.data.Property

Property.PropertyElementDisplayDefinition

Field Summary

Fields inherited from class org.openlowcode.design.data.Property

FIELDDIPLSAY_TITLE_MOD, FIELDDISPLAY_BOTTOMNOTES, FIELDDISPLAY_NONE, FIELDDISPLAY_NORMAL, FIELDDISPLAY_NORMAL_MOD, FIELDDISPLAY_TITLE, parent

Constructor Summary

Constructors

Constructor and Description
ComputedDecimal(java.lang.String name, java.lang.String fieldlabel, int precision, int scale, FormulaDefinitionElement formula) creates a computed decimal field without a formatter
ComputedDecimal(java.lang.String name, java.lang.String fieldlabel, int precision, int scale, FormulaDefinitionElement formula, DecimalFormatter decimalformatter) creates a computed decimal field with a formatter

Method Summary

Modifier and Type	Method and Description
void	controlAfterParentDefinition() to be implemented if controls have to be performed after parent is added.
java.lang.String	generateFormulaElement()
CalculatedFieldTriggerPath[]	getAllTriggerPaths()
java.util.ArrayList<DataObjectDefinition>	getExternalObjectDependence()
java.lang.String	getJavaType()
DataObjectDefinition	getOwnerObject()
java.lang.String[]	getPropertyDeepCopyStatement() Returns the required deepcopy statement for the property, sends back null if nothing is required.
java.lang.String[]	getPropertyExtractMethod() This method should return non null value only if setCreationDataInputForUpdate() is set
java.lang.String[]	getPropertyInitMethod() this method uses the context data for creation and the data-input for standard creation.
void	setFinalSettings() an abstract method to be implemented by properties for finalizations to be performed after all data objects have been created.
void	setTriggersOnSourceFields(CalculatedFieldTriggerPath triggerpath) sets the triggers on the origin fields of the formula so that formula calculation is triggered when the field value changes.
void	writeDependentClass(SourceGenerator sg, Module module) only send here classes that are NOT data objects.

Methods inherited from class org.openlowcode.design.data.Property

addBusinessRule, addChoiceCategoryHelper, addContextForDataCreation, addDataAccessMethod, addDataInput, addDependentProperty, addDisplayProfileForProperty, addElement, addElement, addElementasSearchElement, addExternalObjectProperty, addFieldOverrides, addMethodAdditionalProcessing, addObjectToAuthorityMapper, addPropertyGenerics, addStringHelper, generatePropertyHelperToFile, getBusinessRule, getBusinessRuleByName, getBusinessRuleNumber, getChoiceCategoryByKey, getChoiceCategoryKeyNumber, getChoiceCategoryNumber, getContextDataForCreation, getContextDataForCreationSize, getDataAccessMethod, getDataAccessMethod, getDataAccessMethodnumber, getDataInputForCreation, getDataInputSize, getDataObjectConstructorAttributes, getDataObjectFieldName, getDependentProperties, getDisplayDefinitionForElement, getDisplayProfileForProperty, getDisplayProfileForPropertyNumber, getExternalObject, getExternalObjectProperty, getExternalObjectPropertySize, getFieldOverridesat, getFieldOverridesNumber, getInstancename, getJavaClassType, getMethodAdditionalProcessing, getMethodAdditionalProcessingnumber, getParent, getPropertyclassname, getPropertyGenerics, getPropertyGenericsSize, getPropertyGenericsString, getPropertyHelperName, hasDynamicDefinitionHelper, hasInterface, hasStaticQuery, hideDataInputForCreation, isDatainputatbottom, isDataInputHiddenForCreation, isDataInputUsedForUpdate, isLegacy, isPropertyHelperTransient, setAsLegacy, setDatainputatbottom, setDataInputForUpdate, setDynamicDefinitionHelper, setExtraAttributes, writeAdditionalDefinition

Methods inherited from class org.openlowcode.design.data.ObjectElement

AddElementWithSearch, addIndex, getDisplayname, getElements, getIndex, getSearchWidgetList, getTooltip

Methods inherited from class org.openlowcode.tools.misc.Named

changeName, cleanName, equals, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

ComputedDecimal

public ComputedDecimal(java.lang.String name,
                       java.lang.String fieldlabel,
                       int precision,
                       int scale,
                       FormulaDefinitionElement formula,
                       DecimalFormatter decimalformatter)

creates a computed decimal field with a formatter

Parameters:

name - name of the field (should be valid java attribute name)

fieldlabel - label in default language

precision - (digits to the right of decimal point (e.g. 533.33 has precision on 2)

scale - total number of digits of the number (e.g. 533.33 is 5 digits)

formula - formula to calculate the field value

decimalformatter - formatter for the field (if graphical display is expected)

ComputedDecimal

public ComputedDecimal(java.lang.String name,
                       java.lang.String fieldlabel,
                       int precision,
                       int scale,
                       FormulaDefinitionElement formula)

creates a computed decimal field without a formatter

Parameters:

name - name of the field (should be valid java attribute name)

fieldlabel - label in default language

precision - (digits to the right of decimal point (e.g. 533.33 has precision on 2)

scale - total number of digits of the number (e.g. 533.33 is 5 digits)

formula - formula to calculate the field value

Method Detail

controlAfterParentDefinition

public void controlAfterParentDefinition()

Description copied from class: Property

to be implemented if controls have to be performed after parent is added.

Overrides:

controlAfterParentDefinition in class Property<ComputedDecimal>

getPropertyInitMethod

public java.lang.String[] getPropertyInitMethod()

Description copied from class: Property

this method uses the context data for creation and the data-input for standard creation. This does not include automatically generated data, but data entered by user and context only.

Specified by:

getPropertyInitMethod in class Property<ComputedDecimal>

Returns:

a non-null array of size 0 to n with the method and arguments required

getPropertyExtractMethod

public java.lang.String[] getPropertyExtractMethod()

Description copied from class: Property

This method should return non null value only if setCreationDataInputForUpdate() is set

Specified by:

getPropertyExtractMethod in class Property<ComputedDecimal>

Returns:

a non-null array of size 0 to n with the method and arguments required

getExternalObjectDependence

public java.util.ArrayList<DataObjectDefinition> getExternalObjectDependence()

Specified by:

getExternalObjectDependence in class Property<ComputedDecimal>

Returns:

a list of data object definitions that are linked to this property. This helps making necessary imports in the data object definition file

setFinalSettings

public void setFinalSettings()

Description copied from class: Property

an abstract method to be implemented by properties for finalizations to be performed after all data objects have been created. THis is especially useful for properties that refer to other data objects (e.g. LinkProperty )

Specified by:

setFinalSettings in class Property<ComputedDecimal>

getJavaType

public java.lang.String getJavaType()

Specified by:

getJavaType in class ObjectElement

Returns:

the java type of the object element in data object code

writeDependentClass

public void writeDependentClass(SourceGenerator sg,
                                Module module)
                         throws java.io.IOException

Description copied from class: ObjectElement

only send here classes that are NOT data objects. For data object dependencies for properties, use the property method getExternalObjectDependence TODO: needs to replace this logic by the sending of list of strings to remove duplicates issue #12

Specified by:

writeDependentClass in class ObjectElement

Throws:

java.io.IOException

getOwnerObject

public DataObjectDefinition getOwnerObject()

Specified by:

getOwnerObject in interface FormulaDefinitionElement

Returns:

the DataObjectDefinition who is owning the formula Definition Element. A formula definition element can only be put on a calculated field of the owning object. If any incorrect configuration happens, throws an Exception

generateFormulaElement

public java.lang.String generateFormulaElement()

Specified by:

generateFormulaElement in interface FormulaDefinitionElement

Returns:

the source code for the formula element

setTriggersOnSourceFields

public void setTriggersOnSourceFields(CalculatedFieldTriggerPath triggerpath)

Description copied from interface: FormulaDefinitionElement

sets the triggers on the origin fields of the formula so that formula calculation is triggered when the field value changes. This can be on other objects

Specified by:

setTriggersOnSourceFields in interface FormulaDefinitionElement

getAllTriggerPaths

public CalculatedFieldTriggerPath[] getAllTriggerPaths()

Specified by:

getAllTriggerPaths in interface FormulaDefinitionElement

Returns:

all the trigger pathes for this formula element

getPropertyDeepCopyStatement

public java.lang.String[] getPropertyDeepCopyStatement()

Description copied from class: Property

Returns the required deepcopy statement for the property, sends back null if nothing is required.

Specified by:

getPropertyDeepCopyStatement in class Property<ComputedDecimal>

Returns:

a number of lines of java code