KSLCore/ksl.utilities.io.tabularfiles/TabularFile/Companion

Companion

object Companion

Functions

asDouble

fun asDouble(element: Any?): Double

column

fun column(name: String, dataType: DataType): ColumnType

Creates a column with the given data type

columnNames

fun columnNames(number: Int, prefix: String = "C"): List<String>

Makes a list of strings containing, prefix1, prefix2,..., prefixN, where N = number

columns

fun columns(numColumns: Int, dataType: DataType): Map<String, DataType>

Creates n = numColumns of columns all with the same data type, with names C1, C2, ..., Cn

fun columns(names: List<String>, dataType: DataType): Map<String, DataType>

Creates names.size() columns with the provided names and data type

createFromCSVFile

fun createFromCSVFile(pathToCSVFile: Path, columnTypes: Map<String, DataType>, pathToOutputFile: Path = pathToCSVFile.parent.resolve( "${KSLFileUtil.removeLastFileExtension(pathToCSVFile.fileName.toString())}_TabularFile" ), hasHeader: Boolean = true): TabularOutputFile

fun createFromCSVFile(pathToCSVFile: Path, columnTypes: Map<String, DataType>, outFileName: String, hasHeader: Boolean = true): TabularOutputFile

Reads in a CSV file and converts it to a tabular output file. The separator must be a comma.

isNumeric

fun isNumeric(element: Any?): Boolean

Test if the object is any of {Double, Long, Integer, Boolean, Float, Short, Byte}

numericColumn

fun numericColumn(name: String): ColumnType

Creates a double column

textColumn

fun textColumn(name: String): ColumnType

Creates a text column

toDataType

fun toDataType(kType: KType): DataType

If the kType is {Double, Long, Integer, Boolean, Float, Short, Byte} then it is NUMERIC otherwise it is considered TEXT.

toDataTypes

fun toDataTypes(types: List<KType>): List<DataType>

Converts the list of KType instances to a list of DataType instances. If the type is {Double, Long, Integer, Boolean, Float, Short, Byte} then it is NUMERIC otherwise it is considered TEXT.