001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.report;
029
030import org.opencms.main.CmsLog;
031import org.opencms.util.CmsStringUtil;
032
033import java.io.IOException;
034import java.io.InputStream;
035import java.util.List;
036
037import org.apache.commons.logging.Log;
038
039import org.antlr.stringtemplate.StringTemplate;
040import org.antlr.stringtemplate.StringTemplateGroup;
041
042/**
043 * Report update formatter for the new Vaadin-based workplace.<p>
044 */
045public class CmsVaadinHtmlReportUpdateFormatter implements I_CmsReportUpdateFormatter {
046
047    /** The logger instance used for this class. */
048    private static final Log LOG = CmsLog.getLog(CmsVaadinHtmlReportUpdateFormatter.class);
049
050    /** The StringTemplate group used by this report. */
051    private StringTemplateGroup m_templateGroup;
052
053    /**
054     * Creates a new instance.<p>
055     */
056    public CmsVaadinHtmlReportUpdateFormatter() {
057
058        try (InputStream stream = CmsVaadinHtmlReportUpdateFormatter.class.getResourceAsStream("report.st")) {
059            m_templateGroup = CmsStringUtil.readStringTemplateGroup(stream);
060        } catch (IOException e) {
061            LOG.error(e.getLocalizedMessage(), e);
062        }
063    }
064
065    /**
066     * @see org.opencms.report.I_CmsReportUpdateFormatter#formatReportUpdate(java.util.List)
067     */
068    public String formatReportUpdate(List<CmsReportUpdateItem> updateItem) {
069
070        StringBuffer buffer = new StringBuffer();
071        for (CmsReportUpdateItem entry : updateItem) {
072            try {
073                StringTemplate template = m_templateGroup.getInstanceOf(entry.getType().getFormatName());
074                boolean needsParam = template.getFormalArguments().get("message") != null;
075                if (needsParam) {
076                    template.setAttribute("message", entry.getMessage());
077                }
078                buffer.append(template.toString());
079            } catch (Exception e) {
080                LOG.error(e.getLocalizedMessage(), e);
081            }
082        }
083        return buffer.toString();
084    }
085
086}