Package org.djutils.data.csv

Class TsvData

  • public final class TsvData
extends Object
    TsvData takes care of reading and writing of table data in Tab-Separated-Value format. The class can be used, e.g., as follows: 
     Table dataTable = new ListTable("data", "dataTable", columns);
 Writer writer = new FileWriter("c:/data/data.tsv");
 Writer metaWriter = new FileWriter("c:/data/data.meta.tsv");
 TsvData.writeData(writer, metaWriter, dataTable);

    Copyright (c) 2020-2023 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
    BSD-style license. See DJUTILS License.

    Author:
    Alexander Verbraeck, Peter Knoppers, Wouter Schakel

    • Method Detail

      • writeData

        public static void writeData​(Writer writer,
                             Writer metaWriter,
                             Table dataTable)
                      throws IOException,
                             TextSerializationException
        Write the data from the data table in TSV format. The writer writes the data, whereas the metaWriter writes the metadata. The metadata consists of a TSV file with three columns: the id, the description, and the class. The first row after the header contains the id, description, and class of the data table itself. The second and further rows contain information about the columns of the data table.
        Parameters:
        writer - Writer; the writer that writes the data, e.g. to a file
        metaWriter - Writer; the writer for the metadata
        dataTable - Table; the data table to write
        Throws:
        IOException - on I/O error when writing the data
        TextSerializationException - on unknown data type for serialization

      • writeData

        public static void writeData​(String filename,
                             String metaFilename,
                             Table dataTable)
                      throws IOException,
                             TextSerializationException
        Write the data from the data table in TSV format.
        Parameters:
        filename - String; the file name to write the data to
        metaFilename - String; the file name to write the metadata to
        dataTable - Table; the data table to write
        Throws:
        IOException - on I/O error when writing the data
        TextSerializationException - on unknown data type for serialization

      • writeZippedData

        public static void writeZippedData​(CompressedFileWriter writer,
                                   String tsvName,
                                   String metaName,
                                   Table table)
                            throws IOException,
                                   TextSerializationException
        Write the data from the data table in TSV format. The data file and meta data file are zipped. The metadata consists of a TSV file with three columns: the id, the description, and the class. The first row after the header contains the id, description, and class of the data table itself. The second and further rows contain information about the columns of the data table.
        Parameters:
        writer - Writer; the writer that writes the data, e.g. to a file
        tsvName - String; name of the TSV file within the zip file
        metaName - String; name of the meta data file within the zip file
        table - Table; the data table to write
        Throws:
        IOException - on I/O error when writing the data
        TextSerializationException - on unknown data type for serialization

      • readData

        public static Table readData​(Reader reader,
                             Reader metaReader)
                      throws IOException,
                             TextSerializationException
        Read the data from the TSV-file into the data table. Use the metadata to reconstruct the data table.
        Parameters:
        reader - Reader; the reader that can read the data, e.g. from a file
        metaReader - Reader; the writer for the metadata
        Returns:
        dataTable the data table reconstructed from the meta data and filled with the data
        Throws:
        IOException - on I/O error when reading the data
        TextSerializationException - on unknown data type for serialization

      • readData

        public static Table readData​(String filename,
                             String metaFilename)
                      throws IOException,
                             TextSerializationException
        Read the data from the TSV-file into the data table. Use the metadata to reconstruct the data table.
        Parameters:
        filename - String; the file name to read the data from
        metaFilename - String; the file name to read the metadata from
        Returns:
        dataTable the data table reconstructed from the meta data and filled with the data
        Throws:
        IOException - on I/O error when reading the data
        TextSerializationException - on unknown data type for serialization

      • readZippedData

        public static Table readZippedData​(String fileName,
                                   String tsvName,
                                   String metaName)
                            throws IOException,
                                   TextSerializationException
        Read the data from a TSV-file inside a zip file. The metadata file should be in the same zipfile. Use the metadata to reconstruct the data table.
        Parameters:
        fileName - String; file name of the zip file
        tsvName - String; name of the TSV-file, without path
        metaName - String; name of the metadata file, without path
        Returns:
        Table the data table reconstructed from the meta data and filled with the data
        Throws:
        IOException - when the CSV data was not formatted right
        TextSerializationException - on unknown data type for serialization