Java tutorial
/* * #%L * SparkCommerce Open Admin Platform * %% * Copyright (C) 2009 - 2013 Spark Commerce * %% * Licensed under the Apache License, Version 2.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://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * #L% */ package org.sparkcommerce.openadmin.web.processor; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.sparkcommerce.openadmin.web.form.entity.DynamicEntityFormInfo; import org.sparkcommerce.openadmin.web.form.entity.EntityForm; import org.sparkcommerce.openadmin.web.form.entity.Field; import org.sparkcommerce.openadmin.web.form.entity.Tab; import org.springframework.stereotype.Component; import org.springframework.validation.BindingResult; import org.springframework.validation.FieldError; import org.springframework.validation.ObjectError; import org.springframework.web.servlet.support.BindStatus; import org.thymeleaf.Arguments; import org.thymeleaf.dom.Element; import org.thymeleaf.processor.ProcessorResult; import org.thymeleaf.processor.attr.AbstractAttrProcessor; import org.thymeleaf.spring3.util.FieldUtils; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; /** * Processor that returns all the errors within an {@link EntityForm} organized by tab, according to the expression passed * in as an argument. * * For instance, if you would like to get all of the errors for the {@link EntityForm}, invoke this processor with an * attribute that looks like: * * blc_admin:errors="*{*}" * * @author Phillip Verheyden (phillipuniverse) */ @Component("blErrorsProcessor") public class ErrorsProcessor extends AbstractAttrProcessor { protected static final Log LOG = LogFactory.getLog(ErrorsProcessor.class); public static final String GENERAL_ERRORS_TAB_KEY = "generalErrors"; public static final String GENERAL_ERROR_FIELD_KEY = "generalError"; public ErrorsProcessor() { super("errors"); } @Override public int getPrecedence() { return 10000; } @Override protected ProcessorResult processAttribute(Arguments arguments, Element element, String attributeName) { String attributeValue = element.getAttributeValue(attributeName); BindStatus bindStatus = FieldUtils.getBindStatus(arguments.getConfiguration(), arguments, attributeValue); if (bindStatus.isError()) { EntityForm form = (EntityForm) ((BindingResult) bindStatus.getErrors()).getTarget(); // Map of tab name -> (Map field Name -> list of error messages) Map<String, Map<String, List<String>>> result = new HashMap<String, Map<String, List<String>>>(); for (FieldError err : bindStatus.getErrors().getFieldErrors()) { //attempt to look up which tab the field error is on. If it can't be found, just use //the default tab for the group String tabName = EntityForm.DEFAULT_TAB_NAME; Tab tab = form.findTabForField(err.getField()); if (tab != null) { tabName = tab.getTitle(); } Map<String, List<String>> tabErrors = result.get(tabName); if (tabErrors == null) { tabErrors = new HashMap<String, List<String>>(); result.put(tabName, tabErrors); } if (err.getField().contains(DynamicEntityFormInfo.FIELD_SEPARATOR)) { //at this point the field name actually occurs within some array syntax String fieldName = err.getField().substring(err.getField().indexOf('[') + 1, err.getField().lastIndexOf(']')); String[] fieldInfo = fieldName.split("\\" + DynamicEntityFormInfo.FIELD_SEPARATOR); Field formField = form.getDynamicForm(fieldInfo[0]).getFields().get(fieldName); if (formField != null) { addFieldError(formField.getFriendlyName(), err.getCode(), tabErrors); } else { LOG.warn("Could not find field " + fieldName + " within the dynamic form " + fieldInfo[0]); addFieldError(fieldName, err.getCode(), tabErrors); } } else { Field formField = form.findField(err.getField()); if (formField != null) { addFieldError(formField.getFriendlyName(), err.getCode(), tabErrors); } else { LOG.warn("Could not field field " + err.getField() + " within the main form"); addFieldError(err.getField(), err.getCode(), tabErrors); } } } for (ObjectError err : bindStatus.getErrors().getGlobalErrors()) { Map<String, List<String>> tabErrors = result.get(GENERAL_ERRORS_TAB_KEY); if (tabErrors == null) { tabErrors = new HashMap<String, List<String>>(); result.put(GENERAL_ERRORS_TAB_KEY, tabErrors); } addFieldError(GENERAL_ERROR_FIELD_KEY, err.getCode(), tabErrors); } Map<String, Object> localVariables = new HashMap<String, Object>(); localVariables.put("tabErrors", result); return ProcessorResult.setLocalVariables(localVariables); } return ProcessorResult.OK; } protected void addFieldError(String fieldName, String message, Map<String, List<String>> tabErrors) { List<String> messages = tabErrors.get(fieldName); if (messages == null) { messages = new ArrayList<String>(); tabErrors.put(fieldName, messages); } messages.add(message); } }