org.openlowcode.server.data.properties

Class TriggerDefinition<E extends DataObject<E> & UniqueidentifiedInterface<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.TriggerDefinition<E>

Type Parameters:

E - the parent data object

All Implemented Interfaces:

NamedInterface

public class TriggerDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E>>
extends DataObjectPropertyDefinition<E>

Definition of an object that has a trigger. The trigger will be kicked at a specific condition (typically insert, update, or set state)

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
TriggerDefinition(DataObjectDefinition<E> parentobject, java.lang.String triggername, TriggerCondition<E> triggercondition, CustomTriggerExecutionFactory<E> triggerexecution) creates the trigger definition

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
java.lang.String[]	getLoaderFieldList()
java.lang.String[]	getLoaderFieldSample(java.lang.String name)
TriggerCondition<E>	getTriggerCondition() gets the condition for trigger kick
CustomTriggerExecutionFactory<E>	getTriggerExecution() gets the trigger execution factory
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 definition unique-identified
DataObjectPropertyDefinition.FieldSchemaForDisplay<E>[]	setFieldSchemaToDisplay() each property should define the list of fields to display as read-only fields of the object.

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

TriggerDefinition

public TriggerDefinition(DataObjectDefinition<E> parentobject,
                         java.lang.String triggername,
                         TriggerCondition<E> triggercondition,
                         CustomTriggerExecutionFactory<E> triggerexecution)

creates the trigger definition

Parameters:

parentobject - object

triggername - name (object can have several triggers of different names)

triggercondition - condition to kick the trigger

triggerexecution - content of the trigger

Method Detail

getTriggerCondition

public TriggerCondition<E> getTriggerCondition()

gets the condition for trigger kick

Returns:

the condition

getTriggerExecution

public CustomTriggerExecutionFactory<E> getTriggerExecution()

gets the trigger execution factory

Returns:

the execution factory

generateExternalSchema

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

Specified by:

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

Returns:

get all external fields

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.

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:

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

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

setDependentDefinitionUniqueidentified

public void setDependentDefinitionUniqueidentified(UniqueidentifiedDefinition<E> uniqueidentifieddefinition)

sets the dependent property definition unique-identified

Parameters:

uniqueidentifieddefinition - the definition of unique-identified property for the object