org.openlowcode.design.data.properties.basic

Class LinkedToParent<E extends DataObjectDefinition>

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.design.data.ObjectElement

org.openlowcode.design.data.Property<LinkedToParent<E>>

org.openlowcode.design.data.properties.basic.LinkedToParent<E>

All Implemented Interfaces:

NamedInterface

public class LinkedToParent<E extends DataObjectDefinition>
extends Property<LinkedToParent<E>>

This property provides a link to a parent object. In parent / children relations, a parent can have several children, but the child will have only one parent.

Parent object will get automatically the property LinkedFromChildren
Dependent property : UniqueIdentified

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
LinkedToParent(java.lang.String name, E parentobjectforlink) creates a linked to parent property
LinkedToParent(java.lang.String name, E parentobjectforlink, java.lang.String linedisplayforgrid, java.lang.String columndisplayforgrid, java.lang.String secondarycolumndisplayforgrid, java.lang.String[] cellvaluestoshow) creates a linked to parent property with the children objects shown from the parent as a grid
LinkedToParent(java.lang.String name, E parentobjectforlink, WidgetDisplayPriority priorityforlinkedfromparent) creates a linked to parent property with specific widget priority
LinkedToParent(java.lang.String name, E parentobjectforlink, WidgetDisplayPriority priorityforlinkedfromparent, java.lang.String linedisplayforgrid, java.lang.String columndisplayforgrid, java.lang.String secondarycolumndisplayforgrid, java.lang.String[] cellvaluestoshow) creates a linked to parent property with the children objects shown from the parent as a grid with a specific widget display priority

Method Summary

Modifier and Type	Method and Description
void	addActionOnParentId(DynamicActionDefinition action) adds an action that will display as a button in the object page
void	addCompositeIndex(java.lang.String indexname, Field[] fieldstoask) This method will create in the database a composite index for search including as first field the parent id, and the specified fields in order
void	controlAfterParentDefinition() to be implemented if controls have to be performed after parent is added.
java.util.ArrayList<DataObjectDefinition>	getExternalObjectDependence()
java.lang.String	getJavaType()
LinkedFromChildren	getLinkedFromChildren()
java.lang.String	getLinkedFromChildrenName()
E	getParentObjectForLink()
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[]	getPropertyInitMethod() this method uses the context data for creation and the data-input for standard creation.
UniqueIdentified	getUniqueIdentified() gets the unique identified property on the child object the linked to parent property is on
boolean	isSubobject()
void	setFinalSettings() an abstract method to be implemented by properties for finalizations to be performed after all data objects have been created.
void	setSpecificTitleForChildrenTable(java.lang.String specifictitleforchildrentable)
void	writeAdditionalDefinition(SourceGenerator sg) This method allows a property to define extra conditions when writing additional definition on the property
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, generatePropertyHelperToFile, 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, getPropertyHelperName, hasDynamicDefinitionHelper, hasInterface, hasStaticQuery, hideDataInputForCreation, isDatainputatbottom, isDataInputHiddenForCreation, isDataInputUsedForUpdate, isLegacy, isPropertyHelperTransient, setAsLegacy, setDatainputatbottom, setDataInputForUpdate, setDynamicDefinitionHelper, setExtraAttributes

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

LinkedToParent

public LinkedToParent(java.lang.String name,
                      E parentobjectforlink)

creates a linked to parent property

Parameters:

name - unique name amongst the linked to parent properties of this object. Should be a valid java field name

parentobjectforlink - the parent object the main object is linked to

LinkedToParent

public LinkedToParent(java.lang.String name,
                      E parentobjectforlink,
                      WidgetDisplayPriority priorityforlinkedfromparent)

creates a linked to parent property with specific widget priority

Parameters:

name - unique name amongst the linked to parent properties of this object. Should be a valid java field name

parentobjectforlink - the parent object the main object is linked to

priorityforlinkedfromparent - widget priority on the parent object for the children table

LinkedToParent

