org.openlowcode.server.data.properties

Class LinkedtoparentDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E>,F extends DataObject<F>>

java.lang.Object

org.openlowcode.tools.misc.Named

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

org.openlowcode.server.data.DataObjectPropertyDefinition<E>

org.openlowcode.server.data.properties.LinkedtoparentDefinition<E,F>

Type Parameters:

E - this data object

F - the data object of the parent for linkedToParent relationship

All Implemented Interfaces:

NamedInterface

public class LinkedtoparentDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E>,F extends DataObject<F>>
extends DataObjectPropertyDefinition<E>

Definition of the property to link an object to a parent. When this property is set, it is compulsory to link the object, from creation to an existing parent

Author:

Open Lowcode SAS

Nested Class Summary

Nested classes/interfaces inherited from class org.openlowcode.server.data.DataObjectPropertyDefinition

DataObjectPropertyDefinition.ExternalFieldByJoinQuery, DataObjectPropertyDefinition.FieldSchemaForDisplay<E extends DataObject<E>>

Field Summary

Fields inherited from class org.openlowcode.server.data.DataObjectPropertyDefinition

allexternalfields, externalfieldsbyjoinquery, parentobject

Constructor Summary

Constructors

Constructor and Description
LinkedtoparentDefinition(DataObjectDefinition<E> parentobject, java.lang.String name, DataObjectDefinition<F> referenceobjectdefinition) creates a linked to parent definition

Method Summary

Modifier and Type	Method and Description
void	addLinkedToDefaultParentRule(LinkedToDefaultParent<E,F> linkedtodefaultparentrule) sets a linked to default parent rule
java.util.ArrayList<ExternalFieldSchema<?>>	generateExternalSchema()
FlatFileLoaderColumn<E>	getFlatFileLoaderColumn(DataObjectDefinition<E> objectdefinition, java.lang.String[] columnattributes, PropertyExtractor<E> propertyextractor, ChoiceValue<ApplocaleChoiceDefinition> locale) generates the flat file loader for this property
UniqueidentifiedDefinition<F>	getGenericsParentobjectforlinkProperty() gets the unique identified property for the parent object
LinkedToDefaultParent<E,F>	getLinkedToDefaultParentRule() get linked to default parent rule if exists
java.lang.String[]	getLoaderFieldList()
java.lang.String[]	getLoaderFieldSample(java.lang.String name)
DataObjectDefinition<F>	getReferenceObjectDefinition() gets the definition of the parent object
UniqueidentifiedDefinition<E>	getUniqueidentifiedForThisObject() gets unique identified property definition for this data object
QueryCondition	getUniversalQueryCondition(java.lang.String alias) each property can define query conditions to be applied by all other properties on an object.
DataObjectElement	initiateFieldInstance(DataObjectPayload parentpayload)
boolean	isShowlistintable()
boolean	isSubobject()
void	setCompositeIndex(java.lang.String name, DataObjectFieldDefinition<E>[] fields) adds an index with first field the parent id, and other fields as specified here.
void	setDependentDefinitionUniqueidentified(UniqueidentifiedDefinition<E> uniqueidentified) sets unique identified property definition for this data object
DataObjectPropertyDefinition.FieldSchemaForDisplay<E>[]	setFieldSchemaToDisplay() each property should define the list of fields to display as read-only fields of the object.
void	setGenericsParentobjectforlinkProperty(UniqueidentifiedDefinition<F> uniqueidentifiedforparentobjectforlink) sets generic property unique identified for the parent object
void	setSubObject(boolean showlistintable)

Methods inherited from class org.openlowcode.server.data.DataObjectPropertyDefinition

addStoredFieldSchema, getAllExternalFields, getDataObjectFieldDefinition, getExternalFieldsByJoinQueries, getFieldMarker, getParentObject, getTransientLoaderHelper, initiateExternalFieldSchema

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

LinkedtoparentDefinition

public LinkedtoparentDefinition(DataObjectDefinition<E> parentobject,
                                java.lang.String name,
                                DataObjectDefinition<F> referenceobjectdefinition)

creates a linked to parent definition

Parameters:

parentobject - object definition for the current (child) object

name - name of the linked to parent property (should be unique for the object)

referenceobjectdefinition - definition of the parent object for the linked to parent

Method Detail

getReferenceObjectDefinition

public DataObjectDefinition<F> getReferenceObjectDefinition()

gets the definition of the parent object

Returns:

definition of the parent object

addLinkedToDefaultParentRule

public void addLinkedToDefaultParentRule(LinkedToDefaultParent<E,F> linkedtodefaultparentrule)

