org.openlowcode.design.data

Class DecimalField

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.design.data.ObjectElement

org.openlowcode.design.data.Field

org.openlowcode.design.data.DecimalField

All Implemented Interfaces:

FormulaDefinitionElement, NamedInterface

public class DecimalField
extends Field
implements FormulaDefinitionElement

A field storing a decimal value payload. It can be used in formulas and as main value for smart reports

Author:

Open Lowcode SAS

Field Summary

Fields

Modifier and Type	Field and Description
static int	INDEXTYPE_NONE
static int	INDEXTYPE_RAWINDEX

Constructor Summary

Constructors

Constructor and Description
DecimalField(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, int length, int precision, int indextype) creates a decimal field with default priority and no index, and default display (number)
DecimalField(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, int length, int precision, int indextype, int displaypriority) creates a decimal field with default display
DecimalField(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, int length, int precision, int indextype, int displaypriority, DecimalFormatter decimalformatter) creates a decimal field with specified display (Decimal Formatter).

Method Summary

Modifier and Type	Method and Description
Field	copy(java.lang.String newname, java.lang.String newdisplaylabel) performs a copy of the field with new name and new display label
java.lang.String	generateFormulaElement()
CalculatedFieldTriggerPath[]	getAllTriggerPaths()
java.lang.String	getDataObjectConstructorAttributes()
java.lang.String	getDataObjectFieldName()
java.lang.String	getJavaType()
StoredElement	getMainStoredElementForCompositeIndex() Returns the main stored element of a field to be used in composite index
DataObjectDefinition	getOwnerObject()
int	getPrecision()
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.Field

copy, getDisplayPriority, getParentObject, isNoUserEdition, isShowinbottomnotes, isShowintitle, setDataObjectDefinition, setDisplayPriority, setNoUserEdition, setShowinbottomnotes, setShowInTitle

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

addElement, 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

Field Detail

INDEXTYPE_NONE

public static int INDEXTYPE_NONE

INDEXTYPE_RAWINDEX

public static int INDEXTYPE_RAWINDEX

Constructor Detail

DecimalField

public DecimalField(java.lang.String name,
                    java.lang.String displayname,
                    java.lang.String tooltip,
                    int length,
                    int precision,
                    int indextype)

creates a decimal field with default priority and no index, and default display (number)

Parameters:

name - unique name for the object that should be a legal java argument and SQL column name

displayname - plain language description in the default language

tooltip - roll-over tip

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

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

DecimalField

public DecimalField(java.lang.String name,
                    java.lang.String displayname,
                    java.lang.String tooltip,
                    int length,
                    int precision,
                    int indextype,
                    int displaypriority)

creates a decimal field with default display

Parameters:

name - unique name for the object that should be a legal java argument and SQL column name

displayname - plain language description in the default language

tooltip - roll-over tip

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

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

indextype - type of index (one of the static int of this class

displaypriority - a number strictly between -1000 and 1000

DecimalField

public DecimalField(java.lang.String name,
                    java.lang.String displayname,
                    java.lang.String tooltip,
                    int length,
                    int precision,
                    int indextype,
                    int displaypriority,
                    DecimalFormatter decimalformatter)

creates a decimal field with specified display (Decimal Formatter). This allows to show the figure as a progress bar

Parameters:

name - unique name for the object that should be a legal java argument and SQL column name

displayname - plain language description in the default language

tooltip - roll-over tip

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

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

indextype - type of index (one of the static int of this class

displaypriority - a number strictly between -1000 and 1000

decimalformatter -

Method Detail

getPrecision

public int getPrecision()

getDataObjectFieldName

public java.lang.String getDataObjectFieldName()

Specified by:

getDataObjectFieldName in class ObjectElement

Returns:

the unique name of the field

getDataObjectConstructorAttributes

public java.lang.String getDataObjectConstructorAttributes()

Specified by:

getDataObjectConstructorAttributes in class ObjectElement

Returns:

the attributes for the constructor to be used during code generation

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

getMainStoredElementForCompositeIndex

public StoredElement getMainStoredElementForCompositeIndex()

Description copied from class: Field

Returns the main stored element of a field to be used in composite index

Specified by:

getMainStoredElementForCompositeIndex in class Field

Returns:

a stored element

copy

public Field copy(java.lang.String newname,
                  java.lang.String newdisplaylabel)

Description copied from class: Field

performs a copy of the field with new name and new display label

Specified by:

copy in class Field

Parameters:

newname - newname for the field (null if keep originalname)

newdisplaylabel - new display label (null to keep original display name)

Returns: