org.openlowcode.server.data

Class DecimalDataObjectFieldDefinition<E extends DataObject<E>>

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.server.data.DataObjectElementDefinition<StoredFieldSchema,E>

org.openlowcode.server.data.DataObjectFieldDefinition<E>

org.openlowcode.server.data.DecimalDataObjectFieldDefinition<E>

Type Parameters:

E - the type of data object

All Implemented Interfaces:

NamedInterface

public class DecimalDataObjectFieldDefinition<E extends DataObject<E>>
extends DataObjectFieldDefinition<E>

Definition of a decimal field in a data object

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
DecimalDataObjectFieldDefinition(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, int precision, int scale, boolean readonly, boolean showintitle, boolean showinbottompage, int priority, DataObjectDefinition<E> objectdefinition) Creates a new field specifying the priority but keeping the default formatter
DecimalDataObjectFieldDefinition(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, int precision, int scale, boolean readonly, boolean showintitle, boolean showinbottompage, SDecimalFormatter formatter, DataObjectDefinition<E> objectdefinition) creates a new field with default priority (0)
DecimalDataObjectFieldDefinition(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, int precision, int scale, boolean readonly, boolean showintitle, boolean showinbottompage, SDecimalFormatter formatter, int priority, DataObjectDefinition<E> objectdefinition) creates a new field specifying the priority and formatter

Method Summary

Modifier and Type	Method and Description
SPageNode	getDataFieldDefinition()
FlatFileLoaderColumn<E>	getFlatFileLoaderColumn(DataObjectDefinition<E> objectdefinition, java.lang.String[] columnattributes, ChoiceValue<ApplocaleChoiceDefinition> locale) generates the flat file loader for this property
java.lang.String[]	getLoaderFieldSample()
StoredFieldSchema<?>	getMainStoredField()
int	getPrecision()
int	getScale()
DataObjectElement	initiateFieldInstance(DataObjectPayload parentpayload)
boolean	isFormulaElement()

Methods inherited from class org.openlowcode.server.data.DataObjectFieldDefinition

getDefaultcolumnintable, getDisplayname, getObjectDefinition, getPriority, getTooltip, isReadOnly, isShowinbottonpage, isShowintitle

Methods inherited from class org.openlowcode.server.data.DataObjectElementDefinition

addFieldSchema, addIndex, dropfieldnamelist, getDefinition, getFieldSchema, getFieldSchemaByName, getFieldSchemaNumber, getIndexAt, getIndexNumber, getTriggerlist, setTriggerOnUpdate

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

DecimalDataObjectFieldDefinition

public DecimalDataObjectFieldDefinition(java.lang.String name,
                                        java.lang.String displayname,
                                        java.lang.String tooltip,
                                        int precision,
                                        int scale,
                                        boolean readonly,
                                        boolean showintitle,
                                        boolean showinbottompage,
                                        SDecimalFormatter formatter,
                                        DataObjectDefinition<E> objectdefinition)

creates a new field with default priority (0)

Parameters:

name - unique name of the field

displayname - label to show in the main language of the application

tooltip - long explanation for mouse roll-over

precision - number of significant digits authorized

scale - number of digits authorized after comma

readonly - true if field is read-only

showintitle - show the field in title of the obkect

showinbottompage - show the field in bottom notes of the object

formatter - a decimal formatter

objectdefinition - parent objet

DecimalDataObjectFieldDefinition

public DecimalDataObjectFieldDefinition(java.lang.String name,
                                        java.lang.String displayname,
                                        java.lang.String tooltip,
                                        int precision,
                                        int scale,
                                        boolean readonly,
                                        boolean showintitle,
                                        boolean showinbottompage,
                                        SDecimalFormatter formatter,
                                        int priority,
                                        DataObjectDefinition<E> objectdefinition)

creates a new field specifying the priority and formatter

Parameters:

name - unique name of the field

displayname - label to show in the main language of the application

tooltip - long explanation for mouse roll-over

precision - number of significant digits authorized

scale - number of digits authorized after comma

readonly - true if field is read-only

showintitle - show the field in title of the obkect

showinbottompage - show the field in bottom notes of the object

formatter - a decimal formatter

priority - priority of the field

objectdefinition - parent object definition

DecimalDataObjectFieldDefinition

public DecimalDataObjectFieldDefinition(java.lang.String name,
                                        java.lang.String displayname,
                                        java.lang.String tooltip,
                                        int precision,
                                        int scale,
                                        boolean readonly,
                                        boolean showintitle,
                                        boolean showinbottompage,
                                        int priority,
                                        DataObjectDefinition<E> objectdefinition)

Creates a new field specifying the priority but keeping the default formatter

Parameters:

name - unique name of the field

displayname - label to show in the main language of the application

tooltip - long explanation for mouse roll-over

precision - number of significant digits authorized

scale - number of digits authorized after comma

readonly - true if field is read-only

showintitle - show the field in title of the obkect

showinbottompage - show the field in bottom notes of the object

priority - priority of the field

objectdefinition - parent object definition

Method Detail

isFormulaElement

public boolean isFormulaElement()

Overrides:

isFormulaElement in class DataObjectElementDefinition<StoredFieldSchema,E extends DataObject<E>>

Returns:

true if this element can be used as a formula element

getScale

public int getScale()

Returns:

the scale of the field (number of digits authorized after the comma

getPrecision

public int getPrecision()

Returns:

the precision of the field (total number of digits)

getDataFieldDefinition

public SPageNode getDataFieldDefinition()

Specified by:

getDataFieldDefinition in class DataObjectFieldDefinition<E extends DataObject<E>>

Returns:

the widget to use for display in object

initiateFieldInstance

public DataObjectElement initiateFieldInstance(DataObjectPayload parentpayload)

Specified by:

initiateFieldInstance in class DataObjectElementDefinition<StoredFieldSchema,E extends DataObject<E>>

Parameters:

parentpayload - the object payload

Returns:

an element corresponding to this element initiated with the information in the object payload

getFlatFileLoaderColumn

public FlatFileLoaderColumn<E> getFlatFileLoaderColumn(DataObjectDefinition<E> objectdefinition,
                                                       java.lang.String[] columnattributes,
                                                       ChoiceValue<ApplocaleChoiceDefinition> locale)

Description copied from class: DataObjectFieldDefinition

generates the flat file loader for this property

Specified by:

getFlatFileLoaderColumn in class DataObjectFieldDefinition<E extends DataObject<E>>

Parameters:

objectdefinition - definition of the object

columnattributes - column attributes

locale - locale if loaded by CSV

Returns:

a flat file loader

getLoaderFieldSample

public java.lang.String[] getLoaderFieldSample()

Specified by:

getLoaderFieldSample in class DataObjectFieldDefinition<E extends DataObject<E>>

Returns:

an array of 4 strings

• full name of the field
• OPTIONAL or MANDATORY
• Sample Values
• Comments including options

getMainStoredField

public StoredFieldSchema<?> getMainStoredField()

Specified by:

getMainStoredField in class DataObjectFieldDefinition<E extends DataObject<E>>

Returns:

the default stored field schema used when searching on this field