/*
 * Copyright 2017 Andrew Rucker Jones.
 *
 * 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.opencsv.bean.concurrent;

import com.opencsv.bean.BeanVerifier;
import com.opencsv.bean.CsvToBeanFilter;
import com.opencsv.bean.MappingStrategy;
import com.opencsv.bean.OpencsvUtils;
import com.opencsv.exceptions.*;
import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.ObjectUtils;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.ListIterator;
import java.util.concurrent.BlockingQueue;

A class that encapsulates the job of creating a bean from a line of CSV input
and making it possible to run those jobs in parallel.
Author:
Andrew Rucker Jones
Type parameters:
<T> – The type of the bean being created
Since:
4.0/**
 * A class that encapsulates the job of creating a bean from a line of CSV input
 * and making it possible to run those jobs in parallel.
 * @param <T> The type of the bean being created
 * @author Andrew Rucker Jones
 * @since 4.0
 */
public class ProcessCsvLine<T> implements Runnable {
    private final long lineNumber;
    private final MappingStrategy<? extends T> mapper;
    private final CsvToBeanFilter filter;
    private final List<BeanVerifier<T>> verifiers;
    private final String[] line;
    private final BlockingQueue<OrderedObject<T>> resultantBeanQueue;
    private final BlockingQueue<OrderedObject<CsvException>> thrownExceptionsQueue;
    private final boolean throwExceptions;

    
The only constructor for creating a bean out of a line of input.
Params:
lineNumber – Which record in the input file is being processed
mapper – The mapping strategy to be used
filter – A filter to remove beans from the running, if necessary.
  May be null.
verifiers – The list of verifiers to run on beans after creation
line – The line of input to be transformed into a bean
resultantBeanQueue – A queue in which to place the bean created
thrownExceptionsQueue – A queue in which to place a thrown
  exception, if one is thrown
throwExceptions – Whether exceptions should be thrown, ending
  processing, or suppressed and saved for later processing/**
     * The only constructor for creating a bean out of a line of input.
     * @param lineNumber Which record in the input file is being processed
     * @param mapper The mapping strategy to be used
     * @param filter A filter to remove beans from the running, if necessary.
     *   May be null.
     * @param verifiers The list of verifiers to run on beans after creation
     * @param line The line of input to be transformed into a bean
     * @param resultantBeanQueue A queue in which to place the bean created
     * @param thrownExceptionsQueue A queue in which to place a thrown
     *   exception, if one is thrown
     * @param throwExceptions Whether exceptions should be thrown, ending
     *   processing, or suppressed and saved for later processing
     */
    public ProcessCsvLine(
            long lineNumber, MappingStrategy<? extends T> mapper, CsvToBeanFilter filter,
            List<BeanVerifier<T>> verifiers, String[] line,
            BlockingQueue<OrderedObject<T>> resultantBeanQueue,
            BlockingQueue<OrderedObject<CsvException>> thrownExceptionsQueue,
            boolean throwExceptions) {
        this.lineNumber = lineNumber;
        this.mapper = mapper;
        this.filter = filter;
        this.verifiers = ObjectUtils.defaultIfNull(new ArrayList<>(verifiers), Collections.emptyList());
        this.line = ArrayUtils.clone(line);
        this.resultantBeanQueue = resultantBeanQueue;
        this.thrownExceptionsQueue = thrownExceptionsQueue;
        this.throwExceptions = throwExceptions;
    }

    @Override
    public void run() {
        try {
            if (filter == null || filter.allowLine(line)) {
                T obj = processLine();
                ListIterator<BeanVerifier<T>> verifierList = verifiers.listIterator();
                boolean keep = true;
                while(keep && verifierList.hasNext()) {
                    keep = verifierList.next().verifyBean(obj);
                }
                if (keep) {
                    OpencsvUtils.queueRefuseToAcceptDefeat(
                            resultantBeanQueue,
                            new OrderedObject<>(lineNumber, obj));
                }
            }
        } catch (CsvException e) {
            e.setLineNumber(lineNumber);
            e.setLine(line);
            if (throwExceptions) {
                throw new RuntimeException(e);
            }
            OpencsvUtils.queueRefuseToAcceptDefeat(thrownExceptionsQueue,
                    new OrderedObject<>(lineNumber, e));
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    
Creates a single object from a line from the CSV file.
Throws:
CsvBeanIntrospectionException – Thrown on error creating bean.
CsvBadConverterException – If a custom converter cannot be
  initialized properly
CsvDataTypeMismatchException – If the source data cannot be
  converted to the type of the destination field
CsvRequiredFieldEmptyException – If a mandatory field is empty in
  the input file
CsvConstraintViolationException – When the internal structure of
  data would be violated by the data in the CSV file
CsvValidationException – If a user-supplied validator declares the
  data to be invalid
Returns:
Object containing the values./**
     * Creates a single object from a line from the CSV file.
     * @return Object containing the values.
     * @throws CsvBeanIntrospectionException Thrown on error creating bean.
     * @throws CsvBadConverterException If a custom converter cannot be
     *   initialized properly
     * @throws CsvDataTypeMismatchException If the source data cannot be
     *   converted to the type of the destination field
     * @throws CsvRequiredFieldEmptyException If a mandatory field is empty in
     *   the input file
     * @throws CsvConstraintViolationException When the internal structure of
     *   data would be violated by the data in the CSV file
     * @throws CsvValidationException If a user-supplied validator declares the
     *   data to be invalid
     */
    private T processLine()
            throws CsvBeanIntrospectionException,
            CsvBadConverterException, CsvDataTypeMismatchException,
            CsvRequiredFieldEmptyException, CsvConstraintViolationException,
            CsvValidationException {
        return mapper.populateNewBean(line);
    }
}