org.openlowcode.server.data

Class StringDataObjectFieldDefinition<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.StringDataObjectFieldDefinition<E>

Type Parameters:

E -

All Implemented Interfaces:

NamedInterface

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

The definition of a persisted string field on a data object

Author:

Open Lowcode SAS

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EASY_SEARCH_FIELD_SUFFIX

Constructor Summary

Constructors

Constructor and Description
StringDataObjectFieldDefinition(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, int maxlength, boolean easysearch, boolean readonly, boolean showintitle, boolean showinbottompage, DataObjectDefinition<E> objectdefinition) creates a string data object field that can be read-only, shown in title or shown in bottom notes
StringDataObjectFieldDefinition(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, int maxlength, boolean easysearch, boolean readonly, boolean showintitle, boolean showinbottompage, int priority, int defaultcolumn, boolean richtextedit, DataObjectDefinition<E> objectdefinition)
StringDataObjectFieldDefinition(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, int maxlength, boolean easysearch, boolean readonly, DataObjectDefinition<E> objectdefinition)
StringDataObjectFieldDefinition(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, int maxlength, boolean easysearch, DataObjectDefinition<E> objectdefinition) creates a read-write field with default display on a data object

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	getMaxlength()
DataObjectField	initiateFieldInstance(DataObjectPayload parentpayload)
boolean	isEasysearch()
boolean	isRichtextedit()
void	setOrderedAsInteger(int offset) this feature can be used to order the field as an integer, if the string field is in the shape of a prefix and then numbers (e.g.

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

Field Detail

EASY_SEARCH_FIELD_SUFFIX

public static final java.lang.String EASY_SEARCH_FIELD_SUFFIX

See Also:

Constant Field Values

Constructor Detail

StringDataObjectFieldDefinition

public StringDataObjectFieldDefinition(java.lang.String name,
                                       java.lang.String displayname,
                                       java.lang.String tooltip,
                                       int maxlength,
                                       boolean easysearch,
                                       DataObjectDefinition<E> objectdefinition)

creates a read-write field with default display on a data object

Parameters:

name - unique name of the field (only characters, short)

displayname - display label on the user interface for the field

tooltip - tooltip for roll-over mouse

maxlength - maximum length of the field in characters

easysearch - if true, provides easy search feature

objectdefinition - definition of the parent data object

StringDataObjectFieldDefinition

public StringDataObjectFieldDefinition(java.lang.String name,
                                       java.lang.String displayname,
                                       java.lang.String tooltip,
                                       int maxlength,
                                       boolean easysearch,
                                       boolean readonly,
                                       boolean showintitle,
                                       boolean showinbottompage,
                                       DataObjectDefinition<E> objectdefinition)

creates a string data object field that can be read-only, shown in title or shown in bottom notes

Parameters:

name - unique name of the field (only characters, short)

displayname - display label on the user interface for the field

tooltip - tooltip for roll-over mouse

maxlength - maximum length of the field in characters

easysearch - if true, provides easy search feature

readonly - if true, field is read-only

showintitle - if true, field is shown both in title and main object display

showinbottompage - if true, field is shown only in bottom notes

objectdefinition - parent data object definition

StringDataObjectFieldDefinition

public StringDataObjectFieldDefinition(java.lang.String name,
                                       java.lang.String displayname,
                                       java.lang.String tooltip,
                                       int maxlength,
                                       boolean easysearch,
                                       boolean readonly,
                                       DataObjectDefinition<E> objectdefinition)

Parameters:

name - unique name of the field (only characters, short)

displayname - display label on the user interface for the field

tooltip - tooltip for roll-over mouse

maxlength - maximum length of the field in characters

easysearch - if true, provides easy search feature

readonly - if true, field is read-only

objectdefinition - parent data object definition

StringDataObjectFieldDefinition

public StringDataObjectFieldDefinition(java.lang.String name,
                                       java.lang.String displayname,
                                       java.lang.String tooltip,
                                       int maxlength,
                                       boolean easysearch,
                                       boolean readonly,
                                       boolean showintitle,
                                       boolean showinbottompage,
                                       int priority,
                                       int defaultcolumn,
                                       boolean richtextedit,
                                       DataObjectDefinition<E> objectdefinition)

Parameters:

name - unique name of the field (only characters, short)

displayname - display label on the user interface for the field

tooltip - tooltip for roll-over mouse

maxlength - maximum length of the field in characters

easysearch - if true, provides easy search feature

readonly - if true, field is read-only

showintitle - if true, field is shown both in title and main object display

showinbottompage - if true, field is shown only in bottom notes

priority - field priority,a number between -1000 and 1000

defaultcolumn - size of the field in characters when displayed in table

richtextedit - if true, field is rich text (allows some limited formatting)

objectdefinition - parent data object definition

Method Detail

setOrderedAsInteger

public void setOrderedAsInteger(int offset)

this feature can be used to order the field as an integer, if the string field is in the shape of a prefix and then numbers (e.g. T-1, T-11 ...). This feature is important, as in this case, alphanumeric ordering will not work (you get 1, 11, 2, 3, 31, 4)

Parameters:

offset - size of the text prefix before the number sequence.

getMaxlength

public int getMaxlength()

Returns:

isEasysearch

public boolean isEasysearch()

Returns:

initiateFieldInstance

public DataObjectField 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

getDataFieldDefinition

public SPageNode getDataFieldDefinition()

Specified by:

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

Returns:

the widget to use for display in object

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

isRichtextedit

public boolean isRichtextedit()

Returns:

true if field is rich text