org.openmrs.validator.LocationValidator.java Source code

Introduction

Here is the source code for org.openmrs.validator.LocationValidator.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.Location;
import org.openmrs.annotation.Handler;
import org.openmrs.api.context.Context;
import org.openmrs.util.OpenmrsUtil;
import org.springframework.util.StringUtils;
import org.springframework.validation.Errors;
import org.springframework.validation.ValidationUtils;
import org.springframework.validation.Validator;

/**
 * Validates the Location object.
 * 
 * @since 1.5
 **/
@Handler(supports = { Location.class }, order = 50)
public class LocationValidator extends BaseCustomizableValidator implements Validator {

    /** Log for this class and subclasses */
    protected final Log log = LogFactory.getLog(getClass());

    /**
     * Determines if the command object being submitted is a valid type
     * 
     * @see org.springframework.validation.Validator#supports(java.lang.Class)
     */
    @SuppressWarnings("unchecked")
    public boolean supports(Class c) {
        return c.equals(Location.class);
    }

    /**
     * Checks the form object for any inconsistencies/errors
     * 
     * @see org.springframework.validation.Validator#validate(java.lang.Object,
     *      org.springframework.validation.Errors)
     * @should fail validation if name is null or empty
     * @should fail validation if retired and retireReason is null or empty
     * @should set retired to false if retireReason is null or empty
     * @should pass validation if all fields are correct
     * @should pass validation if retired location is given retired reason
     * @should fail validation if parent location creates a loop
     * @should fail validation if name is exist in non retired locations
     * @should pass validation if field lengths are correct
     * @should fail validation if field lengths are not correct
     */
    public void validate(Object obj, Errors errors) {
        Location location = (Location) obj;
        if (location == null) {
            errors.rejectValue("location", "error.general");
        } else {
            ValidationUtils.rejectIfEmptyOrWhitespace(errors, "name", "error.name");

            if (location.isRetired() && !StringUtils.hasLength(location.getRetireReason())) {
                location.setRetired(false); // so that the jsp page displays
                // properly again
                errors.rejectValue("retireReason", "error.null");
            }

            Location exist = Context.getLocationService().getLocation(location.getName());
            if (exist != null && !exist.isRetired()
                    && !OpenmrsUtil.nullSafeEquals(location.getUuid(), exist.getUuid())) {
                errors.rejectValue("name", "location.duplicate.name");
            }

            // Traverse all the way up (down?) to the root and check if it
            // equals the root.
            Location root = location;
            while (root.getParentLocation() != null) {
                root = root.getParentLocation();
                if (root.equals(location)) { // Have gone in a circle
                    errors.rejectValue("parentLocation", "Location.parentLocation.error");
                    break;
                }
            }
            ValidateUtil.validateFieldLengths(errors, obj.getClass(), "name", "description", "address1", "address2",
                    "cityVillage", "stateProvince", "country", "postalCode", "latitude", "longitude",
                    "countyDistrict", "address3", "address4", "address5", "address6", "retireReason");
            super.validateAttributes(location, errors, Context.getLocationService().getAllLocationAttributeTypes());
        }

    }

}