jdplus.sa.base.csv.TsCollectionCsvFormatter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jdplus-sa-base-csv Show documentation
${project.parent.artifactId} - ${project.artifactId}
There is a newer version: 3.3.0
/*
 * Copyright 2013 National Bank of Belgium
 *
 * Licensed under the EUPL, Version 1.1 or – as soon they will be approved 
 * by the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 *
 * http://ec.europa.eu/idabc/eupl
 *
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and 
 * limitations under the Licence.
 */
package jdplus.sa.base.csv;

import jdplus.toolkit.base.api.information.formatters.BasicConfiguration;
import jdplus.toolkit.base.api.timeseries.TsData;
import jdplus.toolkit.base.api.timeseries.TsDataTable;
import jdplus.toolkit.base.api.timeseries.TsDomain;
import jdplus.toolkit.base.api.timeseries.TsPeriod;
import jdplus.toolkit.base.api.util.MultiLineNameUtil;
import java.io.IOException;
import java.io.Writer;
import java.text.DecimalFormat;
import java.text.NumberFormat;
import java.time.format.DateTimeFormatter;
import java.util.List;
import java.util.Locale;

/**
 *
 * @author Kristof Bayens
 */
public class TsCollectionCsvFormatter {

    private CsvLayout layout_ = CsvLayout.VTable;
    private final char comma;
    private static final String newLine = System.lineSeparator();
    private final DecimalFormat fmt;
    private final NumberFormat ifmt;
    private boolean fullName;

    public TsCollectionCsvFormatter() {
        ifmt = NumberFormat.getIntegerInstance(Locale.getDefault());
        ifmt.setGroupingUsed(false);
        comma = CsvInformationFormatter.getCsvSeparator();
        fmt = (DecimalFormat) DecimalFormat.getNumberInstance(Locale.getDefault());
        fmt.setMaximumFractionDigits(BasicConfiguration.getFractionDigits());
        fmt.setGroupingUsed(false);
    }

    public CsvLayout getPresentation() {
        return layout_;
    }

    public void setPresentation(CsvLayout layout) {
        layout_ = layout;
    }

    public void setFullName(boolean fullName) {
        this.fullName = fullName;
    }

    public boolean write(List coll, List names, Writer writer) throws IOException {
        if (coll.isEmpty() || names.size() != coll.size()) {
            return false;
        }
        if (layout_ == CsvLayout.List) {
            return writeList(coll, names, writer);
        }

        TsDataTable table = TsDataTable.of(coll);
        TsDomain domain = table.getDomain();
        if (domain.isEmpty()) {
            return false;
        }
        int ndata = domain.getLength();
        int nseries = coll.size();

        TsDataTable.Cursor cursor = table.cursor(TsDataTable.DistributionType.LAST);
        if (layout_ == CsvLayout.VTable) {
            writer.write(comma);
            for (int i = 0; i < nseries; ++i) {
                write(names.get(i), writer);
                if (i != nseries - 1) {
                    writer.write(comma);
                } else {
                    writer.write(newLine);
                }
            }

            for (int j = 0; j < ndata; ++j) {
                writer.write(domain.get(j).toString());
                for (int i = 0; i < nseries; ++i) {
                    writer.write(comma);
                    cursor.moveTo(j, i);
                    if (cursor.getStatus() == TsDataTable.ValueStatus.PRESENT) {
                        write(fmt.format(cursor.getValue()), writer);
                    }
                }
                writer.write(newLine);
            }
        } else {
            writer.write(comma);
            for (int i = 0; i < ndata; ++i) {
                writer.write(domain.get(i).start().toLocalDate().format(DateTimeFormatter.ISO_DATE));
                if (i != ndata - 1) {
                    writer.write(comma);
                } else {
                    writer.write(newLine);
                }
            }
            for (int j = 0; j < nseries; ++j) {
                write(names.get(j), writer);
                for (int i = 0; i < ndata; ++i) {
                    writer.write(comma);
                    cursor.moveTo(i, j);
                    if (cursor.getStatus() == TsDataTable.ValueStatus.PRESENT) {
                        write(fmt.format(cursor.getValue()), writer);
                    }
                }
                writer.write(newLine);
            }
        }
        return true;
    }

    private boolean writeList(List coll, List names, Writer writer) throws IOException {
        int nseries = names.size();
        for (int j = 0; j < nseries; ++j) {
            write(names.get(j), writer);
            writer.write(comma);
            TsData cur = coll.get(j);
            if (cur != null) {
                // header: freq, start, pos, length
                TsPeriod start = cur.getStart();
                writer.write(ifmt.format(start.annualFrequency()));
                writer.write(comma);
                writer.write(ifmt.format(start.year()));
                writer.write(comma);
                writer.write(ifmt.format(start.annualPosition() + 1));
                writer.write(comma);
                writer.write(ifmt.format(cur.length()));
                for (int i = 0; i < cur.length(); ++i) {
                    writer.write(comma);
                    double val = cur.getValue(i);
                    if (!Double.isNaN(val)) {
                        write(fmt.format(val), writer);
                    }
                }
            }
            writer.write(newLine);
        }
        return true;
    }

    private void write(String txt, Writer writer) throws IOException {

        if (txt == null) {
            return;
        }
        if (fullName) {
            txt = MultiLineNameUtil.join(txt, " * ");
        } else {
            txt = MultiLineNameUtil.last(txt);
        }

        if (txt.indexOf(comma) >= 0) {
            if (txt.indexOf('\"') >= 0) {
                writer.write("\"\"");
                writer.write(txt);
                writer.write("\"\"");
            } else {
                writer.write('\"');
                writer.write(txt);
                writer.write('\"');
            }
        } else {
            if (txt.indexOf('\"') >= 0) {
                writer.write("\"\"");
                writer.write(txt);
                writer.write("\"\"");
            } else {
                writer.write(txt);
            }
        }
    }
}