org.openlowcode.server.data

Class MultipleChoiceDataObjectFieldDefinition<E extends FieldChoiceDefinition<E>,F extends DataObject<F>>

java.lang.Object

org.openlowcode.tools.misc.Named

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

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

org.openlowcode.server.data.MultipleChoiceDataObjectFieldDefinition<E,F>

Type Parameters:

E - choice definition

F - parent data object

All Implemented Interfaces:

NamedInterface

public class MultipleChoiceDataObjectFieldDefinition<E extends FieldChoiceDefinition<E>,F extends DataObject<F>>
extends DataObjectFieldDefinition<F>

Definition of a field of a data object holding several choice values. A list of codes is persisted in the databases separated by "|"

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
MultipleChoiceDataObjectFieldDefinition(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, boolean readonly, boolean showintitle, boolean showinbottomnotes, E fieldchoicedefinition, int storagelength, int priority, int defaultcolumn, DataObjectDefinition<F> objectdefinition) creates the definition of a multiple choice data object field definition
MultipleChoiceDataObjectFieldDefinition(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, boolean readonly, E fieldchoicedefinition, int storagelength, DataObjectDefinition<F> objectdefinition) creates the definition of a multiple choice data object field definition
MultipleChoiceDataObjectFieldDefinition(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, boolean readonly, E fieldchoicedefinition, int storagelength, int priority, int defaultcolumn, DataObjectDefinition<F> objectdefinition) creates the definition of a multiple choice data object field definition

Method Summary

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

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

MultipleChoiceDataObjectFieldDefinition

public MultipleChoiceDataObjectFieldDefinition(java.lang.String name,
                                               java.lang.String displayname,
                                               java.lang.String tooltip,
                                               boolean readonly,
                                               E fieldchoicedefinition,
                                               int storagelength,
                                               DataObjectDefinition<F> objectdefinition)

creates the definition of a multiple choice data object field definition

Parameters:

name - unique name of the field

displayname - label of the field

tooltip - roll-over tooltip

readonly - true if read-only

fieldchoicedefinition - definition of the field choice

storagelength - storage length of the field. Should be able to hold enough storage codes and separators

objectdefinition - definition of the parent data object

MultipleChoiceDataObjectFieldDefinition

public MultipleChoiceDataObjectFieldDefinition(java.lang.String name,
                                               java.lang.String displayname,
                                               java.lang.String tooltip,
                                               boolean readonly,
                                               boolean showintitle,
                                               boolean showinbottomnotes,
                                               E fieldchoicedefinition,
                                               int storagelength,
                                               int priority,
                                               int defaultcolumn,
                                               DataObjectDefinition<F> objectdefinition)

creates the definition of a multiple choice data object field definition

Parameters:

name - unique name of the field

displayname - label of the field

tooltip - roll-over tooltip

readonly - true if read-only

showintitle - true if field is shown in title and main object band

showinbottomnotes - true if field is shown only in bottom notes

fieldchoicedefinition - definition of the field choice

storagelength - storage length of the field. Should be able to hold enough storage codes and separators

priority - priority of the field in the object

defaultcolumn - size of column in table expressed in characters

objectdefinition - definition of the parent data object

MultipleChoiceDataObjectFieldDefinition

public MultipleChoiceDataObjectFieldDefinition(java.lang.String name,
                                               java.lang.String displayname,
                                               java.lang.String tooltip,
                                               boolean readonly,
                                               E fieldchoicedefinition,
                                               int storagelength,
                                               int priority,
                                               int defaultcolumn,
                                               DataObjectDefinition<F> objectdefinition)

creates the definition of a multiple choice data object field definition

Parameters:

name - unique name of the field

displayname - label of the field

tooltip - roll-over tooltip

readonly - true if read-only

fieldchoicedefinition - definition of the field choice

storagelength - storage length of the field. Should be able to hold enough storage codes and separators

priority - priority of the field in the object

defaultcolumn - size of column in table expressed in characters

objectdefinition - definition of the parent data object

Method Detail

getFieldchoicedefinition

public E getFieldchoicedefinition()

Returns:

the definition of the choice for this field

getDataFieldDefinition

public SPageNode getDataFieldDefinition()

Specified by:

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

Returns:

the widget to use for display in object

initiateFieldInstance

public DataObjectElement initiateFieldInstance(DataObjectPayload parentpayload)

Specified by:

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

Parameters:

parentpayload - the object payload

Returns:

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

getFlatFileLoaderColumn

public FlatFileLoaderColumn<F> getFlatFileLoaderColumn(DataObjectDefinition<F> 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<F extends DataObject<F>>

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<F extends DataObject<F>>

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<F extends DataObject<F>>

Returns:

the default stored field schema used when searching on this field