public LinkedToParent(java.lang.String name,
                      E parentobjectforlink,
                      java.lang.String linedisplayforgrid,
                      java.lang.String columndisplayforgrid,
                      java.lang.String secondarycolumndisplayforgrid,
                      java.lang.String[] cellvaluestoshow)

creates a linked to parent property with the children objects shown from the parent as a grid

Parameters:

name - unique name amongst the linked to parent properties of this object. Should be a valid java field name

parentobjectforlink - the parent object the main object is linked to

linedisplayforgrid - the column used for line display

columndisplayforgrid - the column used for column display

secondarycolumndisplayforgrid - the column used for secondary column display (leave it null if not used)

cellvaluestoshow - the name of the fields to show as content in the grid

LinkedToParent

public LinkedToParent(java.lang.String name,
                      E parentobjectforlink,
                      WidgetDisplayPriority priorityforlinkedfromparent,
                      java.lang.String linedisplayforgrid,
                      java.lang.String columndisplayforgrid,
                      java.lang.String secondarycolumndisplayforgrid,
                      java.lang.String[] cellvaluestoshow)

creates a linked to parent property with the children objects shown from the parent as a grid with a specific widget display priority

Parameters:

name - unique name amongst the linked to parent properties of this object. Should be a valid java field name

parentobjectforlink - the parent object the main object is linked to

priorityforlinkedfromparent - the priority for the grid display on the parent object

linedisplayforgrid - the column used for line display

columndisplayforgrid - the column used for column display

secondarycolumndisplayforgrid - the column used for secondary column display (leave it null if not used)

cellvaluestoshow - the name of the fields to show as content in the grid

Method Detail

getUniqueIdentified

public UniqueIdentified getUniqueIdentified()

gets the unique identified property on the child object the linked to parent property is on

Returns:

the related unique identified property on the current object (child for the linkedtoparent)

getLinkedFromChildrenName

public java.lang.String getLinkedFromChildrenName()

Returns:

the name of the related property LinkedFromChildren on the parent object

setSpecificTitleForChildrenTable

public void setSpecificTitleForChildrenTable(java.lang.String specifictitleforchildrentable)

Parameters:

specifictitleforchildrentable - specifies the title for the children table in parent object

getLinkedFromChildren

public LinkedFromChildren getLinkedFromChildren()

Returns:

the related linked from children property on the parent object

controlAfterParentDefinition

public void controlAfterParentDefinition()

Description copied from class: Property

to be implemented if controls have to be performed after parent is added.

Overrides:

controlAfterParentDefinition in class Property<LinkedToParent<E extends DataObjectDefinition>>

getParentObjectForLink

public E getParentObjectForLink()

Returns:

the paret object for the linked to parent property

isSubobject

public boolean isSubobject()

Returns:

true if the child object is a sub-object, meaning it will be part of the parent object data. E.g. changes the update log of the parent object

addActionOnParentId

public void addActionOnParentId(DynamicActionDefinition action)

adds an action that will display as a button in the object page

Parameters:

action - an action with a unique input argument being the parent data object id

addCompositeIndex

public void addCompositeIndex(java.lang.String indexname,
                              Field[] fieldstoask)

This method will create in the database a composite index for search including as first field the parent id, and the specified fields in order

Parameters:

indexname -

fieldstoask - fields to add in the composite index

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<LinkedToParent<E extends DataObjectDefinition>>

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<LinkedToParent<E extends DataObjectDefinition>>

Returns:

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

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<LinkedToParent<E extends DataObjectDefinition>>

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<LinkedToParent<E extends DataObjectDefinition>>

Returns:

a number of lines of java code

writeAdditionalDefinition

public void writeAdditionalDefinition(SourceGenerator sg)
                               throws java.io.IOException

Description copied from class: Property

This method allows a property to define extra conditions when writing additional definition on the property

Overrides:

writeAdditionalDefinition in class Property<LinkedToParent<E extends DataObjectDefinition>>

Parameters:

sg - source generator

Throws:

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

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

getExternalObjectDependence

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

Specified by:

getExternalObjectDependence in class Property<LinkedToParent<E extends DataObjectDefinition>>

Returns:

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