org.openlowcode.server.data.properties

Class IteratedlinkDefinition<E extends DataObject<E> & LinkobjectInterface<E,F,G> & IteratedlinkInterface<E,F,G>,F extends DataObject<F> & IteratedInterface<F>,G extends DataObject<G> & UniqueidentifiedInterface<G>>

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.IteratedlinkDefinition<E,F,G>

Type Parameters:

E - the link object

F - the "left" object of the link

G - the "right" object of the link

All Implemented Interfaces:

NamedInterface

public class IteratedlinkDefinition<E extends DataObject<E> & LinkobjectInterface<E,F,G> & IteratedlinkInterface<E,F,G>,F extends DataObject<F> & IteratedInterface<F>,G extends DataObject<G> & UniqueidentifiedInterface<G>>
extends DataObjectPropertyDefinition<E>

Definition of the property specifying that a link is iterated. This is the case when the left object is iterated. In that case, the link stored the first iteration and last iteration of the left object for which the link is valid. This is an efficient way to store link evolution. Any change in link is also archived as an iteration on the left 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
IteratedlinkDefinition(DataObjectDefinition<E> parentobject, DataObjectDefinition<F> leftiteratedobjectdef, DataObjectDefinition<G> rightobjectdef) creates the definition of an iteation link 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()
DataObjectDefinition<F>	getLeftiteratedobjectdef()
LinkobjectDefinition<E,F,G>	getLinkobject()
java.lang.String[]	getLoaderFieldList()
java.lang.String[]	getLoaderFieldSample(java.lang.String name)
DataObjectDefinition<G>	getRightobjectdef()
UniqueidentifiedDefinition<G>	getRightObjectUniqueidentified() get the property unique identified on related right object for 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	setDependentDefinitionLinkobject(LinkobjectDefinition<E,F,G> linkobject) sets the dependent property link object
DataObjectPropertyDefinition.FieldSchemaForDisplay<E>[]	setFieldSchemaToDisplay() each property should define the list of fields to display as read-only fields of the object.
void	setGenericsLeftobjectforlinkProperty(IteratedDefinition<F> iterateddefinition) sets the dependent property iterated on the left object for the link
void	setGenericsRightobjectforlinkProperty(UniqueidentifiedDefinition<G> uniqueidentifiedDefinition) sets the property unique identified on related right object for link

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

IteratedlinkDefinition

public IteratedlinkDefinition(DataObjectDefinition<E> parentobject,
                              DataObjectDefinition<F> leftiteratedobjectdef,
                              DataObjectDefinition<G> rightobjectdef)

creates the definition of an iteation link property

Parameters:

parentobject - current link data object

leftiteratedobjectdef - definition of left object for link

rightobjectdef - definition of right object

Method Detail

generateExternalSchema

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

Specified by:

generateExternalSchema in class DataObjectPropertyDefinition<E extends DataObject<E> & LinkobjectInterface<E,F,G> & IteratedlinkInterface<E,F,G>>

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> & LinkobjectInterface<E,F,G> & IteratedlinkInterface<E,F,G>>

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> & LinkobjectInterface<E,F,G> & IteratedlinkInterface<E,F,G>>

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> & LinkobjectInterface<E,F,G> & IteratedlinkInterface<E,F,G>>

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> & LinkobjectInterface<E,F,G> & IteratedlinkInterface<E,F,G>>

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> & LinkobjectInterface<E,F,G> & IteratedlinkInterface<E,F,G>>

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> & LinkobjectInterface<E,F,G> & IteratedlinkInterface<E,F,G>>

Parameters:

parentpayload - the object payload

Returns:

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

setDependentDefinitionLinkobject

public void setDependentDefinitionLinkobject(LinkobjectDefinition<E,F,G> linkobject)

sets the dependent property link object

Parameters:

linkobject - dependent property link object

setGenericsLeftobjectforlinkProperty

public void setGenericsLeftobjectforlinkProperty(IteratedDefinition<F> iterateddefinition)

sets the dependent property iterated on the left object for the link

Parameters:

iterateddefinition - dependent property iterated on the left object for the link

getLeftiteratedobjectdef

public DataObjectDefinition<F> getLeftiteratedobjectdef()

Returns:

get the left object for link definition

getRightobjectdef

public DataObjectDefinition<G> getRightobjectdef()

Returns:

get the right object for link definition

getLinkobject

public LinkobjectDefinition<E,F,G> getLinkobject()

Returns:

get the link object property definition

getIterateddefinition

public IteratedDefinition<F> getIterateddefinition()

Returns:

get the iterated definition for the left object for the link

setGenericsRightobjectforlinkProperty

public void setGenericsRightobjectforlinkProperty(UniqueidentifiedDefinition<G> uniqueidentifiedDefinition)

sets the property unique identified on related right object for link

Parameters:

uniqueidentifiedDefinition - unique identified property definition

getRightObjectUniqueidentified

public UniqueidentifiedDefinition<G> getRightObjectUniqueidentified()

get the property unique identified on related right object for link

Returns:

unique identified property definition on the right object