col

@JvmName(name = "colUnTyped")
open fun col(name: String): ColumnAccessor<*>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ col("columnName") }

df.select{ col<String>("columnName") }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the column.

See also

Throws

if the column with the given argument does not exist.


open fun <C> col(name: String): ColumnAccessor<C>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ col("columnName") }

df.select{ col<String>("columnName") }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.


@JvmName(name = "colUnTyped")
open fun SingleColumn<DataRow<*>>.col(name: String): SingleColumn<*>
@JvmName(name = "colUnTyped")
open fun ColumnAccessor<DataRow<*>>.col(name: String): ColumnAccessor<*>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ myColumnGroup.col("columnName") }

df.select{ myColumnGroup.col<String>("columnName") }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the column.

See also

Throws

if the column with the given argument does not exist.


open fun <C> SingleColumn<DataRow<*>>.col(name: String): SingleColumn<C>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ myColumnGroup.col("columnName") }

df.select{ myColumnGroup.col<String>("columnName") }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.


@JvmName(name = "colUnTyped")
open fun String.col(name: String): ColumnAccessor<*>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ "myColumnGroup".col("columnName") }

df.select{ "myColumnGroup".col<String>("columnName") }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the column.

See also

Throws

if the column with the given argument does not exist.


open fun <C> String.col(name: String): ColumnAccessor<C>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ "myColumnGroup".col("columnName") }

df.select{ "myColumnGroup".col<String>("columnName") }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.


@JvmName(name = "colUnTyped")
open fun ColumnPath.col(name: String): ColumnAccessor<*>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].col("columnName") }

df.select{ "pathTo"["myColumnGroup"].col<String>("columnName") }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the column.

See also

Throws

if the column with the given argument does not exist.


open fun <C> ColumnPath.col(name: String): ColumnAccessor<C>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].col("columnName") }

df.select{ "pathTo"["myColumnGroup"].col<String>("columnName") }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.


@JvmName(name = "colUnTyped")
open fun col(path: ColumnPath): ColumnAccessor<*>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ col("pathTo"["columnName"] ) }

df.select{ col<String>("pathTo"["columnName"] ) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the column.

See also

Throws

if the column with the given argument does not exist.


open fun <C> col(path: ColumnPath): ColumnAccessor<C>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ col("pathTo"["columnName"] ) }

df.select{ col<String>("pathTo"["columnName"] ) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.


@JvmName(name = "colUnTyped")
open fun SingleColumn<DataRow<*>>.col(path: ColumnPath): SingleColumn<*>
@JvmName(name = "colUnTyped")
open fun ColumnAccessor<DataRow<*>>.col(path: ColumnPath): ColumnAccessor<*>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ myColumnGroup.col("pathTo"["columnName"] ) }

df.select{ myColumnGroup.col<String>("pathTo"["columnName"] ) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the column.

See also

Throws

if the column with the given argument does not exist.


Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ myColumnGroup.col("pathTo"["columnName"] ) }

df.select{ myColumnGroup.col<String>("pathTo"["columnName"] ) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.


@JvmName(name = "colUnTyped")
open fun String.col(path: ColumnPath): ColumnAccessor<*>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ "myColumnGroup".col("pathTo"["columnName"] ) }

df.select{ "myColumnGroup".col<String>("pathTo"["columnName"] ) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the column.

See also

Throws

if the column with the given argument does not exist.


open fun <C> String.col(path: ColumnPath): ColumnAccessor<C>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ "myColumnGroup".col("pathTo"["columnName"] ) }

df.select{ "myColumnGroup".col<String>("pathTo"["columnName"] ) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.


@JvmName(name = "colUnTyped")
open fun ColumnPath.col(path: ColumnPath): ColumnAccessor<*>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].col("pathTo"["columnName"] ) }

df.select{ "pathTo"["myColumnGroup"].col<String>("pathTo"["columnName"] ) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the column.

See also

Throws

if the column with the given argument does not exist.


Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].col("pathTo"["columnName"] ) }

df.select{ "pathTo"["myColumnGroup"].col<String>("pathTo"["columnName"] ) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.


open fun <C> ColumnSet<C>.col(index: Int): SingleColumn<C>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

NOTE: You can use the get- operator on ColumnSets as well!

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ colsOf<Int>().col(0) }

df.select{ colsOf<String>()[1]}

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.

if the index is out of bounds.


@JvmName(name = "colUnTyped")
open fun ColumnsSelectionDsl<*>.col(index: Int): SingleColumn<*>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ col(0) }

df.select{ col<String>(0) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the column.

See also

Throws

if the column with the given argument does not exist.

if the index is out of bounds.


open fun <C> ColumnsSelectionDsl<*>.col(index: Int): SingleColumn<C>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ col(0) }

df.select{ col<String>(0) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.

if the index is out of bounds.


@JvmName(name = "colUnTyped")
open fun SingleColumn<DataRow<*>>.col(index: Int): SingleColumn<*>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ myColumnGroup.col(0) }

df.select{ myColumnGroup.col<String>(0) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the column.

See also

Throws

if the column with the given argument does not exist.

if the index is out of bounds.


open fun <C> SingleColumn<DataRow<*>>.col(index: Int): SingleColumn<C>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ myColumnGroup.col(0) }

