core/org.jetbrains.kotlinx.dataframe.schema/ColumnSchema/Frame

Frame

class Frame(val schema: DataFrameSchema, val nullable: Boolean, val contentType: KType?) : ColumnSchema

The schema of a frame column.

Constructors

Frame

constructor(schema: DataFrameSchema, nullable: Boolean, contentType: KType?)

Properties

contentType

open override val contentType: KType?

The type associated with the contents of the column. For Value this is irrelevant and thus null. Use type instead. For Group this is the common base type associated with all the DataRows in the column. For Frame this is the common base type associated with all the DataFrames in the column.

kind

open override val kind: ColumnKind

Either Value or Group or Frame.

nullable

open override val nullable: Boolean

Whether the column is nullable. Is always false for Group.

schema

val schema: DataFrameSchema

The DataFrameSchema of the dataframes held by the column.

type

open override val type: KType

The type of the column. For Value this is the common base type associated with all the values in the column. For Group this is AnyRow. For Frame this is AnyFrame.

Functions

compare

fun compare(other: ColumnSchema, comparisonMode: ComparisonMode = LENIENT): CompareResult

Compares this column schema with the other column schema.

fun compare(other: ColumnSchema.Frame, comparisonMode: ComparisonMode = LENIENT): CompareResult

createEmptyColumn

internal fun ColumnSchema.createEmptyColumn(name: String): AnyCol

Create "empty" column based on the toplevel of this ColumnSchema.

createNullFilledColumn

internal fun ColumnSchema.createNullFilledColumn(name: String, numberOfRows: Int): AnyCol

Creates a column based on this ColumnSchema filled with null or empty dataframes.

equals

open operator override fun equals(other: Any?): Boolean

Checks equality by kind, type, or schema

hashCode

open override fun hashCode(): Int