ReportObjectValidator.java

/**
 * The contents of this file are subject to the OpenMRS Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://license.openmrs.org
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
 * License for the specific language governing rights and limitations
 * under the License.
 *
 * Copyright (C) OpenMRS, LLC.  All Rights Reserved.
 */
package org.openmrs.validator;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.openmrs.reporting.AbstractReportObject;
import org.openmrs.reporting.ReportObject;
import org.springframework.validation.Errors;
import org.springframework.validation.ValidationUtils;
import org.springframework.validation.Validator;

/**
 * Validates attributes on the {@link ReportObject} object.
 * 
 * @since 1.5
 * @deprecated see reportingcompatibility module
 */
@Deprecated
public class ReportObjectValidator 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) {
		//String clsName = c.getName();
		// could also check if superclass is an AbstractReportObject
		return c.getSuperclass().equals(AbstractReportObject.class);
		//return Helper.isStringInArray(clsName, ReportObjectService.getAllReportObjectClasses());
	}
	
	/**
	 * Checks the form object for any inconsistencies/errors
	 * 
	 * @see org.springframework.validation.Validator#validate(java.lang.Object,
	 *      org.springframework.validation.Errors)
	 */
	public void validate(Object obj, Errors errors) {
		
		if (obj instanceof AbstractReportObject) {
			AbstractReportObject reportObject = (AbstractReportObject) obj;
			if (reportObject == null) {
				errors.rejectValue("report object", "error.general");
			} else {
				ValidationUtils.rejectIfEmptyOrWhitespace(errors, "name", "error.name");
				ValidationUtils.rejectIfEmptyOrWhitespace(errors, "type", "error.reportObject.type.required");
				ValidationUtils.rejectIfEmptyOrWhitespace(errors, "subType", "error.reportObject.subType.required");
			}
		} else {
			errors.rejectValue("report object", "error.general");
		}
	}
	
}