KSLCore/ksl.utilities.io.tabularfiles/TabularInputFile

TabularInputFile

An abstraction for reading rows of tabular data. Columns of the tabular data can be of numeric or text. Using this subclass of TabularFile users can read rows of data. The user is responsible for iterating rows with data of the appropriate type for the column and reading the row into their program.

Use the static methods of TabularFile to create and define the columns of the file. Use the methods of this class to read rows.

Constructors

TabularInputFile

constructor(path: Path)

Types

Companion

object Companion

RowIterator

inner class RowIterator(startingRowNum: Long = 1) : Iterator<RowGetterIfc>

Properties

columnNames

val columnNames: List<String>

columnTypes

val columnTypes: Map<String, DataType>

dataTypes

val dataTypes: List<DataType>

isAllNumeric

val isAllNumeric: Boolean

isAllText

val isAllText: Boolean

numberColumns

val numberColumns: Int

numericColumnNames

val numericColumnNames: List<String>

numNumericColumns

val numNumericColumns: Int

numTextColumns

val numTextColumns: Int

path

val path: Path

rowBufferSize

var rowBufferSize: Int

textColumnNames

val textColumnNames: List<String>

totalNumberRows

val totalNumberRows: Long

Functions

asDatabase

fun asDatabase(): DatabaseIfc

Transforms the file into an SQLite database file

asDataFrame

open override fun asDataFrame(): AnyFrame

Converts the columns and rows to a Dataframe.

checkTypes

fun checkTypes(elements: Array<Any?>): Boolean

fun close()

Remember to close the file after all processing

columnIndex

fun columnIndex(name: String): Int

columnIndexForNumeric

fun columnIndexForNumeric(storageIndex: Int): Int

Returns the column index associated with the storage index

columnIndexForText

fun columnIndexForText(storageIndex: Int): Int

Returns the column index associated with the storage index

columnName

fun columnName(colNum: Int): String

dataType

fun dataType(colNum: Int): DataType

exportToCSV

fun exportToCSV(out: PrintWriter, header: Boolean = true)

Writes the data in the file to a CSV file

exportToExcelWorkbook

fun exportToExcelWorkbook(wbName: String, wbDirectory: Path)

This is not optimized for large files and may have memory and performance issues.

fetchNumericColumn

fun fetchNumericColumn(columnNum: Int, maxRows: Int = 0, removeMissing: Boolean = false): DoubleArray

fun fetchNumericColumn(columnName: String, maxRows: Int = 0, removeMissing: Boolean = false): DoubleArray

Obviously, there are memory issues if there are a lot of rows.

fetchRow

fun fetchRow(rowNum: Long): RowGetterIfc

Returns the row. If the provided row number is larger than the number of rows in the file then an exception is thrown. Use fetchRow() if you do not check the number of rows.

fetchRows

fun fetchRows(minRowNum: Long, maxRowNum: Long): List<RowGetterIfc>

Returns the rows between minRowNum and maxRowNum, inclusive. Since there may be memory implications when using this method, please use it wisely. In fact, use the provided iterator instead.

fetchTextColumn

fun fetchTextColumn(columnNum: Int, maxRows: Int = 0, removeMissing: Boolean = false): Array<String?>

fun fetchTextColumn(columnName: String, maxRows: Int = 0, removeMissing: Boolean = false): Array<String?>

Obviously, there are memory issues if there are a lot of rows.

isNumeric

fun isNumeric(colNum: Int): Boolean

isText

fun isText(colNum: Int): Boolean

iterator

fun iterator(startingRow: Long = 1): TabularInputFile.RowIterator

numericColumns

fun numericColumns(maxRows: Int = 0, removeMissing: Boolean = false): Map<String, DoubleArray>

numericStorageIndex

fun numericStorageIndex(colNum: Int): Int

Returns the storage index of the numeric column at column index

printAsText

fun printAsText(minRowNum: Long = 1, maxRowNum: Long = minRowNum + 10)

This is not optimized for large files and may have memory and performance issues.

textColumns

fun textColumns(maxRows: Int = 0, removeMissing: Boolean = false): Map<String, Array<String?>>

textStorageIndex

fun textStorageIndex(colNum: Int): Int

Returns the storage index of the text column at column index

toString

open override fun toString(): String

writeAsText

fun writeAsText(out: PrintWriter, minRowNum: Long = 1, maxRowNum: Long = totalNumberRows)

This is not optimized for large files and may have memory and performance issues.

TabularInputFile

See also

Constructors

Types

Properties

Functions