Module com.github.hazendaz.parent
Package org.csveed.api

Interface Row

All Superinterfaces:
Iterable<String>
All Known Implementing Classes:
RowImpl
public interface Row extends Iterable<String>
A Row is a line of content read from the CSV file. Note that a Row is never a Header. Rows can be iterated which yields the individual cells as Strings.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    get(int columnIndex)
    Gets the content of the cell on the basis of its cell position within the Row.
    String
    get(String columnName)
    Gets the content of the cell in the column named columnName.
    String
    getColumnName(int columnIndex)
    Gets the column name belonging to the cell.
    Header
    getHeader()
    Returns the Headers and throws an exception if it does not exist.
    boolean
    hasHeader()
    Returns true if a Header has been set for this Row.
    RowReport
    reportOnColumn(int columnIndex)
    Generates a report on the Row with focus on a particular cell.
    RowReport
    reportOnEndOfLine()
    Generates a report on the Row with focus on the end of the row.
    int
    size()
    The number of columns in the Row.

    Methods inherited from interface java.lang.Iterable

    forEach, iterator, spliterator

  • Method Details

    • size

      int size()
      The number of columns in the Row.
      Returns:
      number of columns

    • get

      String get(int columnIndex)
      Gets the content of the cell on the basis of its cell position within the Row. Counting is 0-based.
      Parameters:
      columnIndex - the position of the cell within the Row
      Returns:
      the content of the cell

    • get

      String get(String columnName)
      Gets the content of the cell in the column named columnName. This method depends on the availability of a Header, or will otherwise throw an exception
      Parameters:
      columnName - the cell of the Row in the same column as the header with name columnName
      Returns:
      the content of the cell

    • getColumnName

      String getColumnName(int columnIndex)
      Gets the column name belonging to the cell. This method depends on the availability of a Header, or will otherwise throw an exception
      Parameters:
      columnIndex - the position of the header cell within the Header line
      Returns:
      the name of the column

    • hasHeader

      boolean hasHeader()
      Returns true if a Header has been set for this Row.
      Returns:
      true if Header has been found

    • getHeader

      Header getHeader()
      Returns the Headers and throws an exception if it does not exist. Use hasHeader() if you want to prevent the throwing of an exception when a Header can lack
      Returns:
      the Header for the Row

    • reportOnEndOfLine

      RowReport reportOnEndOfLine()
      Generates a report on the Row with focus on the end of the row. This is internally used when there is a syntax error in the line. It could also be used when there is an error that can not be traced back to a single cell.
      Returns:
      report on the row with focus on the end of the row

    • reportOnColumn

      RowReport reportOnColumn(int columnIndex)
      Generates a report on the Row with focus on a particular cell. The report can return lines for web consumption (assisting highlighting) or monospaced font printing with dual lines, the first holding the value of the line, the second showing where the error occurred.
      Parameters:
      columnIndex - the index of the column to focus the report on
      Returns:
      report on the row with focus on a particular cell