org.asqatasun.webapp.report.expression.I18nExpression.java Source code

Introduction

Here is the source code for org.asqatasun.webapp.report.expression.I18nExpression.java

Source

/*
 * Asqatasun - Automated webpage assessment
 * Copyright (C) 2008-2015  Asqatasun.org
 *
 * This file is part of Asqatasun.
 *
 * Asqatasun is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Contact us by mail: asqatasun AT asqatasun DOT org
 */
package org.asqatasun.webapp.report.expression;

import ar.com.fdvs.dj.domain.CustomExpression;
import java.util.*;
import org.apache.commons.lang3.StringEscapeUtils;
import org.asqatasun.webapp.report.expression.retriever.KeyRetriever;

/**
 *
 * @author jkowalczyk
 */
public class I18nExpression implements CustomExpression {

    private static final long serialVersionUID = 1174999656431046383L;

    private final List<ResourceBundle> resourceBundleList = new ArrayList();
    private KeyRetriever keyRetriever = null;
    private boolean escapeHtml = false;

    /**
     * Default constructor
     * @param bundleNameList
     * @param keyRetriever
     * @param escapeHtml
     * @param locale 
     */
    public I18nExpression(List<String> bundleNameList, KeyRetriever keyRetriever, boolean escapeHtml,
            Locale locale) {
        if (bundleNameList != null) {
            for (String bundleName : bundleNameList) {
                resourceBundleList.add(ResourceBundle.getBundle(bundleName, locale));
            }
        }
        this.keyRetriever = keyRetriever;
        this.escapeHtml = escapeHtml;
    }

    @Override
    public Object evaluate(Map fields, Map variables, Map parameters) {
        String key = keyRetriever.retrieveKey(fields, variables, parameters);
        if (!resourceBundleList.isEmpty()) {
            String i18nValue = retrieveI18nValue(key);
            if (escapeHtml) {
                return StringEscapeUtils.escapeHtml4(i18nValue);
            }
            return StringEscapeUtils.unescapeHtml4(i18nValue);
        }
        return key;
    }

    @Override
    public String getClassName() {
        return String.class.getName();
    }

    /**
     * Retrieve a i18n among the Collection of resourceBundle associated with
     * the instance
     * 
     * @param key
     * @return 
     */
    private String retrieveI18nValue(String key) {
        for (ResourceBundle rb : resourceBundleList) {
            if (rb.containsKey(key)) {
                return rb.getString(key);
            }
        }
        return key;
    }
}