de.qytera.qtaf.data.csv.CsvLoader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of qtaf-data Show documentation
There is a newer version: 0.2.23
package de.qytera.qtaf.data.csv;

import de.qytera.qtaf.core.io.DirectoryHelper;
import org.apache.commons.csv.CSVFormat;
import org.apache.commons.csv.CSVRecord;

import java.io.FileNotFoundException;
import java.io.FileReader;
import java.io.IOException;
import java.io.Reader;

/**
 * CSV loader class
 */
public class CsvLoader {
    /**
     * File path
     */
    protected String filePath = "";

    /**
     * Has headers flag
     */
    protected boolean hasHeaders = true;

    /**
     * Header names array
     */
    protected String[] HEADERS = {};

    /**
     * Get CSV file path
     * @return  CSV file path
     */
    protected String getFilePath() {
        return DirectoryHelper.preparePath(filePath);
    }

    /**
     * Set filePath
     *
     * @param filePath FilePath
     * @return this
     */
    public CsvLoader setFilePath(String filePath) {
        this.filePath = filePath;
        return this;
    }

    /**
     * Has headers flag
     * @return true if has headers, false otherwise
     */
    protected boolean hasHeaders() {
        return hasHeaders;
    }

    /**
     * Get CSV delimiter
     * @return  CSV delimiter
     */
    protected char getDelimiter() {
        return ',';
    }

    /**
     * Get CSV headers
     * @return  CSV headers
     */
    protected String[] getHeaders() {
        return HEADERS;
    }

    /**
     * Get reader that allows reading a local file
     *
     * @return reader
     * @throws FileNotFoundException    File reading error
     */
    protected Reader getReader() throws FileNotFoundException {
        return new FileReader(getFilePath());
    }

    /**
     * Get CSV records from a CSV file
     *
     * @return List of CSV records
     * @throws IOException  Error reading file
     */
    public Iterable getCsvRecords() throws IOException {
        Reader in = getReader();

        CSVFormat csv = CSVFormat.DEFAULT;
        csv = csv.withDelimiter(getDelimiter()).withIgnoreSurroundingSpaces().withIgnoreEmptyLines();

        if (hasHeaders()) {
            csv = csv.withHeader(getHeaders()).withFirstRecordAsHeader();
        }

        return csv.parse(in);
    }
}