org.openlowcode.server.data.properties.constraints

Class ConstraintOnLinkedObjectSimilarAttribute<E extends DataObject<E>,F extends DataObject<F>,G>

java.lang.Object

org.openlowcode.server.data.properties.constraints.ConstraintOnLinkObject<E,F>

org.openlowcode.server.data.properties.constraints.ConstraintOnLinkedObjectSimilarAttribute<E,F,G>

Type Parameters:

E - left data object for the link

F - right data object for the link

G - class of the payload of the attribute being compared on the two objects

public class ConstraintOnLinkedObjectSimilarAttribute<E extends DataObject<E>,F extends DataObject<F>,G>
extends ConstraintOnLinkObject<E,F>

This constraint will allow to link two objects only if they have same value on the attribute defined on each object

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description

ConstraintOnLinkedObjectSimilarAttribute(DataExtractor<E,G> leftobjectextractor, DataExtractor<F,G> rightobjectextractor, DataExtractorFromObject<E,G> leftobjectextractorfromobject, DataExtractorFromObject<F,G> rightobjectextractorfromobject, DataSetterFromObject<E,G> leftobjectsetter, DataSetterFromObject<F,G> rightobjectsetter, StoredFieldSchema<G> leftattributemarker, StoredFieldSchema<G> rightattributemarker, java.lang.String errormessagestart) creates a constraint on link object with similar attribute

Method Summary

Modifier and Type	Method and Description
boolean	checklinkvalid(DataObjectId<E> leftobjectid, DataObjectId<F> rightobjectid) checks if it is authorized to set a link between two objects with their id
boolean	checklinkvalid(E leftobject, F rightobject) checks if it is authorized to set a link between two objects
void	enrichRightObjectAfterCreation(F rightobjectbeforecreation, E leftobject) this method will enrich the right object after it has been created in case right objects are created when loading links
QueryCondition	generateQueryFilter(TableAlias maintablealias, DataObjectId<E> leftobjectid) generates a filter to show only valid objects when querying for potential right objects
QueryCondition	generateReverseQueryFilter(TableAlias maintablealias, DataObjectId<F> rightobjectid) generates a filter to show only valid objects when querying for potential left objects
java.lang.String	getInvalidLinkErrorMessage(E leftobject, F rightobject) gets a detailed error message if link is invalid
boolean	isLeftForLinkLoaderManaged() checks if the constraint allows to load links

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConstraintOnLinkedObjectSimilarAttribute

public ConstraintOnLinkedObjectSimilarAttribute(DataExtractor<E,G> leftobjectextractor,
                                                DataExtractor<F,G> rightobjectextractor,
                                                DataExtractorFromObject<E,G> leftobjectextractorfromobject,
                                                DataExtractorFromObject<F,G> rightobjectextractorfromobject,
                                                DataSetterFromObject<E,G> leftobjectsetter,
                                                DataSetterFromObject<F,G> rightobjectsetter,
                                                StoredFieldSchema<G> leftattributemarker,
                                                StoredFieldSchema<G> rightattributemarker,
                                                java.lang.String errormessagestart)

creates a constraint on link object with similar attribute

Parameters:

leftobjectextractor - extractor of the attribute from the left object id

rightobjectextractor - extractor of the attribute from the right object id

leftobjectextractorfromobject - extractor of the attribute from the left object (without persistence call)

rightobjectextractorfromobject - extractor of the attribute from the right object (without persistence call)

leftobjectsetter - setter on the left object for the attribute

rightobjectsetter - setter on the right object for the attribute

leftattributemarker - left attribute marker

rightattributemarker - right attribute marker

errormessagestart - start of the error message for traceability purposes

Method Detail

checklinkvalid

public boolean checklinkvalid(DataObjectId<E> leftobjectid,
                              DataObjectId<F> rightobjectid)

Description copied from class: ConstraintOnLinkObject

checks if it is authorized to set a link between two objects with their id

Specified by:

checklinkvalid in class ConstraintOnLinkObject<E extends DataObject<E>,F extends DataObject<F>>

Parameters:

leftobjectid - id of the left object

rightobjectid - if of the right object

Returns:

true if link creation is authorized, false if link creation is not authorized

generateQueryFilter

public QueryCondition generateQueryFilter(TableAlias maintablealias,
                                          DataObjectId<E> leftobjectid)

Description copied from class: ConstraintOnLinkObject

generates a filter to show only valid objects when querying for potential right objects

Specified by:

generateQueryFilter in class ConstraintOnLinkObject<E extends DataObject<E>,F extends DataObject<F>>

Parameters:

maintablealias - alias to generate the condition for

leftobjectid - id of the left object

Returns:

a query condition that will return only valid left objects for link creation

generateReverseQueryFilter

public QueryCondition generateReverseQueryFilter(TableAlias maintablealias,
                                                 DataObjectId<F> rightobjectid)

Description copied from class: ConstraintOnLinkObject

generates a filter to show only valid objects when querying for potential left objects

Specified by:

generateReverseQueryFilter in class ConstraintOnLinkObject<E extends DataObject<E>,F extends DataObject<F>>

Parameters:

maintablealias - alias to generate the condition for

rightobjectid - id of the right object

Returns:

a query condition that will return only valid left objects for link creation

checklinkvalid

public boolean checklinkvalid(E leftobject,
                              F rightobject)

Description copied from class: ConstraintOnLinkObject

checks if it is authorized to set a link between two objects

Specified by:

checklinkvalid in class ConstraintOnLinkObject<E extends DataObject<E>,F extends DataObject<F>>

Parameters:

leftobject - left object

rightobject - right object

Returns:

true if link creation is authorized, false if link creation is not authorized

getInvalidLinkErrorMessage

public java.lang.String getInvalidLinkErrorMessage(E leftobject,
                                                   F rightobject)

Description copied from class: ConstraintOnLinkObject

gets a detailed error message if link is invalid

Specified by:

getInvalidLinkErrorMessage in class ConstraintOnLinkObject<E extends DataObject<E>,F extends DataObject<F>>

Parameters:

leftobject - left object

rightobject - right object

Returns:

a readable error message

isLeftForLinkLoaderManaged

public boolean isLeftForLinkLoaderManaged()

Description copied from class: ConstraintOnLinkObject

checks if the constraint allows to load links

Specified by:

isLeftForLinkLoaderManaged in class ConstraintOnLinkObject<E extends DataObject<E>,F extends DataObject<F>>

Returns:

true if it is authorized to use left for link loader with this constraint

enrichRightObjectAfterCreation

public void enrichRightObjectAfterCreation(F rightobjectbeforecreation,
                                           E leftobject)

Description copied from class: ConstraintOnLinkObject

this method will enrich the right object after it has been created in case right objects are created when loading links

Specified by:

enrichRightObjectAfterCreation in class ConstraintOnLinkObject<E extends DataObject<E>,F extends DataObject<F>>

Parameters:

rightobjectbeforecreation - to be implemented if isLeftForLinkLoaderManaged returns true.

leftobject - left object to enrich data