org.structr.core.parser.function.NumberFormatFunction.java Source code

Introduction

Here is the source code for org.structr.core.parser.function.NumberFormatFunction.java

Source

/**
 * Copyright (C) 2010-2016 Structr GmbH
 *
 * This file is part of Structr <http://structr.org>.
 *
 * Structr is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * Structr 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Structr.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.structr.core.parser.function;

import java.text.DecimalFormat;
import java.text.DecimalFormatSymbols;
import java.util.Locale;
import org.apache.commons.lang3.StringUtils;
import org.structr.common.error.FrameworkException;
import org.structr.core.GraphObject;
import org.structr.schema.action.ActionContext;
import org.structr.schema.action.Function;

/**
 *
 */
public class NumberFormatFunction extends Function<Object, Object> {

    public static final String ERROR_MESSAGE_NUMBER_FORMAT = "Usage: ${number_format(value, ISO639LangCode, pattern)}. Example: ${number_format(12345.6789, 'en', '#,##0.00')}";
    public static final String ERROR_MESSAGE_NUMBER_FORMAT_JS = "Usage: ${{Structr.number_format(value, ISO639LangCode, pattern)}}. Example: ${{Structr.number_format(12345.6789, 'en', '#,##0.00')}}";

    @Override
    public String getName() {
        return "number_format()";
    }

    @Override
    public Object apply(final ActionContext ctx, final GraphObject entity, final Object[] sources)
            throws FrameworkException {

        if (sources == null || sources != null && sources.length != 3) {
            return usage(ctx.isJavaScriptContext());
        }

        if (arrayHasLengthAndAllElementsNotNull(sources, 3)) {

            if (StringUtils.isBlank(sources[0].toString())) {
                return "";
            }

            try {

                Double val = Double.parseDouble(sources[0].toString());
                String langCode = sources[1].toString();
                String pattern = sources[2].toString();

                return new DecimalFormat(pattern, DecimalFormatSymbols.getInstance(Locale.forLanguageTag(langCode)))
                        .format(val);

            } catch (Throwable t) {
            }
        }

        return "";
    }

    @Override
    public String usage(boolean inJavaScriptContext) {
        return (inJavaScriptContext ? ERROR_MESSAGE_NUMBER_FORMAT_JS : ERROR_MESSAGE_NUMBER_FORMAT);
    }

    @Override
    public String shortDescription() {
        return "Formats the given value using the given number format string";
    }

}