core/org.jetbrains.kotlinx.dataframe.api/Convert

Convert

class Convert<T, out C>(val df: DataFrame<T>, val columns: ColumnsSelector<T, C>)

An intermediate class used in the convert operation.

This class itself does not perform any conversion — it is a transitional step before specifying how to convert the selected columns. It must be followed by one of the conversion methods to produce a new DataFrame with updated column values and types.

The resulting columns will keep their original names and positions in the DataFrame, but their values will be transformed.

Use the following methods to perform the conversion:

to(kType)/to<Type>() – converts columns to a specific type.
asColumn { columnConverter } - converts columns using column converter expression.
with – applies a custom row-wise conversion expression.
notNull – like with, but only for non-null values.
perRowCol – applies a conversion that uses both column and row information.
asFrame – converts column groups as a DataFrame with the given expression.
toStr, toInt, toLong, toDouble, toFloat, toBigDecimal, toBigInteger, toBoolean – convert to standard types.
toLocalDateTime, toLocalDate, toLocalTime – convert to kotlinx.datetime types.
toInstant (temporarily deprecated), toStdlibInstant, toDeprecatedInstant – convert to Instant
toUrl, toIFrame, toImg – convert to special types.
toDataFrames – converts a column of lists into separate DataFrames.

See Grammar for more details.

See convert on the documentation website.

Constructors

Convert

constructor(df: DataFrame<T>, columns: ColumnsSelector<T, C>)

Properties

columns

@PublishedApi

internal val columns: ColumnsSelector<T, C>

@PublishedApi

internal val df: DataFrame<T>

Functions

asColumn

inline fun <T, C, R> Convert<T, C>.asColumn(crossinline columnConverter: DataFrame<T>.(DataColumn<C>) -> BaseColumn<R>): DataFrame<T>

Converts values in the columns previously selected with convert using columnConverter expression within the DataFrame.

asFrame

fun <T, C, R> Convert<T, DataRow<C>>.asFrame(expression: ColumnsContainer<T>.(ColumnGroup<C>) -> DataFrame<R>): DataFrame<T>

Converts column groups previously selected with convert as a DataFrame using a dataframe expression.

cast

fun <R> cast(): Convert<T, R>

Casts the type parameter of the columns previously selected with convert to a new type R, without performing any actual data transformation.

convertRowColumnImpl

@PublishedApi

internal fun <T, C, R> Convert<T, C>.convertRowColumnImpl(type: KType, infer: Infer, rowConverter: RowColumnExpression<T, C, R>): DataFrame<T>

notNull

inline fun <T, C, reified R> Convert<T, C?>.notNull(crossinline expression: RowValueExpression<T, C, R>): DataFrame<T>

perRowCol

inline fun <T, C, reified R> Convert<T, C>.perRowCol(infer: Infer = Infer.Nulls, noinline expression: RowColumnExpression<T, C, R>): DataFrame<T>

Converts values in the columns previously selected with convert using row column expression within the DataFrame.

splitInplace

internal inline fun <T, C, R> Convert<T, C?>.splitInplace(type: KType, crossinline transform: DataRow<T>.(C) -> Iterable<R>): DataFrame<T>

inline fun <reified D> to(parserOptions: ParserOptions? = null): DataFrame<T>

Converts the values in the columns previously selected with convert to the specified type, preserving their original names and positions within the DataFrame.

fun <T, C> Convert<T, C>.to(columnConverter: DataFrame<T>.(DataColumn<C>) -> BaseColumn<*>): DataFrame<T>

fun <T> Convert<T, *>.to(type: KType, parserOptions: ParserOptions? = null): DataFrame<T>

Converts the values in the columns previously selected with convert to the specified type, preserving their original names and positions within the DataFrame.

toBigDecimal

fun <T> Convert<T, Any?>.toBigDecimal(): DataFrame<T>

Converts values in the columns previously selected with convert to BigDecimal, preserving their original names and positions within the DataFrame. Preserves null values.

toBigInteger

fun <T> Convert<T, Any?>.toBigInteger(): DataFrame<T>

Converts values in the columns previously selected with convert to BigInteger, preserving their original names and positions within the DataFrame. Preserves null values.

toBoolean

fun <T> Convert<T, Any?>.toBoolean(): DataFrame<T>

Converts values in the columns previously selected with convert to Boolean, preserving their original names and positions within the DataFrame. Preserves null values.

toDataFrames

fun <T, C> Convert<T, List<List<C>>>.toDataFrames(containsColumns: Boolean = false): DataFrame<T>

Converts a list of lists values in the columns previously selected with convert to DataFrame, preserving their original names and positions within the DataFrame.

toDateTimeComponents

fun <T> Convert<T, *>.toDateTimeComponents(): DataFrame<T>

