core/org.jetbrains.kotlinx.dataframe.columns

Package-level declarations

Types

interface BaseColumn<out T> : ColumnReference<T>

Column with type, name/path and values Base interface for all three kinds of columns: ValueColumn, ColumnGroup and FrameColumn. Column operations that doesn't clash by signature with DataFrame operations can be defined for BaseColumn

internal enum class CellKind : Enum<CellKind>

Represents special kinds of elements that can be found within a Column. This is similar to the ColumnKind, but it applies to specific elements of the Column. Its main use is to provide metadata during serialization for visualization within the KTNB plugin.

interface ColumnAccessor<out T> : ColumnReference<T>

Combination of column path and column type.

interface ColumnGroup<out T> : BaseColumn<DataRow<T>> , DataFrame<T>

Group of columns. Used to create column hierarchy in DataFrame.

enum class ColumnKind : Enum<ColumnKind>

data class ColumnPath(val path: List<String>) : List<String> , ColumnAccessor<Any?>

Path to a column in DataFrame.

ColumnReference

interface ColumnReference<out C> : SingleColumn<C>

Entity that can retrieve DataColumn from DataFrame or value from DataRow.

ColumnResolutionContext

class ColumnResolutionContext(val df: DataFrame<*>, val unresolvedColumnsPolicy: UnresolvedColumnsPolicy)

interface ColumnSet<out C> : ColumnsResolver<C>

Entity that can be resolved into a list of columns. Just like SingleColumn, this is a ColumnsResolver.

ColumnsResolver

sealed interface ColumnsResolver<out C>

Entity that can be resolved into a list of columns.

interface ColumnWithPath<out T> : DataColumn<T>

interface FrameColumn<out T> : DataColumn<DataFrame<T>>

Column that stores values of type DataFrame

interface SingleColumn<out C> : ColumnsResolver<C>

Entity that can be resolved into a single DataColumn.

sealed interface TypeSuggestion

The suggestion of how to find a column type.

UnresolvedColumnsPolicy

enum class UnresolvedColumnsPolicy : Enum<UnresolvedColumnsPolicy>

interface ValueColumn<out T> : DataColumn<T>

Column that stores values.

Properties

val <T> ColumnWithPath<T>.depth: Int

internal val AnyBaseCol.isEmpty: Boolean

internal val AnyBaseCol.size: Int

internal val <T> BaseColumn<T>.values: Iterable<T>

Functions

internal fun <C> ColumnsSelectionDsl<C>.asColumnSet(): ColumnSet<DataRow<C>>

internal fun <C> ColumnsResolver<C>.asColumnSet(): ColumnSet<C>

internal fun <C> SingleColumn<C>.asColumnSet(): ColumnSet<C>

fun ColumnWithPath(column: DataColumn<*>, path: ColumnPath): ColumnWithPath<*>

dropOverlappingStartOfChild

internal fun <T> dropOverlappingStartOfChild(parent: List<T>, child: List<T>): List<T>

internal fun ColumnPath.dropStartWrt(otherPath: ColumnPath): ColumnPath

Drops the overlapping start of the child path with respect to the parent path, and returns the resulting ColumnPath.

renamedReference

internal fun <C> ColumnReference<C>.renamedReference(newName: String): ColumnReference<C>

internal fun <C> ColumnReference<C>.resolveFor(df: AnyFrame): ColumnWithPath<C>?

internal fun ColumnReference<*>.shortPath(): ColumnPath

@JvmName(name = "toColumnSetString")

fun Array<out String>.toColumnSet(): ColumnSet<Any?>

fun <C> Array<out KProperty<C>>.toColumnSet(): ColumnSet<C>

@JvmName(name = "toColumnSetColumnPath")

fun Array<out ColumnPath>.toColumnSet(): ColumnSet<Any?>

fun <C> Array<out ColumnReference<C>>.toColumnSet(): ColumnSet<C>

fun Array<out ColumnsResolver<*>>.toColumnSet(): ColumnSet<Any?>

@JvmName(name = "toColumnSetC")

fun <C> Array<out ColumnsResolver<C>>.toColumnSet(): ColumnSet<C>

@JvmName(name = "toColumnSetString")

fun Iterable<String>.toColumnSet(): ColumnSet<Any?>

@JvmName(name = "toColumnSetKProperty")

fun <C> Iterable<KProperty<C>>.toColumnSet(): ColumnSet<C>

@JvmName(name = "toColumnSetColumnPath")

fun Iterable<ColumnPath>.toColumnSet(): ColumnSet<Any?>

@JvmName(name = "toColumnSetColumnReference")

fun <C> Iterable<ColumnReference<C>>.toColumnSet(): ColumnSet<C>

fun Iterable<ColumnsResolver<*>>.toColumnSet(): ColumnSet<Any?>

@JvmName(name = "toColumnSetC")

fun <C> Iterable<ColumnsResolver<C>>.toColumnSet(): ColumnSet<C>

fun <C> Array<out String>.toColumnsSetOf(): ColumnSet<C>

fun <C> Iterable<String>.toColumnsSetOf(): ColumnSet<C>