AddDsl

Receiver that is used by the add and mapToFrame for adding new columns and column groups based on DataFrame columns and row values.

Constructors

Link copied to clipboard
constructor(df: DataFrame<T>)

Properties

Link copied to clipboard
Link copied to clipboard
@get:JvmName(name = "NullableColumnDescription_count")
val ColumnsScope<ColumnDescription?>.count: DataColumn<Int?>
@get:JvmName(name = "ColumnDescription_count")
val ColumnsScope<ColumnDescription>.count: DataColumn<Int>
@get:JvmName(name = "NullableValueCount_count")
val ColumnsScope<ValueCount?>.count: DataColumn<Int?>
@get:JvmName(name = "ValueCount_count")
val ColumnsScope<ValueCount>.count: DataColumn<Int>
Link copied to clipboard
internal val df: DataFrame<T>
Link copied to clipboard
@get:JvmName(name = "NullableColumnDescription_freq")
val ColumnsScope<ColumnDescription?>.freq: DataColumn<Int?>
@get:JvmName(name = "ColumnDescription_freq")
val ColumnsScope<ColumnDescription>.freq: DataColumn<Int>
Link copied to clipboard
@get:JvmName(name = "NullableKeyValueProperty_key")
val ColumnsScope<KeyValueProperty<*>?>.key: DataColumn<String?>
@get:JvmName(name = "KeyValueProperty_key")
val ColumnsScope<KeyValueProperty<*>>.key: DataColumn<String>
Link copied to clipboard
@get:JvmName(name = "NullableColumnDescription_max")
val ColumnsScope<ColumnDescription?>.max: DataColumn<Any?>
@get:JvmName(name = "ColumnDescription_max")
val ColumnsScope<ColumnDescription>.max: DataColumn<Any>
Link copied to clipboard
@get:JvmName(name = "NullableColumnDescription_mean")
val ColumnsScope<ColumnDescription?>.mean: DataColumn<Double?>
@get:JvmName(name = "ColumnDescription_mean")
val ColumnsScope<ColumnDescription>.mean: DataColumn<Double>
Link copied to clipboard
@get:JvmName(name = "NullableColumnDescription_median")
val ColumnsScope<ColumnDescription?>.median: DataColumn<Any?>
@get:JvmName(name = "ColumnDescription_median")
val ColumnsScope<ColumnDescription>.median: DataColumn<Any>
Link copied to clipboard
@get:JvmName(name = "NullableColumnDescription_min")
val ColumnsScope<ColumnDescription?>.min: DataColumn<Any?>
@get:JvmName(name = "ColumnDescription_min")
val ColumnsScope<ColumnDescription>.min: DataColumn<Any>
Link copied to clipboard
@get:JvmName(name = "NameValuePairAny_name")
val ColumnsContainer<NameValuePair<*>>.name: DataColumn<String>
@get:JvmName(name = "NullableColumnDescription_name")
val ColumnsScope<ColumnDescription?>.name: DataColumn<String?>
@get:JvmName(name = "ColumnDescription_name")
val ColumnsScope<ColumnDescription>.name: DataColumn<String>
@get:JvmName(name = "NullableNameValuePair_name")
val <V> ColumnsScope<NameValuePair<V>?>.name: DataColumn<String?>
@get:JvmName(name = "NameValuePair_name")
val <V> ColumnsScope<NameValuePair<V>>.name: DataColumn<String>
@get:JvmName(name = "NullableNameValueProperty_name")
val <T> ColumnsScope<NameValueProperty<T>?>.name: DataColumn<String?>
@get:JvmName(name = "NameValueProperty_name")
val <T> ColumnsScope<NameValueProperty<T>>.name: DataColumn<String>

@get:JvmName(name = "NullableKeyValueProperty_name")
val ColumnsScope<KeyValueProperty<*>?>.name: DataColumn<String?>
@get:JvmName(name = "KeyValueProperty_name")
val ColumnsScope<KeyValueProperty<*>>.name: DataColumn<String>

Accesses the 'key' column of this KeyValueProperty ColumnsContainer.

