com.xceptance.xlt.report.providers.BasicTimerReportProvider Maven / Gradle / Ivy

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.1.0

/*
 * Copyright (c) 2005-2022 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.providers;

import java.util.ArrayList;
import java.util.List;

import com.xceptance.xlt.api.engine.TimerData;

/**
 * The BasicTimerReportProvider class provides common functionality of a typical report provider that deals with
 * {@link TimerData} objects. This includes:
 * 
 * calculation of response time statistics
 * creation of response time charts
 * creation of CSV files with all the data
 * 
 */
public abstract class BasicTimerReportProvider extends AbstractDataProcessorBasedReportProvider
{
    /**
     * Constructor.
     * 
     * @param c
     *            the data processor implementation class
     */
    protected BasicTimerReportProvider(final Class c)
    {
        super(c);
    }

    /**
     * Generates a runtime timer report for each distinct timer name that appears in the list. While a runtime timer
     * report is created, a corresponding chart and a CSV file with the values are created as well.
     * 
     * @param generateHistograms
     *            whether histogram charts are to be generated
     * @return the list of timer reports
     */
    protected List createTimerReports(final boolean generateHistograms)
    {
        final List reports = new ArrayList();

        for (final T processor : getProcessors())
        {
            final TimerReport timerReport = processor.createTimerReport(generateHistograms);

            if (timerReport != null)
            {
                reports.add(timerReport);
            }
        }

        return reports;
    }
}