org.openlowcode.design.data.properties.basic

Class CustomLoader

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.design.data.ObjectElement

org.openlowcode.design.data.Property<CustomLoader>

org.openlowcode.design.data.properties.basic.CustomLoader

All Implemented Interfaces:

NamedInterface

public class CustomLoader
extends Property<CustomLoader>

Defines a custom loader for the flat file / spreadsheet loader

Author:

Open Lowcode SAS

Nested Class Summary

Nested classes/interfaces inherited from class org.openlowcode.design.data.Property

Property.PropertyElementDisplayDefinition

Field Summary

Fields inherited from class org.openlowcode.design.data.Property

FIELDDIPLSAY_TITLE_MOD, FIELDDISPLAY_BOTTOMNOTES, FIELDDISPLAY_NONE, FIELDDISPLAY_NORMAL, FIELDDISPLAY_NORMAL_MOD, FIELDDISPLAY_TITLE, parent

Constructor Summary

Constructors

Constructor and Description
CustomLoader(java.lang.String name) Creates a custom loader for the data object

Method Summary

Modifier and Type	Method and Description
void	generatePropertyHelperToFile(SourceGenerator sg, Module module) Generates in the data folder the property helper.
java.util.ArrayList<DataObjectDefinition>	getExternalObjectDependence()
java.lang.String	getJavaType()
java.lang.String[]	getPropertyDeepCopyStatement() Returns the required deepcopy statement for the property, sends back null if nothing is required.
java.lang.String[]	getPropertyExtractMethod() This method should return non null value only if setCreationDataInputForUpdate() is set
java.lang.String	getPropertyHelperName() A property can have a specific property helper.
java.lang.String[]	getPropertyInitMethod() this method uses the context data for creation and the data-input for standard creation.
boolean	isPropertyHelperTransient()
void	setFinalSettings() an abstract method to be implemented by properties for finalizations to be performed after all data objects have been created.
void	writeDependentClass(SourceGenerator sg, Module module) only send here classes that are NOT data objects.

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

addBusinessRule, addChoiceCategoryHelper, addContextForDataCreation, addDataAccessMethod, addDataInput, addDependentProperty, addDisplayProfileForProperty, addElement, addElement, addElementasSearchElement, addExternalObjectProperty, addFieldOverrides, addMethodAdditionalProcessing, addObjectToAuthorityMapper, addPropertyGenerics, addStringHelper, controlAfterParentDefinition, getBusinessRule, getBusinessRuleByName, getBusinessRuleNumber, getChoiceCategoryByKey, getChoiceCategoryKeyNumber, getChoiceCategoryNumber, getContextDataForCreation, getContextDataForCreationSize, getDataAccessMethod, getDataAccessMethod, getDataAccessMethodnumber, getDataInputForCreation, getDataInputSize, getDataObjectConstructorAttributes, getDataObjectFieldName, getDependentProperties, getDisplayDefinitionForElement, getDisplayProfileForProperty, getDisplayProfileForPropertyNumber, getExternalObject, getExternalObjectProperty, getExternalObjectPropertySize, getFieldOverridesat, getFieldOverridesNumber, getInstancename, getJavaClassType, getMethodAdditionalProcessing, getMethodAdditionalProcessingnumber, getParent, getPropertyclassname, getPropertyGenerics, getPropertyGenericsSize, getPropertyGenericsString, hasDynamicDefinitionHelper, hasInterface, hasStaticQuery, hideDataInputForCreation, isDatainputatbottom, isDataInputHiddenForCreation, isDataInputUsedForUpdate, isLegacy, setAsLegacy, setDatainputatbottom, setDataInputForUpdate, setDynamicDefinitionHelper, setExtraAttributes, writeAdditionalDefinition

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

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

Constructor Detail

CustomLoader

public CustomLoader(java.lang.String name)

Creates a custom loader for the data object

Parameters:

name - a unique name amongst all the custom loaders of this data object (should be a valid java attribute name)

Method Detail

getPropertyInitMethod

public java.lang.String[] getPropertyInitMethod()

Description copied from class: Property

this method uses the context data for creation and the data-input for standard creation. This does not include automatically generated data, but data entered by user and context only.

Specified by:

getPropertyInitMethod in class Property<CustomLoader>

Returns:

a non-null array of size 0 to n with the method and arguments required

getPropertyExtractMethod

public java.lang.String[] getPropertyExtractMethod()

Description copied from class: Property

This method should return non null value only if setCreationDataInputForUpdate() is set

Specified by:

getPropertyExtractMethod in class Property<CustomLoader>

Returns:

a non-null array of size 0 to n with the method and arguments required

getExternalObjectDependence

public java.util.ArrayList<DataObjectDefinition> getExternalObjectDependence()

Specified by:

getExternalObjectDependence in class Property<CustomLoader>

Returns:

a list of data object definitions that are linked to this property. This helps making necessary imports in the data object definition file

setFinalSettings

public void setFinalSettings()

Description copied from class: Property

an abstract method to be implemented by properties for finalizations to be performed after all data objects have been created. THis is especially useful for properties that refer to other data objects (e.g. LinkProperty )

Specified by:

setFinalSettings in class Property<CustomLoader>

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

generatePropertyHelperToFile

public void generatePropertyHelperToFile(SourceGenerator sg,
                                         Module module)
                                  throws java.io.IOException

Description copied from class: Property

Generates in the data folder the property helper.

Overrides:

generatePropertyHelperToFile in class Property<CustomLoader>

Parameters:

sg - source generator

module - parent module

Throws:

java.io.IOException - if any error is encountered writing the source file

getPropertyHelperName

public java.lang.String getPropertyHelperName()

Description copied from class: Property

A property can have a specific property helper. It is generated in the data folder, and is also called at the end of the property definition creator, with the singleton .get method

Overrides:

getPropertyHelperName in class Property<CustomLoader>

Returns:

null if no specific helper, or the helper class name if helper exists

isPropertyHelperTransient

public boolean isPropertyHelperTransient()

Overrides:

isPropertyHelperTransient in class Property<CustomLoader>

Returns:

true if the property has a transient property helper

getPropertyDeepCopyStatement

public java.lang.String[] getPropertyDeepCopyStatement()

Description copied from class: Property

Returns the required deepcopy statement for the property, sends back null if nothing is required.

Specified by:

getPropertyDeepCopyStatement in class Property<CustomLoader>

Returns:

a number of lines of java code