Converts values in the columns previously selected with convert to DateTimeComponents, preserving their original names and positions within the DataFrame.

@FormatStringsInDatetimeFormats

fun <T> Convert<T, String?>.toDateTimeComponents(pattern: String): DataFrame<T>

fun <T> Convert<T, String?>.toDateTimeComponents(format: DateTimeFormat<DateTimeComponents>? = null): DataFrame<T>

Converts values in the String columns previously selected with convert to DateTimeComponents, preserving their original names and positions within the DataFrame. Preserves null values.

toDeprecatedInstant

fun <T> Convert<T, String?>.~~toDeprecatedInstant~~(): DataFrame<T>

Converts values in the String columns previously selected with convert to kotlinx.datetime.Instant, preserving their original names and positions within the DataFrame. Preserves null values.

toDouble

fun <T> Convert<T, Any?>.toDouble(): DataFrame<T>

Converts values in the columns previously selected with convert to Double, preserving their original names and positions within the DataFrame. Preserves null values.

toDuration

fun <T> Convert<T, Any?>.toDuration(): DataFrame<T>

Converts values in the columns previously selected with convert to Duration, preserving their original names and positions within the DataFrame. Preserves null values.

toFloat

fun <T> Convert<T, Any?>.toFloat(): DataFrame<T>

Converts values in the columns previously selected with convert to Float, preserving their original names and positions within the DataFrame. Preserves null values.

toIFrame

fun <T> Convert<T, URL?>.toIFrame(border: Boolean = false, width: Int? = null, height: Int? = null): DataFrame<T>

Converts values in the URL columns previously selected with convert to IFRAME, preserving their original names and positions within the DataFrame. Preserves null values.

toImg

fun <T> Convert<T, URL?>.toImg(width: Int? = null, height: Int? = null): DataFrame<T>

Converts values in the URL columns previously selected with convert to IMG, preserving their original names and positions within the DataFrame. Preserves null values.

toInstant

fun <T> Convert<T, String?>.~~toInstant~~(): DataFrame<T>

Deprecated:

toInt

fun <T> Convert<T, Any?>.toInt(): DataFrame<T>

Converts values in the columns previously selected with convert to Int, preserving their original names and positions within the DataFrame. Preserves null values.

toJavaDuration

fun <T> Convert<T, Any?>.toJavaDuration(): DataFrame<T>

Converts values in the columns previously selected with convert to JavaDuration, preserving their original names and positions within the DataFrame. Preserves null values.

toJavaInstant

fun <T> Convert<T, Any?>.toJavaInstant(): DataFrame<T>

Converts values in the columns previously selected with convert to JavaInstant, preserving their original names and positions within the DataFrame. Preserves null values.

toJavaLocalDate

fun <T> Convert<T, Any?>.toJavaLocalDate(): DataFrame<T>

Converts values in the columns previously selected with convert to JavaLocalDate, preserving their original names and positions within the DataFrame. Preserves null values.

@JvmName(name = "toJavaLocalDateFromStringNullable")

fun <T> Convert<T, String?>.toJavaLocalDate(formatter: DateTimeFormatter? = null, locale: Locale? = null): DataFrame<T>

@JvmName(name = "toJavaLocalDateFromStringNullablePattern")

fun <T> Convert<T, String?>.toJavaLocalDate(pattern: String, locale: Locale? = null): DataFrame<T>

Converts values in the nullable String columns previously selected with convert to JavaLocalDate, preserving their original names and positions within the DataFrame. Preserves null values.

@JvmName(name = "toJavaLocalDateFromString")

fun <T> Convert<T, String>.toJavaLocalDate(formatter: DateTimeFormatter? = null, locale: Locale? = null): DataFrame<T>

@JvmName(name = "toJavaLocalDateFromStringPattern")

fun <T> Convert<T, String>.toJavaLocalDate(pattern: String, locale: Locale? = null): DataFrame<T>

Converts values in the String columns previously selected with convert to JavaLocalDate, preserving their original names and positions within the DataFrame.

toJavaLocalDateTime

fun <T> Convert<T, Any?>.toJavaLocalDateTime(): DataFrame<T>

Converts values in the columns previously selected with convert to JavaLocalDateTime, preserving their original names and positions within the DataFrame. Preserves null values.

fun <T> Convert<T, String?>.toJavaLocalDateTime(formatter: DateTimeFormatter? = null, locale: Locale? = null): DataFrame<T>

fun <T> Convert<T, String?>.toJavaLocalDateTime(pattern: String, locale: Locale? = null): DataFrame<T>

Converts values in the nullable String columns previously selected with convert to JavaLocalDateTime, preserving their original names and positions within the DataFrame. Preserves null values.

toJavaLocalTime

fun <T> Convert<T, Any?>.toJavaLocalTime(): DataFrame<T>

