G4.85 Update Trait Data Validators

[laceysanderson]

Branch

g4.85-updateTraitDataValidators

Groups

Group 2 - Data Importing, Group 4 - API | Services | Plugins

Dependencies

• G4.76 STEP 1 --Divides trait import value plugin instance into 3 separate instances #77
• G4.92 Update annotation, interface and validator base with new design #92
• G4.93 Develop a number of setter traits for use with configuring validators. #93

Describe

This issue is meant to carry on from PR #77 after the discussion documented in issue #82. More specifically, it will update the validators to accept configuration using setters and to return the new return values. This will also involve updating the tests and configuring the validators in the importer formValidate.

This is meant to update the data values validators - ie. ValueInList, EmptyCell & DuplicateTraits

Design

Task 1a

(use the getters)
Currently the validators receive their config via a temporary class property set by load values (see comment #79 (comment)) and then that property is used wholesale in the validateRow method. This task is to update the validators to use the setter methods developed in #93 and stop using the context property.

Task 1b

(use the setters)
Currently the config is set in the importer configureValidators using the loadAssets. This task is to switch to calling the individual setters developed in #95 .

Task 2

Update the validators to indicate their inputType and remove their scope in the annotation block.

Task 3

Currently the validators return the old style of return value which includes the keys title, status and details. This task is to add the new design keys. We will likely keep the old keys being returned unchanged? but add a comment saying they are deprecated. Essentially,

• the title becomes more developer friendly and becomes the case
• the status becomes the valid key with 'fail' becoming FALSE and 'pass' becoming TRUE.
• the items appending into the details string (i.e. failed indices or original values) are instead individual elements in a failedIems array.

Here is the design information for the new return value style:

• 'case': a developer focused string describing the case checked
• 'valid': either TRUE or FALSE depending on if the data is valid or not
• 'failedItems': an array of "items" to be used in the message to the user. This is empty if the data was valid