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

convertToLocalDate

@JvmName(name = "convertToLocalDateFromT")

fun <T : Any> DataColumn<T>.convertToLocalDate(): DataColumn<LocalDate>

Converts values in this column to LocalDate.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDate values.

fun <T : Any> DataColumn<T?>.convertToLocalDate(): DataColumn<LocalDate?>

Converts values in this column to LocalDate. Preserves null values.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDate nullable values.

@JvmName(name = "convertToLocalDateFromLong")

fun DataColumn<Long>.convertToLocalDate(zone: TimeZone = defaultTimeZone): DataColumn<LocalDate>

Converts values in this Long column to LocalDate.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDate values.

Parameters

zone

The TimeZone used to interpret the Long timestamp as a date. Defaults to the system current time zone.

fun DataColumn<Long?>.convertToLocalDate(zone: TimeZone = defaultTimeZone): DataColumn<LocalDate?>

Converts values in this Long column to LocalDate. Preserves null values.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDate nullable values.

Parameters

zone

The TimeZone used to interpret the Long timestamp as a date. Defaults to the system current time zone.

@JvmName(name = "convertToLocalDateFromInt")

fun DataColumn<Int>.convertToLocalDate(zone: TimeZone = defaultTimeZone): DataColumn<LocalDate>

Converts values in this Int column to LocalDate.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDate values.

Parameters

zone

The TimeZone used to interpret the Int timestamp as a date. Defaults to the system current time zone.

@JvmName(name = "convertToLocalDateFromIntNullable")

fun DataColumn<Int?>.convertToLocalDate(zone: TimeZone = defaultTimeZone): DataColumn<LocalDate?>

Converts values in this Int column to LocalDate. Preserves null values.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDate nullable values.

Parameters

zone

The TimeZone used to interpret the Int timestamp as a date. Defaults to the system current time zone.

@JvmName(name = "convertToLocalDateFromString")

fun DataColumn<String>.convertToLocalDate(format: DateTimeFormat<LocalDate>? = null): DataColumn<LocalDate>

Converts values in this String column to LocalDate.

Trims each string and attempts to parse it using the specified format. Fails with an exception if a value cannot be parsed.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDate values.

Parameters

format

An optional DateTimeFormat to use when parsing. If null, the defaults will be used.

@JvmName(name = "convertToLocalDateFromStringPattern")

@FormatStringsInDatetimeFormats

fun DataColumn<String>.convertToLocalDate(pattern: String): DataColumn<LocalDate>

Converts values in this String column to LocalDate.

Trims each string and attempts to parse it using the specified pattern. Fails with an exception if a value cannot be parsed.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDate values.

Parameters

pattern

An optional date pattern to use for parsing.

@JvmName(name = "convertToLocalDateFromStringNullable")

fun DataColumn<String?>.convertToLocalDate(format: DateTimeFormat<LocalDate>? = null): DataColumn<LocalDate?>

Converts values in this String column to LocalDate. Preserves null values.

Trims each string and attempts to parse it using the specified format. Fails with an exception if a value cannot be parsed.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDate nullable values.

Parameters

format

An optional DateTimeFormat to use when parsing. If null, the defaults will be used.

@JvmName(name = "convertToLocalDateFromStringNullablePattern")

@FormatStringsInDatetimeFormats

fun DataColumn<String?>.convertToLocalDate(pattern: String): DataColumn<LocalDate?>

Converts values in this String column to LocalDate. Preserves null values.

Trims each string and attempts to parse it using the specified pattern. Fails with an exception if a value cannot be parsed.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDate nullable values.

Parameters

pattern

An optional date pattern to use for parsing. If null, a default parser is used.

@JvmName(name = "convertToLocalDateFromDateTimeComponents")

fun DataColumn<DateTimeComponents>.convertToLocalDate(): DataColumn<LocalDate>

Converts values in this DateTimeComponents column to LocalDate.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDate values.

@JvmName(name = "convertToLocalDateFromDateTimeComponentsNullable")

fun DataColumn<DateTimeComponents?>.convertToLocalDate(): DataColumn<LocalDate?>

Converts values in this DateTimeComponents column to LocalDate. Preserves null values.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDate nullable values.

@JvmName(name = "convertToLocalDateFromString")

fun DataColumn<String>.~~convertToLocalDate~~(pattern: String? = null, locale: Locale? = null): DataColumn<LocalDate>

@JvmName(name = "convertToLocalDateFromStringNullable")

fun DataColumn<String?>.~~convertToLocalDate~~(pattern: String? = null, locale: Locale? = null): DataColumn<LocalDate?>

Deprecated (with error)

We no longer accept `Locale` in String -> Kotlin date-time conversion functions, as we now directly parse to Kotlin. If you need to specify a locale to make it work, convert to Java-based types first. Will be ERROR in 1.0.

Replace with

this.convertToJavaLocalDate(pattern, locale).convertToLocalDate()