Converts values in the columns previously selected with convert to JavaLocalTime, preserving their original names and positions within the DataFrame. Preserves null values.

@JvmName(name = "toJavaLocalTimeFromStringNullable")

fun <T> Convert<T, String?>.toJavaLocalTime(formatter: DateTimeFormatter? = null, locale: Locale? = null): DataFrame<T>

@JvmName(name = "toJavaLocalTimeFromStringNullablePattern")

fun <T> Convert<T, String?>.toJavaLocalTime(pattern: String, locale: Locale? = null): DataFrame<T>

Converts values in the nullable String columns previously selected with convert to JavaLocalTime, preserving their original names and positions within the DataFrame. Preserves null values.

@JvmName(name = "toJavaLocalTimeFromString")

fun <T> Convert<T, String>.toJavaLocalTime(formatter: DateTimeFormatter? = null, locale: Locale? = null): DataFrame<T>

@JvmName(name = "toJavaLocalTimeFromStringPattern")

fun <T> Convert<T, String>.toJavaLocalTime(pattern: String, locale: Locale? = null): DataFrame<T>

Converts values in the String columns previously selected with convert to JavaLocalTime, preserving their original names and positions within the DataFrame.

toLocalDate

fun <T> Convert<T, *>.toLocalDate(): DataFrame<T>

Converts values in the columns previously selected with convert to LocalDate, preserving their original names and positions within the DataFrame.

@JvmName(name = "toLocalDateFromDateTimeComponents")

fun <T> Convert<T, DateTimeComponents?>.toLocalDate(): DataFrame<T>

Converts values in the DateTimeComponents columns previously selected with convert to LocalDate, preserving their original names and positions within the DataFrame. Preserves null values.

@JvmName(name = "toLocalDateFromTInt")

fun <T> Convert<T, Int?>.toLocalDate(zone: TimeZone = defaultTimeZone): DataFrame<T>

Converts values in the Int columns previously selected with convert to LocalDate, preserving their original names and positions within the DataFrame. Preserves null values.

@JvmName(name = "toLocalDateFromTLong")

fun <T> Convert<T, Long?>.toLocalDate(zone: TimeZone = defaultTimeZone): DataFrame<T>

Converts values in the Long columns previously selected with convert to LocalDate, preserving their original names and positions within the DataFrame. Preserves null values.

@FormatStringsInDatetimeFormats

fun <T> Convert<T, String?>.toLocalDate(pattern: String): DataFrame<T>

fun <T> Convert<T, String?>.toLocalDate(format: DateTimeFormat<LocalDate>? = null): DataFrame<T>

Converts values in the String columns previously selected with convert to LocalDate, preserving their original names and positions within the DataFrame. Preserves null values.

fun <T> Convert<T, String?>.~~toLocalDate~~(pattern: String? = null, locale: Locale?): DataFrame<T>

toLocalDateTime

fun <T> Convert<T, *>.toLocalDateTime(): DataFrame<T>

Converts values in the columns previously selected with convert to LocalDateTime, preserving their original names and positions within the DataFrame.

@JvmName(name = "toLocalDateTimeFromDateTimeComponents")

fun <T> Convert<T, DateTimeComponents?>.toLocalDateTime(): DataFrame<T>

Converts values in the DateTimeComponents columns previously selected with convert to LocalDateTime, preserving their original names and positions within the DataFrame. Preserves null values.

@JvmName(name = "toLocalDateTimeFromTInt")

fun <T> Convert<T, Int?>.toLocalDateTime(zone: TimeZone = defaultTimeZone): DataFrame<T>

Converts values in the Int columns previously selected with convert to LocalDateTime, preserving their original names and positions within the DataFrame. Preserves null values.

@JvmName(name = "toLocalDateTimeFromTLong")

fun <T> Convert<T, Long?>.toLocalDateTime(zone: TimeZone = defaultTimeZone): DataFrame<T>

Converts values in the Long columns previously selected with convert to LocalDateTime, preserving their original names and positions within the DataFrame. Preserves null values.

@FormatStringsInDatetimeFormats

fun <T> Convert<T, String?>.toLocalDateTime(pattern: String): DataFrame<T>

fun <T> Convert<T, String?>.toLocalDateTime(format: DateTimeFormat<LocalDateTime>? = null): DataFrame<T>

Converts values in the String columns previously selected with convert to LocalDateTime, preserving their original names and positions within the DataFrame. Preserves null values.

@JvmName(name = "toLocalDateTimeFromTStdlibInstant")

fun <T> Convert<T, Instant?>.toLocalDateTime(zone: TimeZone = defaultTimeZone): DataFrame<T>

Converts values in the kotlin.time.Instant columns previously selected with convert to LocalDateTime, preserving their original names and positions within the DataFrame. Preserves null values.

