org.openlowcode.server.data

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

Type Parameters:

E - parent data object

All Implemented Interfaces:

NamedInterface

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

Definition of a data object field of a data object where payload is a binary content (typically a file). Files can be big. It is recommended to use data objects with binary content only to store binary, as accessing data objects with binary content to perform processing not involving those binary files is likely to be sub-optimal

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
LargeBinaryDataObjectFieldDefinition(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, DataObjectDefinition<E> objectdefinition) Defines a large binary field in a data object
LargeBinaryDataObjectFieldDefinition(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, int maxlength, DataObjectDefinition<E> objectdefinition) Defines a large binary field in a data object with specified maximum size for the binary

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()
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

LargeBinaryDataObjectFieldDefinition

public LargeBinaryDataObjectFieldDefinition(java.lang.String name,
                                            java.lang.String displayname,
                                            java.lang.String tooltip,
                                            DataObjectDefinition<E> objectdefinition)

Defines a large binary field in a data object

Parameters:

name - unique name for the field in the data object

displayname - label of the field in default language

tooltip - tooltip shown with mouse roll-over

objectdefinition - parent data object definition

LargeBinaryDataObjectFieldDefinition

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

Defines a large binary field in a data object with specified maximum size for the binary

Parameters:

name - unique name for the field in the data object

displayname - label of the field in default language

tooltip - tooltip shown with mouse roll-over

maxlength - maximum length of the binary field

objectdefinition - parent data object definition

Method Detail

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

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

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