org.openmrs.validator.FieldValidator.java Source code

Introduction

Here is the source code for org.openmrs.validator.FieldValidator.java

Source

/**
 * This Source Code Form is subject to the terms of the Mozilla Public License,
 * v. 2.0. If a copy of the MPL was not distributed with this file, You can
 * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
 * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
 *
 * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
 * graphic logo is a trademark of OpenMRS Inc.
 */
package org.openmrs.validator;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.openmrs.Field;
import org.openmrs.annotation.Handler;
import org.openmrs.api.APIException;
import org.springframework.validation.Errors;
import org.springframework.validation.ValidationUtils;
import org.springframework.validation.Validator;

/**
 * Validator for {@link Field} class
 *
 * @since 1.10
 */
@Handler(supports = { Field.class }, order = 50)
public class FieldValidator implements Validator {

    private static final Log log = LogFactory.getLog(FieldValidator.class);

    /**
     * Returns whether or not this validator supports validating a given class.
     *
     * @param c The class to check for support.
     * @see org.springframework.validation.Validator#supports(java.lang.Class)
     */
    @SuppressWarnings("rawtypes")
    public boolean supports(Class c) {
        if (log.isDebugEnabled()) {
            log.debug(this.getClass().getName() + ".supports: " + c.getName());
        }
        return Field.class.isAssignableFrom(c);
    }

    /**
     * Validates the given Field. 
     * Ensures that the field name is present and valid
     *
     * @param obj The Field to validate.
     * @param errors Errors
     * @see org.springframework.validation.Validator#validate(java.lang.Object,
     *      org.springframework.validation.Errors)
     * @should fail if field name is null
     * @should fail if field name is empty
     * @should fail if field name is all whitespace
     * @should fail if selectMultiple is null
     * @should fail if retired is null
     * @should pass if name is ok and fieldType, selectMultiple, and retired are non-null
     * @should pass validation if field lengths are correct
     * @should fail validation if field lengths are not correct
     * should not fail if fieldType is null
     */
    public void validate(Object obj, Errors errors) throws APIException {
        if (log.isDebugEnabled()) {
            log.debug(this.getClass().getName() + ".validate...");
        }

        if (obj == null || !(obj instanceof Field)) {
            throw new IllegalArgumentException(
                    "The parameter obj should not be null and must be of type " + Field.class);
        }

        Field field = (Field) obj;

        ValidationUtils.rejectIfEmptyOrWhitespace(errors, "name", "error.null", "Field name is required");
        if (field.getSelectMultiple() == null) {
            errors.rejectValue("selectMultiple", "error.general");
        }
        if (field.getRetired() == null) {
            errors.rejectValue("retired", "error.general");
        }
        ValidateUtil.validateFieldLengths(errors, obj.getClass(), "name", "tableName", "attributeName",
                "retireReason");
    }
}