Link copied to clipboard
internal val ColumnsContainer<*>.ncol: Int
Link copied to clipboard
@get:JvmName(name = "NullableColumnDescription_nulls")
val ColumnsScope<ColumnDescription?>.nulls: DataColumn<Int?>
@get:JvmName(name = "ColumnDescription_nulls")
val ColumnsScope<ColumnDescription>.nulls: DataColumn<Int>
Link copied to clipboard
@get:JvmName(name = "NullableColumnDescription_p25")
val ColumnsScope<ColumnDescription?>.p25: DataColumn<Any?>
@get:JvmName(name = "ColumnDescription_p25")
val ColumnsScope<ColumnDescription>.p25: DataColumn<Any>
Link copied to clipboard
@get:JvmName(name = "NullableColumnDescription_p75")
val ColumnsScope<ColumnDescription?>.p75: DataColumn<Any?>
@get:JvmName(name = "ColumnDescription_p75")
val ColumnsScope<ColumnDescription>.p75: DataColumn<Any>
Link copied to clipboard
@get:JvmName(name = "NullableColumnDescription_path")
val ColumnsScope<ColumnDescription?>.path: DataColumn<ColumnPath?>
@get:JvmName(name = "ColumnDescription_path")
val ColumnsScope<ColumnDescription>.path: DataColumn<ColumnPath>
Link copied to clipboard
@get:JvmName(name = "NullableColumnDescription_std")
val ColumnsScope<ColumnDescription?>.std: DataColumn<Double?>
@get:JvmName(name = "ColumnDescription_std")
val ColumnsScope<ColumnDescription>.std: DataColumn<Double>
Link copied to clipboard
@get:JvmName(name = "NullableColumnDescription_top")
val ColumnsScope<ColumnDescription?>.top: DataColumn<Any?>
@get:JvmName(name = "ColumnDescription_top")
val ColumnsScope<ColumnDescription>.top: DataColumn<Any>
Link copied to clipboard
@get:JvmName(name = "NullableColumnDescription_type")
val ColumnsScope<ColumnDescription?>.type: DataColumn<String?>
@get:JvmName(name = "ColumnDescription_type")
val ColumnsScope<ColumnDescription>.type: DataColumn<String>
Link copied to clipboard
@get:JvmName(name = "NullableColumnDescription_unique")
val ColumnsScope<ColumnDescription?>.unique: DataColumn<Int?>
@get:JvmName(name = "ColumnDescription_unique")
val ColumnsScope<ColumnDescription>.unique: DataColumn<Int>
Link copied to clipboard
@get:JvmName(name = "NameValuePairAny_value")
val ColumnsContainer<NameValuePair<*>>.value: DataColumn<*>
@get:JvmName(name = "NullableKeyValueProperty_value")
val <T> ColumnsScope<KeyValueProperty<T>?>.value: DataColumn<T?>
@get:JvmName(name = "KeyValueProperty_value")
val <T> ColumnsScope<KeyValueProperty<T>>.value: DataColumn<T>
@get:JvmName(name = "NullableNameValuePair_value")
val <V> ColumnsScope<NameValuePair<V>?>.value: DataColumn<V?>
@get:JvmName(name = "NameValuePair_value")
val <V> ColumnsScope<NameValuePair<V>>.value: DataColumn<V>
@get:JvmName(name = "NullableNameValueProperty_value")
val <T> ColumnsScope<NameValueProperty<T>?>.value: DataColumn<T?>
@get:JvmName(name = "NameValueProperty_value")
val <T> ColumnsScope<NameValueProperty<T>>.value: DataColumn<T>
@get:JvmName(name = "NullableValueProperty_value")
val <T> ColumnsScope<ValueProperty<T>?>.value: DataColumn<T?>
@get:JvmName(name = "ValueProperty_value")
val <T> ColumnsScope<ValueProperty<T>>.value: DataColumn<T>

Functions

