org.openlowcode.server.data.properties

Class HasautolinkDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E>,F extends DataObject<F> & AutolinkobjectInterface<F,E>>

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

Type Parameters:

E - object that is linked through the autolink

F - autolink object

All Implemented Interfaces:

NamedInterface

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

Definition of the property of an object having an auto-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
HasautolinkDefinition(DataObjectDefinition<E> parentobject, java.lang.String name, DataObjectDefinition<F> autolinkobjectdefinition) creates an hasautolink definition for the object

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<ExternalFieldSchema<?>>	generateExternalSchema()
protected AutolinkobjectDefinition<F,E>	getAutolinkobjectPropertyDefinition() get autolink object definition on the related 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
java.lang.String[]	getLoaderFieldList()
java.lang.String[]	getLoaderFieldSample(java.lang.String name)
protected DataObjectDefinition<E>	getParent() gets the parent object 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)
void	setDependentDefinitionUniqueidentified(UniqueidentifiedDefinition<E> uniqueidentifieddefinition) sets dependent property definition unique identified
DataObjectPropertyDefinition.FieldSchemaForDisplay<?>[]	setFieldSchemaToDisplay() each property should define the list of fields to display as read-only fields of the object.
void	setGenericsAutolinkobjectProperty(AutolinkobjectDefinition<F,E> autolinkobjectpropertydefinition) sets the related object autolink object definition 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

Constructor Detail

HasautolinkDefinition

public HasautolinkDefinition(DataObjectDefinition<E> parentobject,
                             java.lang.String name,
                             DataObjectDefinition<F> autolinkobjectdefinition)

creates an hasautolink definition for the object

Parameters:

parentobject - definition of the object having the auto-link

name - name of the link

autolinkobjectdefinition - related definition of the object holding the auto-link

Method Detail

getAutolinkobjectPropertyDefinition

protected AutolinkobjectDefinition<F,E> getAutolinkobjectPropertyDefinition()

get autolink object definition on the related link object

Returns:

the auto-link definition of the related link object

getParent

protected DataObjectDefinition<E> getParent()

gets the parent object definition

Returns:

the parent object definition

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<?>[] 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

setGenericsAutolinkobjectProperty

public void setGenericsAutolinkobjectProperty(AutolinkobjectDefinition<F,E> autolinkobjectpropertydefinition)

sets the related object autolink object definition property

Parameters:

autolinkobjectpropertydefinition - autolink object property definition

setDependentDefinitionUniqueidentified

public void setDependentDefinitionUniqueidentified(UniqueidentifiedDefinition<E> uniqueidentifieddefinition)

sets dependent property definition unique identified

Parameters:

uniqueidentifieddefinition - unique identified definition of the 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