org.openlowcode.server.data.properties

Class LinkobjectDefinition<E extends DataObject<E> & LinkobjectInterface<E,F,G>,F extends DataObject<F> & UniqueidentifiedInterface<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.LinkobjectDefinition<E,F,G>

Type Parameters:

E - link object

F - object at left of link

G - object at right of link

All Implemented Interfaces:

NamedInterface

public class LinkobjectDefinition<E extends DataObject<E> & LinkobjectInterface<E,F,G>,F extends DataObject<F> & UniqueidentifiedInterface<F>,G extends DataObject<G> & UniqueidentifiedInterface<G>>
extends DataObjectPropertyDefinition<E>

Definition of the property making this data object a link 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 inherited from class org.openlowcode.server.data.DataObjectPropertyDefinition

allexternalfields, externalfieldsbyjoinquery, parentobject

Constructor Summary

Constructors

Constructor and Description
LinkobjectDefinition(DataObjectDefinition<E> parentobject, DataObjectDefinition<F> leftobjectdefinition, DataObjectDefinition<G> rightobjectdefinition) creates the definition of the link object property that turns this data object into a link between a left data object and a right data object
LinkobjectDefinition(DataObjectDefinition<E> parentobject, DataObjectDefinition<F> leftobjectdefinition, DataObjectDefinition<G> rightobjectdefinition, int showleftfieldswithpriority, int showrightfieldswithpriority) creates the definition of the link object property that turns this data object into a link between a left data object and a right data object

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<ExternalFieldSchema<?>>	generateExternalSchema()
ConstraintOnLinkObject<F,G>[]	getAllConstraints() gets all the constraints at once
ConstraintOnLinkObject<F,G>	getConstraintOnLinkObject(int index) gets the constraint at the given index
int	getConstraintOnLinkObjectNumber() gets the number of constraints for the link object
FlatFileLoaderColumn<E>	getFlatFileLoaderColumn(DataObjectDefinition<E> objectdefinition, java.lang.String[] columnattributes, PropertyExtractor<E> propertyextractor, ChoiceValue<ApplocaleChoiceDefinition> locale) generates the flat file loader for this property
protected DataObjectDefinition<F>	getLeftObjectDefinition()
UniqueidentifiedDefinition<F>	getLeftuniqueidentifieddefinition()
DataObjectDefinition<E>	getLinkObjectDefinition()
java.lang.String[]	getLoaderFieldList()
java.lang.String[]	getLoaderFieldSample(java.lang.String name)
protected DataObjectDefinition<G>	getRightObjectDefinition()
UniqueidentifiedDefinition<G>	getRightuniqueidentifieddefinition()
UniqueidentifiedDefinition<E>	getUniqueidentifiedDefinitionForLinkObject() gets the related uniqueidentified definition
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	isMaxOneLinkFromLeft() if this property is set, only one link is allowed from a given left object
boolean	isReplaceifmorethanonefromleft() if this property is set, will replace existing link if a link is already existing from the left object
boolean	isReplaceIfNotUniqueForLeftAndRight() if this property is set, will replace existing link if new link is created between two objects
boolean	isUniqueForLeftAndRight() if the link is unique for left and right, only one link is allowed between two objects
void	setContraintOnLinkObject(ConstraintOnLinkObject<F,G> constraintonlinkobject) sets a constraint on link object (restricts the objects that can be linked together
void	setDependentDefinitionUniqueidentified(UniqueidentifiedDefinition<E> uniqueidentifieddefinition) sets the dependent property unique identified for the 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(UniqueidentifiedDefinition<F> leftuniqueidentifieddefinition) sets the related unique identified property for the left object
void	setGenericsRightobjectforlinkProperty(UniqueidentifiedDefinition<G> rightuniqueidentifieddefinition) sets the related unique identified property for the right object
void	setMaxOneLinkFromLeft(boolean replaceifmorethanone) if this property is set, only one link is authorized from left object
void	setUniqueForLeftAndRight(boolean replaceifmorethanone) if this parameter is set, only one link is allowed between two objects

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

LinkobjectDefinition

public LinkobjectDefinition(DataObjectDefinition<E> parentobject,
                            DataObjectDefinition<F> leftobjectdefinition,
                            DataObjectDefinition<G> rightobjectdefinition,
                            int showleftfieldswithpriority,
                            int showrightfieldswithpriority)

creates the definition of the link object property that turns this data object into a link between a left data object and a right data object

Parameters:

parentobject - parent object definition

leftobjectdefinition - definition of the left object for link

rightobjectdefinition - definition of the right object for link

showleftfieldswithpriority - if set, left fields above the priority are shown on the link

showrightfieldswithpriority - if set, right fields above the priority are shown on the link

LinkobjectDefinition

public LinkobjectDefinition(DataObjectDefinition<E> parentobject,
                            DataObjectDefinition<F> leftobjectdefinition,
                            DataObjectDefinition<G> rightobjectdefinition)

creates the definition of the link object property that turns this data object into a link between a left data object and a right data object

Parameters:

parentobject - parent object definition

leftobjectdefinition - definition of the left object for link

rightobjectdefinition - definition of the right object for link

Method Detail

getRightObjectDefinition

protected DataObjectDefinition<G> getRightObjectDefinition()

Returns:

getLeftObjectDefinition

protected DataObjectDefinition<F> getLeftObjectDefinition()

Returns:

getLinkObjectDefinition

public DataObjectDefinition<E> getLinkObjectDefinition()

getUniqueidentifiedDefinitionForLinkObject

public UniqueidentifiedDefinition<E> getUniqueidentifiedDefinitionForLinkObject()

gets the related uniqueidentified definition

Returns:

the related uniqueidentified property definition

setMaxOneLinkFromLeft

public void setMaxOneLinkFromLeft(boolean replaceifmorethanone)

if this property is set, only one link is authorized from left object

Parameters:

replaceifmorethanone - true if the link will replace if more than one

setUniqueForLeftAndRight

public void setUniqueForLeftAndRight(boolean replaceifmorethanone)

if this parameter is set, only one link is allowed between two objects

Parameters:

replaceifmorethanone - true if a new link created will replace the older ones

isUniqueForLeftAndRight

public boolean isUniqueForLeftAndRight()

if the link is unique for left and right, only one link is allowed between two objects

Returns:

true if 'UniqueForLeftAndRight' behaviour is set

isReplaceIfNotUniqueForLeftAndRight

public boolean isReplaceIfNotUniqueForLeftAndRight()

if this property is set, will replace existing link if new link is created between two objects

Returns:

if the 'replaceIfNotUniqueForLeftAndRight' property is set

isMaxOneLinkFromLeft

public boolean isMaxOneLinkFromLeft()

if this property is set, only one link is allowed from a given left object

Returns:

true if only one link is allowed from left object

isReplaceifmorethanonefromleft

public boolean isReplaceifmorethanonefromleft()

if this property is set, will replace existing link if a link is already existing from the left object

Returns:

true if replacing existing link from left object

setContraintOnLinkObject

public void setContraintOnLinkObject(ConstraintOnLinkObject<F,G> constraintonlinkobject)

sets a constraint on link object (restricts the objects that can be linked together

Parameters:

constraintonlinkobject - the constraint

getConstraintOnLinkObject

public ConstraintOnLinkObject<F,G> getConstraintOnLinkObject(int index)

gets the constraint at the given index

Parameters:

index - an index between 0 (included) and getConstraintOnLinkObjectNumber (excluded)

Returns:

the constraint at the given index

getConstraintOnLinkObjectNumber

public int getConstraintOnLinkObjectNumber()

gets the number of constraints for the link object

Returns:

the number of constraints for the link object

setGenericsLeftobjectforlinkProperty

public void setGenericsLeftobjectforlinkProperty(UniqueidentifiedDefinition<F> leftuniqueidentifieddefinition)

sets the related unique identified property for the left object

Parameters:

leftuniqueidentifieddefinition - unique identified property for the left object

setGenericsRightobjectforlinkProperty

public void setGenericsRightobjectforlinkProperty(UniqueidentifiedDefinition<G> rightuniqueidentifieddefinition)

sets the related unique identified property for the right object

Parameters:

rightuniqueidentifieddefinition - unique identified property for the right object

getLeftuniqueidentifieddefinition

public UniqueidentifiedDefinition<F> getLeftuniqueidentifieddefinition()

Returns:

the unique identified property for the left object

getRightuniqueidentifieddefinition

public UniqueidentifiedDefinition<G> getRightuniqueidentifieddefinition()

Returns:

the unique identified property for the right object

setDependentDefinitionUniqueidentified

public void setDependentDefinitionUniqueidentified(UniqueidentifiedDefinition<E> uniqueidentifieddefinition)

sets the dependent property unique identified for the link object

Parameters:

uniqueidentifieddefinition - unique identified property for the left object

getAllConstraints

public ConstraintOnLinkObject<F,G>[] getAllConstraints()

gets all the constraints at once

Returns:

all the constraints in an array

generateExternalSchema

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

Specified by:

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

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

Returns:

initiateFieldInstance

public DataObjectElement initiateFieldInstance(DataObjectPayload parentpayload)

Specified by:

initiateFieldInstance in class DataObjectElementDefinition<FieldSchema,E extends DataObject<E> & LinkobjectInterface<E,F,G>>

Parameters:

parentpayload - the object payload

Returns:

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

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

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> & LinkobjectInterface<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>>

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>>

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