@JvmName(name = "toLocalDateTimeFromTDeprecatedInstant")

fun <T> Convert<T, Instant?>.toLocalDateTime(zone: TimeZone = defaultTimeZone): DataFrame<T>

Converts values in the kotlinx.datetime.Instant columns previously selected with convert to LocalDateTime, preserving their original names and positions within the DataFrame. Preserves null values.

fun <T> Convert<T, String?>.~~toLocalDateTime~~(pattern: String? = null, locale: Locale?): DataFrame<T>

toLocalTime

fun <T> Convert<T, *>.toLocalTime(): DataFrame<T>

Converts values in the columns previously selected with convert to LocalTime, preserving their original names and positions within the DataFrame.

@JvmName(name = "toLocalTimeFromDateTimeComponents")

fun <T> Convert<T, DateTimeComponents?>.toLocalTime(): DataFrame<T>

Converts values in the DateTimeComponents columns previously selected with convert to LocalTime, preserving their original names and positions within the DataFrame. Preserves null values.

@JvmName(name = "toLocalTimeFromTInt")

fun <T> Convert<T, Int?>.toLocalTime(zone: TimeZone = defaultTimeZone): DataFrame<T>

Converts values in the Int columns previously selected with convert to LocalTime, preserving their original names and positions within the DataFrame. Preserves null values.

@JvmName(name = "toLocalTimeFromTLong")

fun <T> Convert<T, Long?>.toLocalTime(zone: TimeZone = defaultTimeZone): DataFrame<T>

Converts values in the Long columns previously selected with convert to LocalTime, preserving their original names and positions within the DataFrame. Preserves null values.

@FormatStringsInDatetimeFormats

fun <T> Convert<T, String?>.toLocalTime(pattern: String): DataFrame<T>

fun <T> Convert<T, String?>.toLocalTime(format: DateTimeFormat<LocalTime>? = null): DataFrame<T>

Converts values in the String columns previously selected with convert to LocalTime, preserving their original names and positions within the DataFrame. Preserves null values.

fun <T> Convert<T, String?>.~~toLocalTime~~(pattern: String? = null, locale: Locale?): DataFrame<T>

toLong

fun <T> Convert<T, Any?>.toLong(): DataFrame<T>

Converts values in the columns previously selected with convert to Long, preserving their original names and positions within the DataFrame. Preserves null values.

toStdlibInstant

@JvmName(name = "toStdlibInstantFromString")

fun <T> Convert<T, String?>.toStdlibInstant(): DataFrame<T>

Converts values in the String columns previously selected with convert to kotlin.time.Instant, preserving their original names and positions within the DataFrame. Preserves null values.

@JvmName(name = "toStdlibInstantFromDeprecatedInstant")

fun <T> Convert<T, Instant?>.toStdlibInstant(): DataFrame<T>

Converts values in the kotlinx.datetime.Instant columns previously selected with convert to kotlin.time.Instant, preserving their original names and positions within the DataFrame. Preserves null values.

@JvmName(name = "toStdlibInstantFromDateTimeComponents")

fun <T> Convert<T, DateTimeComponents?>.toStdlibInstant(): DataFrame<T>

Converts values in the DateTimeComponents columns previously selected with convert to kotlin.time.Instant, preserving their original names and positions within the DataFrame. Preserves null values.

toStr

fun <T> Convert<T, Any?>.toStr(): DataFrame<T>

Converts values in the columns previously selected with convert to String, preserving their original names and positions within the DataFrame. Preserves null values.

toString

open override fun toString(): String

toUrl

fun <T> Convert<T, String?>.toUrl(): DataFrame<T>

Converts values in the String columns previously selected with convert to an URL, preserving their original names and positions within the DataFrame. Preserves null values.

toUtcOffset

fun <T> Convert<T, DateTimeComponents?>.toUtcOffset(): DataFrame<T>

Converts values in the DateTimeComponents columns previously selected with convert to UtcOffset, preserving their original names and positions within the DataFrame. Preserves null values.

toYearMonth

fun <T> Convert<T, DateTimeComponents?>.toYearMonth(): DataFrame<T>

Converts values in the DateTimeComponents columns previously selected with convert to YearMonth, preserving their original names and positions within the DataFrame. Preserves null values.

with

inline fun <T, C, reified R> Convert<T, C>.with(infer: Infer = Infer.Nulls, noinline rowConverter: RowValueExpression<T, C, R>): DataFrame<T>

Converts values in columns previously selected by convert using the specified rowConverter, a row value expression applied to each row in the DataFrame.

withRowCellImpl

@PublishedApi

internal fun <T, C, R> Convert<T, C>.withRowCellImpl(type: KType, infer: Infer, rowConverter: RowValueExpression<T, C, R>): DataFrame<T>