Link copied to clipboard
fun add(column: ColumnReference<*>): Boolean
internal inline fun <reified R> add(name: String, infer: Infer = Infer.Nulls, noinline expression: AddExpression<T, R>): Boolean
Link copied to clipboard
open override fun columns(): List<DataColumn<*>>
Link copied to clipboard
open override fun columnsCount(): Int
Link copied to clipboard
operator fun ColumnsContainer<*>.contains(column: KProperty<*>): Boolean
operator fun ColumnsContainer<*>.contains(column: ColumnReference<*>): Boolean
Link copied to clipboard
open override fun containsColumn(name: String): Boolean
open override fun containsColumn(path: ColumnPath): Boolean
Link copied to clipboard
Link copied to clipboard
inline fun <reified R> expr(infer: Infer = Infer.Nulls, noinline expression: AddExpression<T, R>): DataColumn<R>
Link copied to clipboard
infix inline fun <reified R> String.from(noinline expression: AddExpression<T, R>): Boolean
infix fun String.from(column: ColumnReference<*>): Boolean
infix inline fun <reified R> KProperty<R>.from(noinline expression: AddExpression<T, R>): Boolean
infix inline fun <reified R> KProperty<R>.from(column: ColumnReference<R>): Boolean
infix inline fun <reified R> ColumnAccessor<R>.from(noinline expression: AddExpression<T, R>): Boolean
infix inline fun <reified R> ColumnAccessor<R>.from(column: ColumnReference<R>): Boolean
infix fun ColumnAccessor<DataRow<*>>.from(body: AddDsl<T>.() -> Unit)
Link copied to clipboard
open override fun <C> get(columns: ColumnsSelector<T, C>): List<DataColumn<C>>
open override fun <C> get(column: ColumnSelector<T, C>): DataColumn<C>
open operator override fun get(columnName: String): DataColumn<*>
open operator override fun <R> get(column: KProperty<R>): DataColumn<R>
open operator override fun <R> get(column: KProperty<DataFrame<R>>): FrameColumn<R>
open operator override fun <R> get(column: KProperty<DataRow<R>>): ColumnGroup<R>
open operator override fun <R> get(column: DataColumn<R>): DataColumn<R>
open operator override fun <R> get(column: DataColumn<DataFrame<R>>): FrameColumn<R>
open operator override fun <R> get(column: DataColumn<DataRow<R>>): ColumnGroup<R>
open operator override fun get(columnPath: ColumnPath): DataColumn<*>
open operator override fun <R> get(column: ColumnReference<R>): DataColumn<R>
open operator override fun <R> get(column: ColumnReference<DataFrame<R>>): FrameColumn<R>
open operator override fun <R> get(column: ColumnReference<DataRow<R>>): ColumnGroup<R>

open operator fun String.get(column: String): ColumnPath

Creates a ColumnPath from the receiver and the given column name column. This is a shorthand for pathOf("myColumnName", "myNestedColumnName") and is often used in combination with ColumnPath.invoke to retrieve the value of a nested column. For instance:

open operator fun <T, R> KProperty<T>.get(column: KProperty<R>): DataColumn<R>
open operator fun <T, R> KProperty<T>.get(column: KProperty<DataFrame<R>>): FrameColumn<R>
open operator fun <T, R> KProperty<T>.get(column: KProperty<DataRow<R>>): ColumnGroup<R>
@JvmName(name = "KPropertyDataRowGet")
open operator fun <T, R> KProperty<DataRow<T>>.get(column: KProperty<R>): DataColumn<R>
@JvmName(name = "KPropertyDataRowGet")
open operator fun <T, R> KProperty<DataRow<T>>.get(column: KProperty<DataFrame<R>>): FrameColumn<R>
@JvmName(name = "KPropertyDataRowGet")
open operator fun <T, R> KProperty<DataRow<T>>.get(column: KProperty<DataRow<R>>): ColumnGroup<R>

Retrieves the value of this KProperty Accessor from the DataFrame.

open operator fun ColumnPath.get(column: String): ColumnPath

As extension to "myColumn"["myNestedColumn"], this function enables "myColumn"["myNestedColumn"]["myDoublyNestedColumn"] as alternative to pathOf("myColumn", "myNestedColumn", "myDoublyNestedColumn")