df.select{ myColumnGroup.col<String>(0) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.

if the index is out of bounds.


@JvmName(name = "colUnTyped")
open fun String.col(index: Int): SingleColumn<*>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ "myColumnGroup".col(0) }

df.select{ "myColumnGroup".col<String>(0) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the column.

See also

Throws

if the column with the given argument does not exist.

if the index is out of bounds.


open fun <C> String.col(index: Int): SingleColumn<C>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ "myColumnGroup".col(0) }

df.select{ "myColumnGroup".col<String>(0) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.

if the index is out of bounds.


@JvmName(name = "colUnTyped")
open fun ColumnPath.col(index: Int): SingleColumn<*>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].col(0) }

df.select{ "pathTo"["myColumnGroup"].col<String>(0) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the column.

See also

Throws

if the column with the given argument does not exist.

if the index is out of bounds.


open fun <C> ColumnPath.col(index: Int): SingleColumn<C>

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].col(0) }

df.select{ "pathTo"["myColumnGroup"].col<String>(0) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.

if the index is out of bounds.


open fun <C> col(col: ColumnAccessor<C>): ColumnAccessor<C>

Deprecated

This overload is an identity function and can be omitted.

Replace with

col

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

NOTE: This overload is an identity function and can be omitted.

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ col(columnA) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

col

The ColumnAccessor pointing to the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.


Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ myColumnGroup.col(columnA) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

col

The ColumnAccessor pointing to the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.


Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ "myColumnGroup".col(columnA) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

col

The ColumnAccessor pointing to the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.


open fun <C> KProperty<*>.col(col: ColumnAccessor<C>): ColumnAccessor<C>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.col(columnA) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

col

The ColumnAccessor pointing to the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.


Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].col(columnA) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

col

The ColumnAccessor pointing to the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.


@JvmName(name = "colUnTyped")
open fun KProperty<*>.col(name: String): ColumnAccessor<*>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.col("columnName") }

df.select{ Type::myColumnGroup.col<String>("columnName") }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the column.

See also

Throws

if the column with the given argument does not exist.


open fun <C> KProperty<*>.col(name: String): ColumnAccessor<C>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.col("columnName") }

df.select{ Type::myColumnGroup.col<String>("columnName") }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

name

The name of the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.


@JvmName(name = "colUnTyped")
open fun KProperty<*>.col(path: ColumnPath): ColumnAccessor<*>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.col("pathTo"["columnName"] ) }

df.select{ Type::myColumnGroup.col<String>("pathTo"["columnName"] ) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the column.

See also

Throws

if the column with the given argument does not exist.


open fun <C> KProperty<*>.col(path: ColumnPath): ColumnAccessor<C>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.col("pathTo"["columnName"] ) }

df.select{ Type::myColumnGroup.col<String>("pathTo"["columnName"] ) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

path

The path to the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.


open fun <C> col(property: KProperty<C>): SingleColumn<C>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ col(Type::columnA) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

property

The KProperty reference to the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.


open fun <C> SingleColumn<DataRow<*>>.col(property: KProperty<C>): SingleColumn<C>
open fun <C> ColumnAccessor<DataRow<*>>.col(property: KProperty<C>): ColumnAccessor<C>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ myColumnGroup.col(Type::columnA) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

property

The KProperty reference to the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.


open fun <C> String.col(property: KProperty<C>): ColumnAccessor<C>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ "myColumnGroup".col(Type::columnA) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

property

The KProperty reference to the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.


open fun <C> KProperty<*>.col(property: KProperty<C>): ColumnAccessor<C>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.col(Type::columnA) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

property

The KProperty reference to the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.


open fun <C> ColumnPath.col(property: KProperty<C>): ColumnAccessor<C>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ "pathTo"["myColumnGroup"].col(Type::columnA) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

property

The KProperty reference to the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.


@JvmName(name = "colUnTyped")
open fun KProperty<*>.col(index: Int): SingleColumn<*>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.col(0) }

df.select{ Type::myColumnGroup.col<String>(0) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the column.

See also

Throws

if the column with the given argument does not exist.

if the index is out of bounds.


open fun <C> KProperty<*>.col(index: Int): SingleColumn<C>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Col

Creates a ColumnAccessor (or SingleColumn) for a column with the given argument which can be either an index (Int) or a reference to a column (String, ColumnPath, KProperty, or ColumnAccessor; any Access APIs).

This is a DSL-shorthand for column and can be both typed and untyped (in case you're supplying a column name, -path, or index). The function can also be called on ColumnGroups to create an accessor for a column inside a ColumnGroup.

    

For more information: See col on the documentation website.

Check out: Grammar

For example:

df.select{ col<String>("colA") }

df.select{ col(SomeType::colB) }

df.select{ myColumnGroup.col(1) }

Examples for this overload:

df.select{ Type::myColumnGroup.col(0) }

df.select{ Type::myColumnGroup.col<String>(0) }

To create a ColumnAccessor for a specific kind of column with runtime checks, take a look at the functions valueCol, colGroup, and frameCol.

Return

A ColumnAccessor for the column with the given argument if possible, else a SingleColumn.

Parameters

index

The index of the column.

Type Parameters

C

The type of the column.

See also

Throws

if the column with the given argument does not exist.

if the index is out of bounds.