org.openlowcode.server.data.properties

Class IteratedsubobjectDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E> & IteratedsubobjectInterface<E,F>,F extends DataObject<F> & IteratedInterface<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.IteratedsubobjectDefinition<E,F>

Type Parameters:

E - sub object

F - parent of the subobject

All Implemented Interfaces:

NamedInterface

public class IteratedsubobjectDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E> & IteratedsubobjectInterface<E,F>,F extends DataObject<F> & IteratedInterface<F>>
extends DataObjectPropertyDefinition<E>

Definition of an iterated subobject: a child of a main object that is considered as part of the data set of the parent data object. Thus, any change on the subobject will result in an iteration of the parent object

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

Modifier and Type	Field and Description
static int	INFINITY

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

allexternalfields, externalfieldsbyjoinquery, parentobject

Constructor Summary

Constructors

Constructor and Description
IteratedsubobjectDefinition(DataObjectDefinition<E> parentobject, DataObjectDefinition<F> parentiteratedobjectdef) creates the definition of an iterated subobject property

Method Summary

Modifier and Type	Method and Description
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
IteratedDefinition<F>	getIterateddefinition() gets the definition of the iterated property
LinkedtoparentDefinition<E,F>	getLinkedtoparent() gets the related linked to parent property of the current (subobject) data object property
java.lang.String[]	getLoaderFieldList()
java.lang.String[]	getLoaderFieldSample(java.lang.String name)
DataObjectDefinition<F>	getParentiteratedobjectdef() gets the definition of the parent data object for the parent child link
QueryCondition	getUniversalQueryCondition(java.lang.String aliasstring) each property can define query conditions to be applied by all other properties on an object.
DataObjectElement	initiateFieldInstance(DataObjectPayload parentpayload)
void	setDependentDefinitionLinkedtoparent(LinkedtoparentDefinition<E,F> linkedtoparent) definition of the related linked to parent property on this object (the subobject)
DataObjectPropertyDefinition.FieldSchemaForDisplay<E>[]	setFieldSchemaToDisplay() each property should define the list of fields to display as read-only fields of the object.
void	setGenericsParentProperty(IteratedDefinition<F> iterateddefinition) definition of the parent object (for the parent-child link) iterated property

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

Field Detail

INFINITY

public static final int INFINITY

See Also:

Constant Field Values

Constructor Detail

IteratedsubobjectDefinition

public IteratedsubobjectDefinition(DataObjectDefinition<E> parentobject,
                                   DataObjectDefinition<F> parentiteratedobjectdef)

creates the definition of an iterated subobject property

Parameters:

parentobject - data object definition of the sub object

parentiteratedobjectdef - data object definition of the iterated parent data object

Method Detail

generateExternalSchema

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

Specified by:

generateExternalSchema in class DataObjectPropertyDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E> & IteratedsubobjectInterface<E,F>>

Returns:

get all external fields

getUniversalQueryCondition

public QueryCondition getUniversalQueryCondition(java.lang.String aliasstring)

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> & IteratedsubobjectInterface<E,F>>

Parameters:

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

Returns:

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

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> & IteratedsubobjectInterface<E,F>>

Returns:

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> & IteratedsubobjectInterface<E,F>>

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> & IteratedsubobjectInterface<E,F>>

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> & IteratedsubobjectInterface<E,F>>

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

initiateFieldInstance

public DataObjectElement initiateFieldInstance(DataObjectPayload parentpayload)

Specified by:

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

Parameters:

parentpayload - the object payload

Returns:

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

setDependentDefinitionLinkedtoparent

public void setDependentDefinitionLinkedtoparent(LinkedtoparentDefinition<E,F> linkedtoparent)

definition of the related linked to parent property on this object (the subobject)

Parameters:

linkedtoparent - linked to parent property)

setGenericsParentProperty

public void setGenericsParentProperty(IteratedDefinition<F> iterateddefinition)

definition of the parent object (for the parent-child link) iterated property

Parameters:

iterateddefinition - parent object for link iterated property

getParentiteratedobjectdef

public DataObjectDefinition<F> getParentiteratedobjectdef()

gets the definition of the parent data object for the parent child link

Returns:

the definition of parent data object

getLinkedtoparent

public LinkedtoparentDefinition<E,F> getLinkedtoparent()

gets the related linked to parent property of the current (subobject) data object property

Returns:

the linked to parent property

getIterateddefinition

public IteratedDefinition<F> getIterateddefinition()

gets the definition of the iterated property

Returns:

definition of the iteratd property