TestData.java

/*
 * 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 tech.tablesaw;

import java.io.FileInputStream;
import java.io.IOException;
import java.nio.file.Path;
import java.nio.file.Paths;
import tech.tablesaw.api.ColumnType;
import tech.tablesaw.api.Table;
import tech.tablesaw.io.csv.CsvReadOptions;

/**
 * This class setup Tablesaw Tables from test data sources. It purpose is to make easy for tests or
 * example code get data to work with.
 */
public enum TestData {
  SIMPLE_DATA_WITH_CANONICAL_DATE_FORMAT(
      new String[] {"Name", "IQ", "City", "DOB"},
      new ColumnType[] {
        ColumnType.STRING, ColumnType.DOUBLE, ColumnType.STRING, ColumnType.LOCAL_DATE
      },
      "../data/simple-data-with-canonical-date-format.csv"),

  SIMPLE_UNSORTED_DATA(
      new String[] {"Name", "IQ", "City", "DOB"},
      new ColumnType[] {
        ColumnType.STRING, ColumnType.DOUBLE, ColumnType.STRING, ColumnType.LOCAL_DATE
      },
      "../data/unsorted-simple-data.csv"),

  SIMPLE_SORTED_DATA_BY_DOUBLE_ASCENDING(
      new String[] {"Name", "IQ", "City", "DOB"},
      new ColumnType[] {
        ColumnType.STRING, ColumnType.DOUBLE, ColumnType.STRING, ColumnType.LOCAL_DATE
      },
      "../data/simple-data-sort_by_int_ascending.csv"),

  SIMPLE_SORTED_DATA_BY_DOUBLE_DESCENDING(
      new String[] {"Name", "IQ", "City", "DOB"},
      new ColumnType[] {
        ColumnType.STRING, ColumnType.DOUBLE, ColumnType.STRING, ColumnType.LOCAL_DATE
      },
      "../data/simple-data-sort_by_int_descending.csv"),

  SIMPLE_SORTED_DATA_BY_DOUBLE_ASCENDING_AND_THEN_DATE_DESCENDING(
      new String[] {"Name", "IQ", "City", "DOB"},
      new ColumnType[] {
        ColumnType.STRING, ColumnType.DOUBLE, ColumnType.STRING, ColumnType.LOCAL_DATE
      },
      "../data/simple-data-sort_by_int_ascending.csv"),

  SIMPLE_SORTED_DATA_BY_DOUBLE_AND_DATE_ASCENDING(
      new String[] {"Name", "IQ", "City", "DOB"},
      new ColumnType[] {
        ColumnType.STRING, ColumnType.DOUBLE, ColumnType.STRING, ColumnType.LOCAL_DATE
      },
      "../data/simple-data-sort_by_int_and_date_ascending.csv"),

  SIMPLE_SORTED_DATA_BY_DOUBLE_AND_DATE_DESCENDING(
      new String[] {"Name", "IQ", "City", "DOB"},
      new ColumnType[] {
        ColumnType.STRING, ColumnType.DOUBLE, ColumnType.STRING, ColumnType.LOCAL_DATE
      },
      "../data/simple-data-sort_by_int_and_date_descending.csv"),

  BUSH_APPROVAL(
      new String[] {"date", "approval", "who"},
      new ColumnType[] {ColumnType.LOCAL_DATE, ColumnType.DOUBLE, ColumnType.STRING},
      "../data/bush.csv"),

  TORNADOES(
      new String[] {
        "Number",
        "Year",
        "Month",
        "Day",
        "Date",
        "Time",
        "Zone",
        "State",
        "State FIPS",
        "State No",
        "Scale",
        "Injuries",
        "Fatalities",
        "Loss",
        "Crop Loss",
        "Start Lat",
        "Start Lon",
        "End Lat",
        "End Lon",
        "Length",
        "Width",
        "NS",
        "SN",
        "SG",
        "FIPS 1",
        "FIPS 2",
        "FIPS 3",
        "FIPS 4"
      },
      new ColumnType[] {
        ColumnType.DOUBLE,
        ColumnType.DOUBLE,
        ColumnType.DOUBLE,
        ColumnType.DOUBLE,
        ColumnType.LOCAL_DATE,
        ColumnType.LOCAL_TIME,
        ColumnType.STRING,
        ColumnType.STRING,
        ColumnType.STRING,
        ColumnType.DOUBLE,
        ColumnType.DOUBLE,
        ColumnType.DOUBLE,
        ColumnType.DOUBLE,
        ColumnType.DOUBLE,
        ColumnType.DOUBLE,
        ColumnType.DOUBLE,
        ColumnType.DOUBLE,
        ColumnType.DOUBLE,
        ColumnType.DOUBLE,
        ColumnType.DOUBLE,
        ColumnType.DOUBLE,
        ColumnType.DOUBLE,
        ColumnType.DOUBLE,
        ColumnType.DOUBLE,
        ColumnType.STRING,
        ColumnType.STRING,
        ColumnType.STRING,
        ColumnType.STRING
      },
      "../data/1950-2014_torn.csv");

  private Table table;
  private ColumnType[] columnTypes;
  private Path source;
  private String[] columnNames;

  /**
   * Creates a Table from the specified daa.
   *
   * @param columnNames the first row of data which should be tge column labels
   * @param columnTypes the data type for each column
   * @param csvSource the raw source for this data.
   */
  TestData(String[] columnNames, ColumnType[] columnTypes, String csvSource) {
    this.columnNames = columnNames;
    try {
      this.table =
          Table.read()
              .csv(CsvReadOptions.builder(new FileInputStream(csvSource)).columnTypes(columnTypes));
    } catch (IOException e) {
      throw new IllegalStateException("Unable to read from CSV file", e);
    }
    this.columnTypes = columnTypes;
    this.source = Paths.get(csvSource);
  }

  /**
   * @return The Table for a specific data set
   */
  public Table getTable() {
    return table;
  }

  /**
   * @return the column types for the data set.
   */
  public ColumnType[] getColumnTypes() {
    return columnTypes;
  }

  /**
   * @return The path to the raw data for this data set
   */
  public Path getSource() {
    return source;
  }

  /*
   * @return the column names (i.e. header, labels) for each column.
   */
  public String[] getColumnNames() {
    return columnNames;
  }
}