Link copied to clipboard
open override fun getColumnIndex(name: String): Int
Link copied to clipboard
open override fun <R> getColumnOrNull(column: ColumnSelector<T, R>): DataColumn<R>?
open override fun getColumnOrNull(index: Int): DataColumn<*>?
open override fun getColumnOrNull(name: String): DataColumn<*>?
open override fun <R> getColumnOrNull(column: KProperty<R>): DataColumn<R>?
open override fun getColumnOrNull(path: ColumnPath): DataColumn<*>?
open override fun <R> getColumnOrNull(column: ColumnReference<R>): DataColumn<R>?
Link copied to clipboard
Link copied to clipboard
fun group(body: AddDsl<T>.() -> Unit): AddGroup<T>
fun group(name: String, body: AddDsl<T>.() -> Unit)
fun group(column: ColumnAccessor<DataRow<*>>, body: AddDsl<T>.() -> Unit)
Link copied to clipboard
infix fun AddGroup<T>.into(groupName: String)
infix fun AddGroup<T>.into(column: ColumnAccessor<DataRow<*>>)
infix fun ColumnReference<*>.into(name: String): Boolean
infix fun <R> ColumnReference<R>.into(column: KProperty<R>): Boolean
infix fun <R> ColumnReference<R>.into(column: ColumnAccessor<R>): Boolean
Link copied to clipboard
operator fun String.invoke(body: AddDsl<T>.() -> Unit)

@JvmName(name = "stringInvokeTyped")
open operator fun <C> String.invoke(): DataColumn<C>

Retrieves the value of the column with this name from the DataFrame. This can be both typed and untyped. This is a shorthand for get("myColumnName") and can be written as "myColumnName"<MyColumnType>() instead.

@JvmName(name = "stringInvokeUntyped")
open operator fun String.invoke(): DataColumn<*>

Retrieves the value of the column with this name from the DataFrame. This can be both typed and untyped. This is a shorthand for get("myColumnName") and can be written as "myColumnName"() instead.

open operator fun <T> KProperty<T>.invoke(): DataColumn<T>
open operator fun <T> KProperty<DataFrame<T>>.invoke(): FrameColumn<T>
open operator fun <T> KProperty<DataRow<T>>.invoke(): ColumnGroup<T>

Retrieves the value of this KProperty Accessor from the DataFrame.

open operator fun <C> ColumnPath.invoke(): DataColumn<C>

Retrieves the value of this ColumnPath from the DataFrame. This is a shorthand for getColumn(myColumnPath) and is most often used in combination with operator fun String.get(column: String), for instance:

open operator fun <C> ColumnReference<C>.invoke(): DataColumn<C>
open operator fun <T> ColumnReference<DataFrame<T>>.invoke(): FrameColumn<T>
open operator fun <T> ColumnReference<DataRow<T>>.invoke(): ColumnGroup<T>

Retrieves the value of this ColumnReference or -Accessor from the DataFrame.

Link copied to clipboard
inline fun <T, reified R> ColumnsContainer<T>.mapToColumn(name: String, infer: Infer = Infer.Nulls, noinline body: AddExpression<T, R>): DataColumn<R>

Returns a new DataColumn with the given name and the values that body computes from the rows of this ColumnsContainer.

inline fun <T, reified R> ColumnsContainer<T>.mapToColumn(column: KProperty<R>, infer: Infer = Infer.Nulls, noinline body: AddExpression<T, R>): DataColumn<R>
inline fun <T, reified R> ColumnsContainer<T>.mapToColumn(column: ColumnReference<R>, infer: Infer = Infer.Nulls, noinline body: AddExpression<T, R>): DataColumn<R>
internal fun <T, R> ColumnsContainer<T>.mapToColumn(name: String, type: KType, infer: Infer = Infer.Nulls, body: AddExpression<T, R>): DataColumn<R>
fun <T, R> ColumnsContainer<T>.mapToColumn(column: KProperty<R>, type: KType, infer: Infer = Infer.Nulls, body: AddExpression<T, R>): DataColumn<R>
fun <T, R> ColumnsContainer<T>.mapToColumn(column: ColumnReference<R>, type: KType, infer: Infer = Infer.Nulls, body: AddExpression<T, R>): DataColumn<R>
Link copied to clipboard
internal fun <T, R> ColumnsContainer<T>.newColumn(type: KType, name: String = "", infer: Infer = Infer.Nulls, expression: AddExpression<T, R>): DataColumn<R>
Link copied to clipboard
Link copied to clipboard
operator fun String.unaryPlus(): Boolean
operator fun ColumnReference<*>.unaryPlus(): Boolean