com.ocs.dynamo.ui.utils.GridFormatUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dynamo-frontend Show documentation
The newest version!
/*
   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 com.ocs.dynamo.ui.utils;

import java.time.ZoneId;
import java.util.Locale;

import com.ocs.dynamo.domain.model.AttributeModel;
import com.ocs.dynamo.domain.model.EntityModelFactory;
import com.ocs.dynamo.service.MessageService;
import com.ocs.dynamo.service.ServiceLocatorFactory;
import com.ocs.dynamo.utils.ClassUtils;
import com.ocs.dynamo.utils.FormatUtils;

import lombok.experimental.UtilityClass;

/**
 * Utilities for formatting values inside a grid. Mostly delegates to
 * FormatUtils
 * 
 * @author Bas Rutten
 *
 */
@UtilityClass
public final class GridFormatUtils {

	private static final EntityModelFactory entityModelFactory = ServiceLocatorFactory.getServiceLocator()
			.getEntityModelFactory();

	private static final MessageService messageService = ServiceLocatorFactory.getServiceLocator().getMessageService();

	/**
	 * local Extracts a field value from an object and formats it
	 * 
	 * @param am             the attribute model
	 * @param obj            the object from which to extract the value
	 * @param locale         the locale
	 * @param zoneId         the time zone ID
	 * @param currencySymbol the currency symbol
	 * @return
	 */
	public static String extractAndFormat(AttributeModel am, Object obj, Locale locale, ZoneId zoneId,
			String currencySymbol) {
		Object value = ClassUtils.getFieldValue(obj, am.getPath());
		String result = FormatUtils.formatPropertyValue(entityModelFactory, messageService, am, value, ", ", locale,
				zoneId, currencySymbol);
		return restrictToMaxLength(result, am);
	}

	/**
	 * Formats a property value
	 * 
	 * @param am             the attribute model of the property
	 * @param value          the value of the property
	 * @param separator      the separator to use to separate items in a collection
	 * @param locale         the locale used for the formatting
	 * @param zoneId         the zoneId used for formatting time zone
	 * @param currencySymbol the currency symbol to use
	 * @return
	 */
	public static String formatPropertyValue(AttributeModel am, Object value, String separator, Locale locale,
			ZoneId zoneId, String currencySymbol) {
		String result = FormatUtils.formatPropertyValue(entityModelFactory, messageService, am, value, separator,
				locale, zoneId, currencySymbol);
		return restrictToMaxLength(result, am);
	}

	/**
	 * Restricts a value to its maximum length defined in the attribute model
	 *
	 * @param input the input value
	 * @param am    the attribute model
	 * @return
	 */
	private static String restrictToMaxLength(String input, AttributeModel am) {
		if (am.getMaxLengthInGrid() != null && input != null && input.length() > am.getMaxLengthInGrid()) {
			return input.substring(0, am.getMaxLengthInGrid()) + "...";
		}
		return input;
	}

}