KSLCore/ksl.utilities.io.dbutil

Package-level declarations

Types

data class AcrossRepStatTableData(var id: Int = -1, var element_id_fk: Int = -1, var sim_run_id_fk: Int = -1, var stat_name: String = "", var stat_count: Double? = null, var average: Double? = null, var std_dev: Double? = null, var std_err: Double? = null, var half_width: Double? = null, var conf_level: Double? = null, var minimum: Double? = null, var maximum: Double? = null, var sum_of_obs: Double? = null, var dev_ssq: Double? = null, var last_value: Double? = null, var kurtosis: Double? = null, var skewness: Double? = null, var lag1_cov: Double? = null, var lag1_corr: Double? = null, var von_neumann_lag1_stat: Double? = null, var num_missing_obs: Double? = null) : DbTableData

AcrossRepViewData

data class AcrossRepViewData(var exp_name: String = "", var stat_name: String = "", var stat_count: Double? = null, var average: Double? = null, var std_dev: Double? = null) : TabularData

BatchStatTableData

data class BatchStatTableData(var id: Int = -1, var element_id_fk: Int = -1, var sim_run_id_fk: Int = -1, var rep_id: Int = -1, var stat_name: String = "", var stat_count: Double? = null, var average: Double? = null, var std_dev: Double? = null, var std_err: Double? = null, var half_width: Double? = null, var conf_level: Double? = null, var minimum: Double? = null, var maximum: Double? = null, var sum_of_obs: Double? = null, var dev_ssq: Double? = null, var last_value: Double? = null, var kurtosis: Double? = null, var skewness: Double? = null, var lag1_cov: Double? = null, var lag1_corr: Double? = null, var von_neumann_lag1_stat: Double? = null, var num_missing_obs: Double? = null, var min_batch_size: Double? = null, var min_num_batches: Double? = null, var max_num_batches_multiple: Double? = null, var max_num_batches: Double? = null, var num_rebatches: Double? = null, var current_batch_size: Double? = null, var amt_unbatched: Double? = null, var total_num_obs: Double? = null) : DbTableData

BatchStatViewData

data class BatchStatViewData(var exp_name: String = "", var run_name: String = "", var rep_id: Int = -1, var stat_name: String = "", var stat_count: Double? = null, var average: Double? = null, var std_dev: Double? = null) : TabularData

ColumnMetaData

data class ColumnMetaData(val catalogName: String, val className: String, val label: String, val name: String, val typeName: String, val type: Int, val tableName: String, val schemaName: String, val isAutoIncrement: Boolean, val isCaseSensitive: Boolean, val isCurrency: Boolean, val isDefiniteWritable: Boolean, val isReadOnly: Boolean, val isSearchable: Boolean, val isReadable: Boolean, val isSigned: Boolean, val isWritable: Boolean, val nullable: Int)

Represents column metadata extracted from database

ControlTableData

data class ControlTableData(var control_id: Int = -1, var exp_id_fk: Int = -1, var element_id_fk: Int = -1, var key_name: String = "", var control_value: Double? = null, var lower_bound: Double? = null, var upper_bound: Double? = null, var property_name: String = "", var control_type: String = "", var comment: String? = null) : DbTableData

DataAccessException

class DataAccessException(msg: String = "DataAccess Exception!") : RuntimeException

This class inherits from RuntimeException and is thrown when there is a problem with some data access. This class may either be instantiated with a specific error message or with the default error message.

Database

open class Database @JvmOverloads constructor(val dataSource: DataSource, var label: String, var defaultSchemaName: String? = null) : DatabaseIfc

DatabaseAlreadyExistsException

class DatabaseAlreadyExistsException(msg: String = "DatabaseAlreadyExistsException: The database already exists!") : RuntimeException

DatabaseDoesNotExistException

class DatabaseDoesNotExistException(msg: String = "DatabaseDoesNotExistException: The database does not exist!") : RuntimeException

DatabaseIfc

interface DatabaseIfc : DatabaseIOIfc

Many databases define database, user, schema in a variety of ways. This abstraction defines this concept as the userSchema. It is the name of the organizational construct for which the user defined database object are contained. These are not the system abstractions. The database name provided to the construct is for labeling and may or may not have any relationship to the actual file name or database name of the database. The supplied connection has all the information that it needs to access the database.

DatabaseIOIfc

interface DatabaseIOIfc

An interface that defines basic I/O capabilities for a database.

DbCreateTask

