org.openlowcode.server.data.properties

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

Type Parameters:

E - current object (left for link)

F - data object holding the link

G - right data object for link

All Implemented Interfaces:

NamedInterface

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

the property that is put on the left object for a link

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

Constructor Summary

Constructors

Constructor and Description
LeftforlinkDefinition(DataObjectDefinition<E> parentobject, java.lang.String name, DataObjectDefinition<F> linkobjectdefinition, DataObjectDefinition<G> rightobjectforlinkdefinition) creates the definition of the data object link

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
LinkobjectDefinition<F,E,G>	getLinkObjectPropertyDefinition() get the link object property definition for the linked object
java.lang.String[]	getLoaderFieldList()
java.lang.String[]	getLoaderFieldSample(java.lang.String name)
DataObjectDefinition<E>	getParentObject()
UniqueidentifiedDefinition<E>	getUniqueIdentifiedDefinition() gets the unique identified property definition on the data object on the left for the link
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)
void	setDependentDefinitionUniqueidentified(UniqueidentifiedDefinition<E> uniqueidentifieddefinition) sets the dependent property UniqueIdentified
DataObjectPropertyDefinition.FieldSchemaForDisplay<E>[]	setFieldSchemaToDisplay() each property should define the list of fields to display as read-only fields of the object.
void	setGenericsLinkobjectProperty(LinkobjectDefinition<F,E,G> linkobjectpropertydefinition) sets the link object property on the data object holding the link
void	setGenericsRightobjectforlinkProperty(UniqueidentifiedDefinition<G> uniqueidentifiedforrightobject) sets the unique identified property for the link

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

addStoredFieldSchema, getAllExternalFields, getDataObjectFieldDefinition, getExternalFieldsByJoinQueries, getFieldMarker, 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

LeftforlinkDefinition

public LeftforlinkDefinition(DataObjectDefinition<E> parentobject,
                             java.lang.String name,
                             DataObjectDefinition<F> linkobjectdefinition,
                             DataObjectDefinition<G> rightobjectforlinkdefinition)

creates the definition of the data object link

Parameters:

parentobject - parent data object definition

name - name of the link

linkobjectdefinition - definition of the data object for the link

rightobjectforlinkdefinition - definition of the right data object for the link

Method Detail

getParentObject

public DataObjectDefinition<E> getParentObject()

Overrides:

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

Returns:

the parent DataObjectDefinition this property definition is a part of

getLinkObjectPropertyDefinition

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

get the link object property definition for the linked object

Returns:

the link object property

setGenericsLinkobjectProperty

public void setGenericsLinkobjectProperty(LinkobjectDefinition<F,E,G> linkobjectpropertydefinition)

sets the link object property on the data object holding the link

Parameters:

linkobjectpropertydefinition -

getUniqueIdentifiedDefinition

public UniqueidentifiedDefinition<E> getUniqueIdentifiedDefinition()

gets the unique identified property definition on the data object on the left for the link

Returns:

the unique identified property

setDependentDefinitionUniqueidentified

public void setDependentDefinitionUniqueidentified(UniqueidentifiedDefinition<E> uniqueidentifieddefinition)

sets the dependent property UniqueIdentified

Parameters:

uniqueidentifieddefinition - dependent property unique identified

setGenericsRightobjectforlinkProperty

public void setGenericsRightobjectforlinkProperty(UniqueidentifiedDefinition<G> uniqueidentifiedforrightobject)

sets the unique identified property for the link

Parameters:

uniqueidentifiedforrightobject - unique identified property for the right object for the link

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:

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

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