All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.manydesigns.elements.text.AbstractOgnlFormat Maven / Gradle / Ivy

There is a newer version: 5.3.4
Show newest version
/*
 * Copyright (C) 2005-2019 ManyDesigns srl.  All rights reserved.
 * http://www.manydesigns.com/
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 3 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package com.manydesigns.elements.text;

import com.manydesigns.elements.ElementsThreadLocals;
import com.manydesigns.elements.ognl.OgnlUtils;
import ognl.OgnlContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/*
* @author Paolo Predonzani     - [email protected]
* @author Angelo Lupo          - [email protected]
* @author Giampiero Granatella - [email protected]
* @author Alessio Stalla       - [email protected]
*/
public abstract class AbstractOgnlFormat {
    public static final String copyright =
            "Copyright (C) 2005-2019 ManyDesigns srl";

    //**************************************************************************
    // Fields
    //**************************************************************************

    public static final Pattern pattern = Pattern.compile("%\\{[^\\}]*\\}");

    protected final String formatString;
    protected final String[] ognlExpressions;
    protected final Object[] parsedOgnlExpressions;

    public static final Logger logger =
            LoggerFactory.getLogger(AbstractOgnlFormat.class);

    //**************************************************************************
    // Constructors
    //**************************************************************************

    protected AbstractOgnlFormat(String ognlFormat) {
        this(ognlFormat, 0);
    }

    protected AbstractOgnlFormat(String ognlFormat, int index) {
        List ognlExpressionList = new ArrayList();
        List parsedOgnlExpressionList = new ArrayList();
        Matcher m = pattern.matcher(ognlFormat);
        int previousEnd = 0;
        StringBuilder sb = new StringBuilder();
        while (m.find()) {
            int start = m.start();
            String text = ognlFormat.substring(previousEnd, start);
            String escapedText = escapeText(text);
            sb.append(escapedText);
            String group = m.group();
            String ognlExpression = group.substring(2, group.length()-1);
            replaceOgnlExpression(sb, index, ognlExpression);
            int end = m.end();
            Object parsedOgnlExpression =
                    OgnlUtils.parseExpressionQuietly(ognlExpression);
            ognlExpressionList.add(ognlExpression);
            parsedOgnlExpressionList.add(parsedOgnlExpression);
            previousEnd = end;
            index++;
        }
        String text = ognlFormat.substring(previousEnd, ognlFormat.length());
        String escapedText = escapeText(text);
        sb.append(escapedText);

        formatString = sb.toString();

        ognlExpressions = new String[ognlExpressionList.size()];
        ognlExpressionList.toArray(ognlExpressions);

        parsedOgnlExpressions =
                new Object[parsedOgnlExpressionList.size()];
        parsedOgnlExpressionList.toArray(parsedOgnlExpressions);
    }

    protected String escapeText(String text) {
        return text;
    }

    protected abstract void replaceOgnlExpression(StringBuilder sb,
                                       int index,
                                       String ognlExpression);

    public Object[] evaluateOgnlExpressions(Object root) {
        OgnlContext ognlContext = ElementsThreadLocals.getOgnlContext();
        Object[] result = new Object[parsedOgnlExpressions.length];
        for (int i = 0; i < result.length; i++) {
            evaluateOneOgnlExpression(root, ognlContext, result, i);
        }
        return result;
    }

    protected void evaluateOneOgnlExpression(Object root,
                                           Map ognlContext,
                                           Object[] result,
                                           int i) {
        Object parsedOgnlExpression = parsedOgnlExpressions[i];
        Object ognlResult = OgnlUtils.getValueQuietly(
                parsedOgnlExpression, ognlContext, root);
        result[i] = ognlResult;
    }


    //**************************************************************************
    // Getters and setters
    //**************************************************************************

    public String getFormatString() {
        return formatString;
    }

    public String[] getOgnlExpressions() {
        return ognlExpressions;
    }

    public Object[] getParsedOgnlExpressions() {
        return parsedOgnlExpressions;
    }

}