class DbCreateTask

A DbCreateTask represents a set of instructions that can be used to create, possibly fill, and alter a database. It can be used only once. The enum Type indicates what kind of tasks will be executed and the state of the task.

DbResultsAsText

class DbResultsAsText(rowSet: CachedRowSet, var dFormat: String? = "%.3f") : Iterable<List<String>>

DbSchemaInfo

data class DbSchemaInfo(var catalogName: String?, var schemaName: String?, var tableName: String)

A data class to hold meta-data information about the tables and the containing schema

DbTableData

abstract class DbTableData(tblName: String, val keyFields: List<String>, val autoIncField: Boolean = false) : TabularData

DbTableData represents a base class for constructing data classes that work with instances of DatabaseIfc. Specifically, DbTableData provide the ability to push data into a table. Thus, subclasses of DbTableData must provide information about the primary key of the table and whether the key is an auto-increment type field.

DerbyDb

open class DerbyDb @JvmOverloads constructor(dbName: String, dbDirectory: Path = KSL.dbDir, create: Boolean = true) : Database

Facilitates the creation of a database backed by Derby. The database will be empty.

EmbeddedDbIfc

interface EmbeddedDbIfc

EmbeddedDbType

enum EmbeddedDbType : Enum<EmbeddedDbType>

ExperimentTableData

data class ExperimentTableData(var exp_id: Int = -1, var sim_name: String = "", var model_name: String = "", var exp_name: String = "", var num_chunks: Int = 1, var length_of_rep: Double? = null, var length_of_warm_up: Double? = null, var rep_allowed_exec_time: Long? = null, var rep_init_option: Boolean = true, var reset_start_stream_option: Boolean = false, var antithetic_option: Boolean = false, var adv_next_sub_stream_option: Boolean = true, var num_stream_advances: Int = -1, var gc_after_rep_option: Boolean = false) : DbTableData

ExpStatRepViewData

data class ExpStatRepViewData(var exp_name: String = "", var stat_name: String = "", var rep_id: Int = -1, var rep_value: Double? = null) : TabularData

FrequencyTableData

data class FrequencyTableData(var id: Int = -1, var element_id_fk: Int = -1, var sim_run_id_fk: Int = -1, var name: String = "", var cell_label: String = "", var value: Int = -1, var count: Double? = null, var cum_count: Double? = null, var proportion: Double? = null, var cum_proportion: Double? = null) : DbTableData

HistogramTableData

data class HistogramTableData(var id: Int = -1, var element_id_fk: Int = -1, var sim_run_id_fk: Int = -1, var response_id_fk: Int = -1, var response_name: String = "", var bin_label: String = "", var bin_num: Int = -1, var bin_lower_limit: Double? = null, var bin_upper_limit: Double? = null, var bin_count: Double? = null, var bin_cum_count: Double? = null, var bin_proportion: Double? = null, var bin_cum_proportion: Double? = null) : DbTableData

KSLDatabase

class KSLDatabase @JvmOverloads constructor(db: Database, clearDataOption: Boolean = false) : DatabaseIOIfc

KSLDatabaseNotConfigured

class KSLDatabaseNotConfigured(msg: String = "KSLDatabase: The supplied database was not configured as a KSLDatabase!") : RuntimeException

KSLDatabaseObserver

class KSLDatabaseObserver(model: Model, val db: KSLDatabase = KSLDatabase("${model.simulationName}.db".replace(" ", "_"), model.outputDirectory.dbDir), var clearDataBeforeExperimentOption: Boolean = false)

The observer is automatically attached to the model upon creation. Use startObserving() or stopObserving() as needed.

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

PostgresDb

object PostgresDb

PWDiffWithinRepViewData

data class PWDiffWithinRepViewData(var sim_name: String = "", var stat_name: String = "", var rep_id: Int = -1, var a_exp_name: String = "", var a_value: Double? = null, var b_exp_name: String = "", var b_value: Double? = null, var diff_name: String = "", var a_minus_b: Double? = null) : TabularData

ResultSetRowIterator

class ResultSetRowIterator(resultSet: ResultSet) : Iterator<List<Any?>>

The user can convert the returned rows based on ColumnMetaData

ResultSetRowMapIterator

class ResultSetRowMapIterator(resultSet: ResultSet) : Iterator<Map<String, Any?>>

The user can convert the returned rows based on ColumnMetaData. The rows contain a map that is indexed by the column name and the value of the column

