KSLCore/ksl.utilities.io.tabularfiles/Row

Row

class Row(tabularFile: TabularFile) : RowGetterIfc, RowSetterIfc, RowIfc

An abstraction for a row within a tabular file. The access to the columns is 0-based. Why? Because most if not all of kotlin's data containers (arrays, lists, etc.) are 0-based. The first column has index 0, 2nd column has index 1, etc.

Constructors

Row

constructor(tabularFile: TabularFile)

Properties

bytes

open override val bytes: Int

columnNames

open override val columnNames: List<String>

columnTypes

open override val columnTypes: Map<String, DataType>

dataTypes

open override val dataTypes: List<DataType>

elements

open override val elements: List<Any?>

isAllNumeric

open override val isAllNumeric: Boolean

isAllText

open override val isAllText: Boolean

numberColumns

open override val numberColumns: Int

numeric

open override val numeric: DoubleArray

numNumericColumns

open override val numNumericColumns: Int

numTextColumns

open override val numTextColumns: Int

rowNum

var rowNum: Long

text

open override val text: Array<String?>

Functions

asStringArray

open override fun asStringArray(): Array<String?>

getColumn

open override fun getColumn(name: String): Int

getColumnName

open override fun getColumnName(col: Int): String

getDataType

open override fun getDataType(colNum: Int): DataType

getElement

open override fun getElement(colNum: Int): Any?

getNumeric

open override fun getNumeric(colNum: Int): Double

open override fun getNumeric(columnName: String): Double

getText

open override fun getText(colNum: Int): String?

open override fun getText(columnName: String): String?

getType

open override fun getType(col: Int): DataType

isNumeric

open override fun isNumeric(i: Int): Boolean

isText

open override fun isText(i: Int): Boolean

setElement

open override fun setElement(colNum: Int, element: Any?)

setElements

open override fun setElements(elements: Array<Any?>)

open override fun setElements(elements: List<Any?>)

open fun setElements(data: TabularData)

The row is filled with the elements. Numeric elements are saved in numeric columns in the order presented. Non-numeric elements are all converted to strings and stored in the order presented. Numeric elements are of types {Double, Long, Integer, Boolean, Float, Short, Byte}. Any other type is converted to text via toString().

setNumeric

open override fun setNumeric(data: DoubleArray): Int

Sets the numeric columns according to the data in the array. If the array has more elements than the number of columns, then the columns are filled with first elements of the array up to the number of columns. If the array has fewer elements than the number of columns, then only the first data.length columns are set.

open override fun setNumeric(colNum: Int, value: Double)

open override fun setNumeric(columnName: String, value: Double)

open fun setNumeric(colNum: Int, value: Boolean)

setText

open override fun setText(data: Array<String?>): Int

Sets the text columns according to the data in the array. If the array has more elements than the number of columns, then the columns are filled with first elements of the array up to the number of columns. If the array has less elements than the number of columns, then only the first data.length columns are set.

open override fun setText(data: List<String?>): Int

Sets the text columns according to the data in the list. If the list has more elements than the number of columns, then the columns are filled with first elements of the list up to the number of columns. If the list has less elements than the number of columns, then only the first data.size() columns are set.

open override fun setText(colNum: Int, value: String?)

open override fun setText(columnName: String, value: String?)

toCSV

open override fun toCSV(): String

toString

open override fun toString(): String