KSLCore/ksl.utilities.io.dbutil/ModelElementTableData

ModelElementTableData

data class ModelElementTableData( var exp_id_fk: Int = -1, var element_id: Int = -1, var element_name: String = "", var class_name: String = "", var parent_id_fk: Int? = null, var parent_name: String? = null, var left_count: Int = -1, var right_count: Int = -1) : DbTableData

Constructors

constructor( exp_id_fk: Int = -1, element_id: Int = -1, element_name: String = "", class_name: String = "", parent_id_fk: Int? = null, parent_name: String? = null, left_count: Int = -1, right_count: Int = -1)

Properties

autoIncField

val autoIncField: Boolean = false

class_name

var class_name: String

element_id

var element_id: Int

element_name

var element_name: String

exp_id_fk

var exp_id_fk: Int

keyFields

val keyFields: List<String>

left_count

var left_count: Int

numColumns

val numColumns: Int

The number of columns of data. The number of public mutable properties including any auto-increment field

numInsertFields

val numInsertFields: Int

The number of fields to insert. If there is an auto-increment field then it is not included.

numUpdateFields

val numUpdateFields: Int

The number of fields to update. This does not include the fields within the primary key

parent_id_fk

var parent_id_fk: Int?

parent_name

var parent_name: String?

right_count

var right_count: Int

schemaName

var schemaName: String?

The optional name of the schema holding the table for the related data. If supplied it cannot be empty/blank and any white space will be replaced with underscore characters.

tableName

var tableName: String

White space in the string is replaced by an underscore

Functions

createTableSQLStatement

fun createTableSQLStatement(): String

Creates a string representation of a CREATE TABLE SQL statement that could create a table that would hold the data associated with the DbTableData. The resulting string maps the property KTypes to suitable SQL types via DbTableData.toSQLTypeString. If there is a primary key specification, it is captured in the CREATE TABLE statement. Any NOT NULL specifications are also captured. There will not be any foreign key specifications because DbTableData does not specify them. Also, since there is no SQL standard for an auto-increment primary key, the autoIncField specification is ignored. The purpose here is to get a quick and dirty table representation. If additional specifications are required the user could formulate ALTER TABLE statements or better yet use one of the many libraries available for more advanced SQL work. If schemaName is supplied, then the CREATE TABLE statement begins with "CREATE TABLE schemaName.tableName ". If the schema name is not specified, the statement begins with "CREATE TABLE tableName "

extractAllPropertyValuesByName

fun extractAllPropertyValuesByName(): Map<String, Any?>

Extracts the value of the public mutable properties of a data class If the object is not an instance of a data class, then the returned map will be empty. The map contains the pairs of (name, value) where name is the name of the public, mutable property and value is the current value of the property

extractColumnDataTypes

fun extractColumnDataTypes(): Map<String, DataType>

Extracts the property of the public mutable properties of a data class Classifies each property whether it can be converted to a numeric value via isNumericConvertable(). All non-numeric mutable properties are considered TEXT; otherwise, they are considered NUMERIC.

extractKeyPropertyValuesByName

fun extractKeyPropertyValuesByName(): Map<String, Any?>

The map will contain the fields and their values that are designated as part of the primary key

extractKeyValues

fun extractKeyValues(): List<Any?>

Extracts the current value of the fields that are designated as part of the primary key in the order in which the properties are listed within the class definition

extractMutableProperties

fun extractMutableProperties(): Map<String, KProperty1<out Any, *>>

Extracts the property of the public mutable properties of a data class If the object is not an instance of a data class, then the returned map will be empty. The map contains the pairs of (name, property) where name is the name of the public property and property is the reflection property

extractNonAutoIncPropertyValuesByName

fun extractNonAutoIncPropertyValuesByName(): Map<String, Any?>

The map will contain all the fields by name with their values without an auto-increment field if it exists

extractNonKeyPropertyValuesByName

fun extractNonKeyPropertyValuesByName(): Map<String, Any?>

The map will contain the fields and their values that are not designated as part of the primary key

extractPropertyNames

fun extractPropertyNames(): List<String>

Extracts the names of the public, mutable properties of a data class in the order in which they are declared in the primary constructor.

extractPropertyValues

fun extractPropertyValues(autoInc: Boolean = false): List<Any?>

Extracts the value of the public, mutable properties of a data class in the order in which they are declared in the primary constructor.

fun extractPropertyValues(): List<Any?>

Extracts the values of the public, mutable properties of a data class in the order in which they are declared in the primary constructor.

extractUpdatableFieldNames

fun extractUpdatableFieldNames(): List<String>

Extracts the names of the fields that can be updated or inserted by accounting for an auto-increment key field

extractUpdateValues

fun extractUpdateValues(): List<Any?>

Extracts the value of the public, mutable properties of a data class in the order in which they are declared in the primary constructor not including the fields designated as being within the primary key. We assume that the values returned correspond to data that must be used to update a record within the database table. Thus, we assume that the user will not update the values of the fields within the primary key. The returned values are in the order of the properties listed in the DbTableData class, not including the primary key fields.

hasAutoIncrementField

fun hasAutoIncrementField(): Boolean

Checks if an autoIncField exists

insertDataSQLStatement

fun insertDataSQLStatement(): String

Returns a string representation of a table insert statement. See DatabaseIfc.insertIntoTableStatementSQL

setAutoIncField

fun setAutoIncField(value: Any?)

Sets the value of the auto-increment field based on the supplied value

setPropertyValues

fun setPropertyValues(values: List<Any?>)

Sets the values of the public mutable properties of a data class to the values supplied. If the object is not an instance of a data class then nothing happens. The size of the supplied list must be the same as the number of the mutable properties and the type of each element in the supplied list must match the type of the mutable property

fun setPropertyValues(row: RowGetterIfc)

Sets the values of the public mutable properties of a data class to the values supplied. If the object is not an instance of a data class then nothing happens. The row from a TabularFile must map to the property values

updateDataSQLStatement

fun updateDataSQLStatement(): String

Returns a string representation of a table update statement. See DatabaseIfc.updateTableStatementSQL