com.canto.cumulus.server.esp.modules.validator

Interface TableValidatorESP

All Superinterfaces:

BaseESP

public interface TableValidatorESP
extends BaseESP

This interface needs to be implemented by a class that wants to check items being added, updated or deleted in a table. In case the implemented validator returns an error message the operation is canceled (i.e. the item cannot be deleted).
The following sample code implements a table validator which does not allow to save a category without a name:

 import com.canto.cumulus.Cumulus;
 import com.canto.cumulus.GUID;
 import com.canto.cumulus.Item;
 import com.canto.cumulus.constants.TableAction;
 import com.canto.cumulus.server.esp.modules.validator.TableValidatorESP;
 import com.canto.cumulus.server.esp.modules.validator.ValidatorConfigurator;
 import com.canto.cumulus.utils.JPack;

 import java.util.EnumSet;
 import java.util.Locale;

 public class NonEmptyCategoryNameTableValidator implements TableValidatorESP
 {
     private static final GUID ID = new GUID ("{21BD27AB-171E-4BE7-A5EF-3AB68C50C908}"); //replace with your own GUID

     @Override
     public GUID getID ()
     {
         return ID;
     }

     @Override
     public String getName (Locale locale)
     {
         return "Category Name Validator";
     }

     @Override
     public String getUserInterfaceCheckboxText (Locale locale)
     {
         return "Enforce non-empty category names";
     }

     @Override
     public EnumSet getSupportedTableActions (String tableName)
     {
         return Cumulus.TABLE_NAME_CATEGORIES.equals (tableName) ? EnumSet.of (TableAction.CREATE, TableAction.UPDATE) : null;
     }

     @Override
     public boolean hasConfigurator ()
     {
         return false;
     }

     @Override
     public ValidatorConfigurator createConfigurator (JPack configuration)
     {
         return null;
     }

     @Override
     public String validate (Locale locale, Object itemObj, TableAction tableAction, JPack configurationData)
     {
         Item item = (Item) itemObj;

         if (!item.hasValue (GUID.UID_CAT_NAME) || item.getStringValue (GUID.UID_CAT_NAME).isEmpty ())
         {
             return "Category name should not be empty";
         }
         else
         {
             return null;
         }
     }
 }
 

Since:

9.2

Method Summary

Methods

Modifier and Type	Method and Description
ValidatorConfigurator	createConfigurator(JPack configuration) Returns a configurator instance that is initialized with the given data.
java.lang.String	getName(java.util.Locale locale) Returns the name for this validator.
java.util.EnumSet<TableAction>	getSupportedTableActions(java.lang.String tableName) Returns the supported actions for the given table.
java.lang.String	getUserInterfaceCheckboxText(java.util.Locale locale) Returns the text being displayed with the JCheckBox in the preferences dialog that enables or disabled the validator.
boolean	hasConfigurator() Returns whether this validator has some specific user interface for configuration.
java.lang.String	validate(java.util.Locale locale, java.lang.Object item, TableAction tableAction, JPack configurationData) The actual worker method that should validate the content of the given table item to comply with the validation rules specified by the configuration data.

Methods inherited from interface com.canto.cumulus.server.esp.modules.BaseESP

getID

Method Detail

getName

java.lang.String getName(java.util.Locale locale)

Returns the name for this validator.

Parameters:

locale - the language to get the name for

Returns:

the validators name

getUserInterfaceCheckboxText

java.lang.String getUserInterfaceCheckboxText(java.util.Locale locale)

Returns the text being displayed with the JCheckBox in the preferences dialog that enables or disabled the validator.

Parameters:

locale - the language to get the text for

Returns:

text being displayed with the JCheckBox

getSupportedTableActions

java.util.EnumSet<TableAction> getSupportedTableActions(java.lang.String tableName)

Returns the supported actions for the given table.

Parameters:

tableName - the table to return the supported actions for

Returns:

null or empty set in case the table is not supported, otherwise the set of supported actions

hasConfigurator

boolean hasConfigurator()

Returns whether this validator has some specific user interface for configuration.

Returns:

true if this validator has some specific user interface for configuration, false otherwise

createConfigurator

ValidatorConfigurator createConfigurator(JPack configuration)

Returns a configurator instance that is initialized with the given data.

Parameters:

configuration - the configuration data

Returns:

the configurator instance

validate

java.lang.String validate(java.util.Locale locale,
                        java.lang.Object item,
                        TableAction tableAction,
                        JPack configurationData)

The actual worker method that should validate the content of the given table item to comply with the validation rules specified by the configuration data. This is the right place to open a connection to an external system like an SQL database to query required information for validation. You must close the connection before leaving the method to release resources properly.

Parameters:

locale - The language to present the error with in case of a failed validation

item - The item to work on. Needs to be casted to Item for the actual work

tableAction - The action that would be executed on the given item in case the validation is successful.

configurationData - The pack containing the configuration previously configured using the ValidatorConfigurator instance of this validator

Returns:

The found validation error or null if the current value is valid