sets a linked to default parent rule

Parameters:

linkedtodefaultparentrule - new lunked to default parent rule

getLinkedToDefaultParentRule

public LinkedToDefaultParent<E,F> getLinkedToDefaultParentRule()

get linked to default parent rule if exists

Returns:

linked to default parent rule if exists

setCompositeIndex

public void setCompositeIndex(java.lang.String name,
                              DataObjectFieldDefinition<E>[] fields)

adds an index with first field the parent id, and other fields as specified here.

Parameters:

name - name of the index

fields - list of fields to add to the composite index after the parentid.

isSubobject

public boolean isSubobject()

Returns:

true if child object is a subobject of the parent

isShowlistintable

public boolean isShowlistintable()

Returns:

true if shown as list in a table

setSubObject

public void setSubObject(boolean showlistintable)

Parameters:

showlistintable - set shown as list in a table

initiateFieldInstance

public DataObjectElement initiateFieldInstance(DataObjectPayload parentpayload)

Specified by:

initiateFieldInstance in class DataObjectElementDefinition<FieldSchema,E extends DataObject<E> & UniqueidentifiedInterface<E>>

Parameters:

parentpayload - the object payload

Returns:

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

generateExternalSchema

public java.util.ArrayList<ExternalFieldSchema<?>> generateExternalSchema()

Specified by:

generateExternalSchema in class DataObjectPropertyDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E>>

Returns:

get all external fields

setFieldSchemaToDisplay

public DataObjectPropertyDefinition.FieldSchemaForDisplay<E>[] setFieldSchemaToDisplay()

Description copied from class: DataObjectPropertyDefinition

each property should define the list of fields to display as read-only fields of the object. All FieldSchemas referenced here should be the property own field schemas, else an exception will be thrown

Specified by:

setFieldSchemaToDisplay in class DataObjectPropertyDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E>>

Returns:

getGenericsParentobjectforlinkProperty

public UniqueidentifiedDefinition<F> getGenericsParentobjectforlinkProperty()

gets the unique identified property for the parent object

Returns:

unique identified property for the parent object

setGenericsParentobjectforlinkProperty

public void setGenericsParentobjectforlinkProperty(UniqueidentifiedDefinition<F> uniqueidentifiedforparentobjectforlink)

sets generic property unique identified for the parent object

Parameters:

uniqueidentifiedforparentobjectforlink - generic property unique identified for the parent object

getUniversalQueryCondition

public QueryCondition getUniversalQueryCondition(java.lang.String alias)

Description copied from class: DataObjectPropertyDefinition

each property can define query conditions to be applied by all other properties on an object. THis is mostly for properties that archive copy of the object in the table.

Specified by:

getUniversalQueryCondition in class DataObjectPropertyDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E>>

Parameters:

alias - alias for which the query condition should be created;

Returns:

the query condition to apply or null if this property does not require one.

getFlatFileLoaderColumn

public FlatFileLoaderColumn<E> getFlatFileLoaderColumn(DataObjectDefinition<E> objectdefinition,
                                                       java.lang.String[] columnattributes,
                                                       PropertyExtractor<E> propertyextractor,
                                                       ChoiceValue<ApplocaleChoiceDefinition> locale)

Description copied from class: DataObjectPropertyDefinition

generates the flat file loader for this property

Specified by:

getFlatFileLoaderColumn in class DataObjectPropertyDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E>>

Parameters:

objectdefinition - definition of the object

columnattributes - column attributes

propertyextractor - an extractor providing this property from the object

locale - locale if loaded by CSV

Returns:

a flat file loader

getLoaderFieldList

public java.lang.String[] getLoaderFieldList()

Specified by:

getLoaderFieldList in class DataObjectPropertyDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E>>

Returns:

a list of fields for the property

getLoaderFieldSample

public java.lang.String[] getLoaderFieldSample(java.lang.String name)

Specified by:

getLoaderFieldSample in class DataObjectPropertyDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E>>

Parameters:

name - name as returned by the function getLoaderFieldList

Returns:

an array of 4 strings

• full name of the field
• OPTIONAL or MANDATORY
• Sample Values
• Comments including options

getUniqueidentifiedForThisObject

public UniqueidentifiedDefinition<E> getUniqueidentifiedForThisObject()

gets unique identified property definition for this data object

Returns:

unique identified property definition for this data object

setDependentDefinitionUniqueidentified

public void setDependentDefinitionUniqueidentified(UniqueidentifiedDefinition<E> uniqueidentified)

sets unique identified property definition for this data object

Parameters:

uniqueidentified - unique identified property definition for this data object