RvParameterTableData

data class RvParameterTableData(var rv_param_id: Int = -1, var exp_id_fk: Int = -1, var element_id_fk: Int = -1, var class_name: String = "", var data_type: String = "", var rv_name: String = "", var param_name: String = "", var param_value: Double = Double.NaN) : DbTableData

SimulationRunTableData

data class SimulationRunTableData(var run_id: Int = -1, var exp_id_fk: Int = -1, var run_name: String = "", var num_reps: Int = -1, var start_rep_id: Int = -1, var last_rep_id: Int? = null, var run_start_time_stamp: Long? = null, var run_end_time_stamp: Long? = null, var run_error_msg: String? = null) : DbTableData

SimulationSnapshot

sealed class SimulationSnapshot

Immutable point-in-time snapshot of model state at a simulation lifecycle boundary.

SnapshotBatchWriter

class SnapshotBatchWriter(db: KSLDatabase)

Writes a list of SimulationSnapshot objects produced by InMemorySnapshotCollector into a KSLDatabase in a single sequential pass.

SQLiteDb

open class SQLiteDb @JvmOverloads constructor(dbName: String, dbDirectory: Path = KSL.dbDir, deleteIfExists: Boolean = true) : Database

Facilitates the creation of a database backed by SQLite. The database will be empty.

TableDoesNotExistException

class TableDoesNotExistException(msg: String = "TableDoesNotExistException: The table in the database does not exist!") : RuntimeException

TabularData

abstract class TabularData(tableName: String)

TabularData represents a base class for constructing data classes that hold tabular data. Only base types can be represented. Numeric columns can be represented by (Double, Int, Long, Short, Byte, Float, and Boolean). Boolean is considered numeric via conversion with 1 true and 0 false. Non-numeric fields are represented by String. Complex data types are not represented.

TimeSeriesResponseTableData

data class TimeSeriesResponseTableData(var id: Int = -1, var element_id_fk: Int = -1, var sim_run_id_fk: Int = -1, var rep_id: Int = -1, var stat_name: String = "", var period: Int = -1, var start_time: Double? = null, var end_time: Double? = null, var length: Double? = null, var value: Double? = null) : DbTableData

TimeSeriesResponseViewData

data class TimeSeriesResponseViewData(var exp_name: String = "", var element_id_fk: Int = -1, var sim_run_id_fk: Int = -1, var stat_name: String = "", var period: Int = -1, var start_time: Double? = null, var end_time: Double? = null, var stat_count: Double? = null, var average: Double? = null, var std_dev: Double? = null, var minimum: Double? = null, var maximum: Double? = null) : TabularData

WithinRepCounterStatTableData

data class WithinRepCounterStatTableData(var id: Int = -1, var element_id_fk: Int = -1, var sim_run_id_fk: Int = -1, var rep_id: Int = -1, var stat_name: String = "", var last_value: Double? = null) : DbTableData

WithinRepCounterViewData

data class WithinRepCounterViewData(var exp_name: String = "", var run_name: String = "", var num_reps: Int = -1, var start_rep_id: Int = -1, var last_rep_id: Int = -1, var stat_name: String = "", var rep_id: Int = -1, var last_value: Double? = null) : TabularData

WithinRepResponseViewData

data class WithinRepResponseViewData(var exp_name: String = "", var run_name: String = "", var num_reps: Int = -1, var start_rep_id: Int = -1, var last_rep_id: Int = -1, var stat_name: String = "", var rep_id: Int = -1, var average: Double? = null) : TabularData

WithinRepStatTableData

data class WithinRepStatTableData(var id: Int = -1, var element_id_fk: Int = -1, var sim_run_id_fk: Int = -1, var rep_id: Int = -1, var stat_name: String = "", var stat_count: Double? = null, var average: Double? = null, var minimum: Double? = null, var maximum: Double? = null, var weighted_sum: Double? = null, var sum_of_weights: Double? = null, var weighted_ssq: Double? = null, var last_value: Double? = null, var last_weight: Double? = null) : DbTableData

WithinRepViewData

data class WithinRepViewData(var exp_name: String = "", var run_name: String = "", var num_reps: Int = -1, var start_rep_id: Int = -1, var last_rep_id: Int = -1, var stat_name: String = "", var rep_id: Int = -1, var rep_value: Double? = null) : TabularData

Functions

isEven

fun isEven(value: Int): Boolean

isOdd

fun isOdd(value: Int): Boolean