All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.easybatch.tools.reporting.DefaultJobReportMerger Maven / Gradle / Ivy

    There is a newer version: 5.3.0
    Show newest version
    /*
 * The MIT License
 *
 *  Copyright (c) 2015, Mahmoud Ben Hassine ([email protected])
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to deal
 *  in the Software without restriction, including without limitation the rights
 *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the Software is
 *  furnished to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in
 *  all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 *  THE SOFTWARE.
 */

package org.easybatch.tools.reporting;

import org.easybatch.core.job.JobReport;
import org.easybatch.core.job.JobResult;
import org.easybatch.core.job.JobStatus;

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

import static org.easybatch.core.util.Utils.LINE_SEPARATOR;

/**
 * A report merger that generates a merged report defined as follows:
 * 
      
 * 
    • The start time is the minimum of start times
      • 
 * 
    • The end time is the maximum of end times
      • 
 * 
    • The total records is the sum of total records
      • 
 * 
    • The total skipped records is the sum of total skipped records
      • 
 * 
    • The total filtered records is the sum of total filtered records
      • 
 * 
    • The total error records is the sum of total error records
      • 
 * 
    • The total success records is the sum of total success records
      • 
 * 
    • The final job result is a list of all job results
      • 
 * 
    • The final data source name is the concatenation (one per line) of data sources names
      • 
 * 
    • The final status is {@link JobStatus#COMPLETED} (if all partials are completed)
 * or {@link JobStatus#ABORTED} (if one of partials has been aborted) or {@link JobStatus#FAILED} (if one of partials has failed).
      • 
 * 
    
 *
 * @author Mahmoud Ben Hassine ([email protected])
 */
public class DefaultJobReportMerger implements JobReportMerger {

    /**
     * Merge multiple reports into a consolidated one.
     *
     * @param jobReports reports to merge
     * @return a merged report
     */
    @Override
    public JobReport mergerReports(JobReport... jobReports) {

        List startTimes = new ArrayList<>();
        List endTimes = new ArrayList<>();
        List results = new ArrayList<>();
        List dataSources = new ArrayList<>();
        long totalRecords = 0;

        JobReport finalJobReport = new JobReport();
        finalJobReport.setStatus(JobStatus.COMPLETED);

        for (JobReport jobReport : jobReports) {
            startTimes.add(jobReport.getMetrics().getStartTime());
            endTimes.add(jobReport.getMetrics().getEndTime());
            totalRecords += jobReport.getMetrics().getTotalCount();
            calculateSkippedRecords(finalJobReport, jobReport);
            calculateFilteredRecords(finalJobReport, jobReport);
            calculateErrorRecords(finalJobReport, jobReport);
            calculateSuccessRecords(finalJobReport, jobReport);
            addJobResult(results, jobReport);
            setStatus(finalJobReport, jobReport);
            dataSources.add(jobReport.getParameters().getDataSource());
        }

        //merge results
        finalJobReport.getMetrics().setStartTime(Collections.min(startTimes));
        finalJobReport.getMetrics().setEndTime(Collections.max(endTimes));
        finalJobReport.getMetrics().setTotalCount(totalRecords);

        mergeResults(results, finalJobReport);

        mergeDataSources(dataSources, finalJobReport);

        return finalJobReport;
    }

    private void mergeDataSources(List dataSources, JobReport finalJobReport) {
        StringBuilder stringBuilder = new StringBuilder();
        for (String dataSource : dataSources) {
            stringBuilder.append(dataSource).append(LINE_SEPARATOR);

        }
        finalJobReport.getParameters().setDataSource(stringBuilder.toString());
    }

    private void mergeResults(List results, JobReport finalJobReport) {
        if (!results.isEmpty()) {
            finalJobReport.setJobResult(new JobResult(results));
        }
    }

    private void setStatus(JobReport finalJobReport, JobReport jobReport) {
        if (JobStatus.ABORTED.equals(jobReport.getStatus())) {
            finalJobReport.setStatus(JobStatus.ABORTED);
        }
        if (JobStatus.FAILED.equals(jobReport.getStatus())) {
            finalJobReport.setStatus(JobStatus.FAILED);
        }
    }

    private void addJobResult(List results, JobReport jobReport) {
        if (jobReport.getResult() != null) {
            results.add(jobReport.getResult());
        }
    }

    private void calculateSuccessRecords(JobReport finalJobReport, JobReport jobReport) {
        for (int i = 0; i < jobReport.getMetrics().getSuccessCount(); i++) {
            finalJobReport.getMetrics().incrementSuccessCount();
        }
    }

    private void calculateErrorRecords(JobReport finalJobReport, JobReport jobReport) {
        for (int i = 0; i < jobReport.getMetrics().getErrorCount(); i++) {
            finalJobReport.getMetrics().incrementErrorCount();
        }
    }

    private void calculateFilteredRecords(JobReport finalJobReport, JobReport jobReport) {
        for (int i = 0; i < jobReport.getMetrics().getFilteredCount(); i++) {
            finalJobReport.getMetrics().incrementFilteredCount();
        }
    }

    private void calculateSkippedRecords(JobReport finalJobReport, JobReport jobReport) {
        for (int i = 0; i < jobReport.getMetrics().getSkippedCount(); i++) {
            finalJobReport.getMetrics().incrementSkippedCount();
        }
    }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy