Class ValidationOptions


  • public class ValidationOptions
    extends Object
    Stores all validation options (ie. validator -- severity) combinations. Note that all rules are always validated. Use object of this class to keep track of which validators that should be ignored, generate warnings or errors.
    Version:
    2.2
    Author:
    Nicklas
    See Also:
    GenericOverview.getValidationOptions(), Failure
    Last modified
    $Date: 2019-03-12 07:53:27 +0100 (tis, 12 mars 2019) $
    • Field Detail

      • severities

        private Map<String,​Severity> severities
        Maps Validator ID to severity.
      • options

        private Map<String,​String> options
        Other options. Key is validator ID + key
    • Constructor Detail

      • ValidationOptions

        public ValidationOptions()
        Create a new ValidationOptions object.
      • ValidationOptions

        public ValidationOptions​(Presets.Preset preset)
        Create a new ValidationOptions object and load settings from a preset.
        Parameters:
        preset - The preset to load settings from, or null to not load any settings
    • Method Detail

      • getSeverity

        public Severity getSeverity​(ValidationRuleAction rule)
        Get the severity level for the specified validator rule. If no option exists the validators default severity level is returned.
        Parameters:
        rule - The validation rule to get the severity level for
        Returns:
        A severity level object
        Since:
        3.2
        See Also:
        Validator.getDefaultSeverity()
      • setSeverity

        public void setSeverity​(ValidationRuleAction rule,
                                Severity severity)
        Set a severity level for the specified validation rule.
        Parameters:
        rule - The validation rule
        severity - The severity level or null to use the default severity level
        Since:
        3.2
      • getOption

        public String getOption​(ValidationRuleAction rule,
                                String key,
                                String defaultValue)
        Get the configured option for a validator rule.
        Parameters:
        rule - The validation rule
        key - The key (name) of the option
        defaultValue - The default value in case there is no configured value
        Returns:
        The value of the option
        Since:
        3.2
      • setOption

        public void setOption​(ValidationRuleAction rule,
                              String key,
                              String value)
        Set an option for a validator rule.
        Parameters:
        rule - The validation rule
        key - The key (name) of the option
        value - The value to set or null to remove the value
        Since:
        3.2
      • loadFromPreset

        public void loadFromPreset​(Presets.Preset preset,
                                   boolean clearFirst)
        Load validation options from a Presets.Preset. The preset should contain settings where the ID of the a Validator is used as keys and the names of Severity values are used as values.
        Parameters:
        preset - The preset to load the options from
        clearFirst - If the current settings should be cleared before the new ones are loaded from the preset
        See Also:
        saveToPreset(net.sf.basedb.core.Presets.Preset)
      • saveToPreset

        public void saveToPreset​(Presets.Preset preset)
        Save the current settings to a preset. The Validator.getId() is used as key and the Enum.name() is used as value.
        Parameters:
        preset - The preset to save the settings to