gapt.formats.csv.csv.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gapt_3 Show documentation
General Architecture for Proof Theory
The newest version!
package gapt.formats.csv

/**
 * Represents one row in a csv file
 * @param cells the content of each column
 * @tparam T the type of cells
 */
case class CSVRow[T](cells: Seq[T]) {

  /**
   * Appends the given row to this row's columns
   * @param row
   * @return
   */
  def ++(row: CSVRow[T]) = CSVRow(cells ++ row.cells)
}

/**
 * Represents a csv file with a header
 * @param header the header row
 * @param rows the data rows
 * @param sep the column seprator
 * @tparam T the cell type
 */
case class CSVFile[T](header: CSVRow[T], rows: Seq[CSVRow[T]], sep: String) {

  override def toString(): String = {
    val sb = new StringBuilder()
    sb.append(header.cells.mkString("", sep, "\n"))
    for (r <- rows) {
      sb.append(r.cells.mkString("", sep, "\n"))
    }
    sb.toString()
  }

  /**
   * Adds given file as columns right of the current ones
   * @param file
   * @return the file with the extended rows and header
   */
  def ++(file: CSVFile[T]) = {
    require(file.sep == sep, "can only merge csv files with the same seperator")
    require(file.rows.size == rows.size, "can only merge csv files with same number of rows")
    CSVFile(header ++ file.header, (rows zip file.rows).map { case (x, y) => x ++ y }, sep)
  }

  /**
   * Flips rows / columns
   */
  def transpose(): CSVFile[T] = {
    val raw_header_rows = (header +: rows).map(_.cells)
    val req_data = raw_header_rows.toSet.map((x: Seq[T]) => x.size)
    val cols = req_data.toList(0)
    require(req_data.size == 1, "All rows must have the same number of columns")
    require(cols > 0, "Need columns to flip")

    val new_rows = for (i <- 1 to cols) yield {
      CSVRow(raw_header_rows.map(_.apply(i - 1)))
    }

    CSVFile(new_rows.head, new_rows.tail, sep)

  }

}

object CSVFile {
  val defaultSep = ", "
}

trait CSVConvertible[T] {

  /**
   * Returns the csv header decribing the data
   */
  def csvHeader(): CSVRow[String]

  /**
   * Converts the data to a CSV row
   */
  def toCSV(): CSVRow[T]

}