io.vertigo.ui.impl.springmvc.controller.VSpringMvcUiMessageStack Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertigo-ui Show documentation
There is a newer version: 4.2.0
/**
 * vertigo - application development platform
 *
 * Copyright (C) 2013-2021, Vertigo.io, [email protected]
 *
 * 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.
 */
package io.vertigo.ui.impl.springmvc.controller;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import io.vertigo.datamodel.structure.model.DtObject;
import io.vertigo.ui.impl.springmvc.util.UiRequestUtil;
import io.vertigo.vega.webservice.validation.UiMessageStack;

/**
 * Class d'enregistrement des messages.
 * @author npiedeloup
 */
public final class VSpringMvcUiMessageStack implements UiMessageStack {

	private static final long serialVersionUID = -2650689827844300786L;

	private final List globalErrors = new ArrayList<>();
	private final List globalWarnings = new ArrayList<>();
	private final List globalInfos = new ArrayList<>();
	private final List globalSuccess = new ArrayList<>();

	private final Map>> objectFieldErrors = new HashMap<>();
	private final Map>> objectFieldWarnings = new HashMap<>();
	private final Map>> objectFieldInfos = new HashMap<>();

	/**
	 * Ajoute un message.
	 * @param level Niveau de message
	 * @param message Message
	 */
	@Override
	public void addGlobalMessage(final Level level, final String message) {
		switch (level) {
			case ERROR:
				globalErrors.add(message);
				break;
			case WARNING:
				globalWarnings.add(message);
				break;
			case INFO:
				globalInfos.add(message);
				break;
			case SUCCESS:
				globalSuccess.add(message);
				break;
			default:
				throw new UnsupportedOperationException("Unknowned level");
		}
	}

	/**
	 * @param message Message d'erreur
	 */
	@Override
	public void error(final String message) {
		addGlobalMessage(Level.ERROR, message);
	}

	/**
	 * @param message Message d'alerte
	 */
	@Override
	public void warning(final String message) {
		addGlobalMessage(Level.WARNING, message);
	}

	/**
	 * @param message Message d'info
	 */
	@Override
	public void info(final String message) {
		addGlobalMessage(Level.INFO, message);
	}

	/**
	 * @param message Message d'info
	 */
	@Override
	public void success(final String message) {
		addGlobalMessage(Level.SUCCESS, message);
	}

	/**
	 * @param message Message d'erreur
	 * @param dto Objet portant les erreurs
	 * @param fieldName Champ portant l'erreur
	 */
	@Override
	public void error(final String message, final DtObject dto, final String fieldName) {
		addFieldMessage(Level.ERROR, message, dto, fieldName);
	}

	/**
	 * @param message Message d'alerte
	 * @param dto Objet portant les erreurs
	 * @param fieldName Champ portant l'erreur
	 */
	@Override
	public void warning(final String message, final DtObject dto, final String fieldName) {
		addFieldMessage(Level.WARNING, message, dto, fieldName);
	}

	/**
	 * @param message Message d'info
	 * @param dto Objet portant les erreurs
	 * @param fieldName Champ portant l'erreur
	 */
	@Override
	public void info(final String message, final DtObject dto, final String fieldName) {
		addFieldMessage(Level.INFO, message, dto, fieldName);
	}

	/* (non-Javadoc)
	 * @see io.vertigo.vega.webservice.validation.UiMessageStack#addFieldMessage(io.vertigo.vega.webservice.validation.UiMessageStack.Level, java.lang.String, io.vertigo.dynamo.domain.model.DtObject, java.lang.String)
	 */
	@Override
	public void addFieldMessage(final Level level, final String message, final DtObject dto, final String fieldName) {
		addFieldMessage(level, message, UiRequestUtil.getCurrentViewContext().findKey(dto), fieldName);

	}

	/**
	 * @param level Message level
	 * @param message Message text
	 * @param contextKey contextKey in request
	 * @param fieldName field name
	 */
	@Override
	public void addFieldMessage(final Level level, final String message, final String contextKey, final String fieldName) {
		addObjectFieldMessage(level, message, contextKey, fieldName);
	}

	private void addObjectFieldMessage(final Level level, final String message, final String contextKey, final String fieldName) {
		final Map>> fieldMessageMap;
		switch (level) {
			case ERROR:
				fieldMessageMap = objectFieldErrors;
				break;
			case WARNING:
				fieldMessageMap = objectFieldWarnings;
				break;
			case INFO:
				fieldMessageMap = objectFieldInfos;
				break;
			case SUCCESS: //unsupported for fields
			default:
				throw new UnsupportedOperationException("Unknowned level");
		}
		Map> objectMessages = fieldMessageMap.get(contextKey);
		if (objectMessages == null) {
			objectMessages = new HashMap<>();
			fieldMessageMap.put(contextKey, objectMessages);
		}
		List messages = objectMessages.get(fieldName);
		if (messages == null) {
			messages = new ArrayList<>();
			objectMessages.put(fieldName, messages);
		}
		messages.add(message);
	}

	/**
	 * @return if there are errors in this stack.
	 */
	@Override
	public boolean hasErrors() {
		return !globalErrors.isEmpty() || !objectFieldErrors.isEmpty();
	}

	public List getGlobalErrors() {
		return globalErrors;
	}

	public List getGlobalWarnings() {
		return globalWarnings;
	}

	public List getGlobalInfos() {
		return globalInfos;
	}

	public List getGlobalSuccess() {
		return globalSuccess;
	}

	public Map>> getObjectFieldErrors() {
		return objectFieldErrors;
	}

	public Map>> getObjectFieldWarnings() {
		return objectFieldWarnings;
	}

	public Map>> getObjectFieldInfos() {
		return objectFieldInfos;
	}

	public boolean hasFieldErrors(final String object, final String field) {
		return objectFieldErrors.containsKey(object) && objectFieldErrors.get(object).containsKey(field);
	}

	public boolean hasFieldWarnings(final String object, final String field) {
		return objectFieldWarnings.containsKey(object) && objectFieldWarnings.get(object).containsKey(field);
	}

}