com.xceptance.xlt.report.external.converter.AbstractDataConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xlt Show documentation

XLT (Xceptance LoadTest) is an extensive load and performance test tool developed and maintained by Xceptance.

There is a newer version: 8.4.1

/*
 * Copyright (c) 2005-2023 Xceptance Software Technologies GmbH
 *
 * 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.xceptance.xlt.report.external.converter;

import java.util.List;
import java.util.Map;

import org.jfree.chart.JFreeChart;

import com.xceptance.xlt.api.report.ReportCreator;
import com.xceptance.xlt.report.external.config.ChartConfig;
import com.xceptance.xlt.report.util.JFreeChartUtils;
import com.xceptance.xlt.report.util.TimeSeriesConfiguration;

/**
 * Base class of all external data converters.
 * 
 * @author Matthias Ullrich (Xceptance Software Technologies GmbH)
 */
abstract public class AbstractDataConverter implements ReportCreator
{
    /**
     * The report provider's configuration.
     */
    private ConverterConfiguration config;

    /**
     * Parse the data.
     * 
     * @param time
     *            timestamp of data
     * @param input
     *            named data
     */
    abstract public void parse(final long time, final Map input) throws IllegalArgumentException;

    /**
     * Create chart from configuration file and data series
     * 
     * @param axisCollections
     * @param chartConfig
     * @return chart file name
     */
    protected void createFloatingChart(final List> axisCollections, final ChartConfig chartConfig,
                                       final String fileName)
    {
        final JFreeChart chart = JFreeChartUtils.createBasicLineChart(chartConfig.getTitle(), chartConfig.getXAxisTitle(),
                                                                      getConfiguration().getChartStartTime(),
                                                                      getConfiguration().getChartEndTime());

        for (int axisIndex = 0; axisIndex < axisCollections.size(); axisIndex++)
        {
            if (!axisCollections.get(axisIndex).isEmpty())
            {
                final String yAxisTitle = axisIndex < 1 ? chartConfig.getYAxisTitle() : chartConfig.getYAxisTitle2();
                JFreeChartUtils.setAxisTimeSeriesCollection(chart, axisIndex, yAxisTitle, axisCollections.get(axisIndex));
            }
        }

        JFreeChartUtils.saveChart(chart, fileName, getConfiguration().getExternalChartsDir(), getConfiguration().getChartWidth(),
                                  getConfiguration().getChartHeight());
    }

    /**
     * Returns the converter configuration.
     * 
     * @return converter configuration
     */
    public ConverterConfiguration getConfiguration()
    {
        return config;
    }

    /**
     * Sets the converter configuration.
     * 
     * @param config
     *            the converter configuration to be set
     */
    public void setConfiguration(final ConverterConfiguration config)
    {
        this.config = config;
    }
}