sqlObjectMapper/com.qualifiedcactus.sqlObjectMapper.fromRs

Package-level declarations

Types

class CompositeAutoGenKey<KeyType : Any>(val dtoKClass: KClass<KeyType>) : DeclaredGeneratedKeys<KeyType>

Declare that a composite, auto-generated key of type KeyType. It is recommended to create object of this class only once.

DeclaredGeneratedKeys

interface DeclaredGeneratedKeys<KeyType : Any>

To declare a DeclaredGeneratedKeys, use classes SingleAutoGenKey or CompositeAutoGenKey

RsColumn

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD])

annotation class RsColumn(val name: String = "", val isId: Boolean = false, val converter: KClass<out RsValueConverter> = RsNoOpConverter::class)

Map a property to a column.

RsConstructor

@Target(allowedTargets = [AnnotationTarget.CONSTRUCTOR])

annotation class RsConstructor

Specify which constructor to use. If constructor has no parameters, bean mode is used. Else, constructor mode is used.

RsIgnore

@Target(allowedTargets = [AnnotationTarget.FIELD])

annotation class RsIgnore

Specify a property to ignore. Used only in bean mode.

RsNested

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD])

annotation class RsNested

Mark a property as a nested property. A nested property's class contains its own columns and nested/to-one/to-many properties.

RsNoOpConverter

class RsNoOpConverter : RsValueConverter

Does nothing

RsStringToEnumConverter

class RsStringToEnumConverter : RsValueConverter

RsToMany

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD])

annotation class RsToMany(val elementConverter: KClass<out RsValueConverter> = RsNoOpConverter::class, val classToMap: KClass<out Any> = Any::class)

Mark a property as a to-many collection. Use this when mapping values from the result of a JOIN statement. Must be of type List or Set with only one generic type parameter.

RsToOne

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD])

annotation class RsToOne

Mark a property as a to-one property. A to-one property's class contains its own columns and nested/to-one/to-many properties. A to-one property's class have to have at least 1 column marked as ID. If id column(s) is null, then the value of the to-one property is null.

RsValueConverter

interface RsValueConverter

SingleAutoGenKey

class SingleAutoGenKey<KeyType : Any>(val columnName: String, val keyType: KClass<KeyType>) : DeclaredGeneratedKeys<KeyType>

Declare a single-column, auto-generated key of type KeyType. It is recommended to create object of this class only once.

Functions

parseToList

@JvmOverloads

fun <T : Any> parseToList(resultSet: ResultSet, clazz: Class<T>, initialArraySize: Int = 0): List<T>

Get columns' values of all rows as a list of DTOs of type clazz, then close ResultSet

parseToObject

fun <T : Any> parseToObject(resultSet: ResultSet, clazz: Class<T>): T?

Get columns' values of the first row as a DTO of type clazz, then close ResultSet

parseToScalar

fun <T : Any> parseToScalar(resultSet: ResultSet): T?

Get value of the first column of the first row, then close ResultSet

parseToScalarList

@JvmOverloads

fun <T : Any> parseToScalarList(resultSet: ResultSet, initialArraySize: Int = 0): List<T?>

toList

fun <T : Any> ResultSet.toList(clazz: KClass<T>, initialArraySize: Int = 0): List<T>

Get columns' values of all rows as a list of DTOs of type clazz, then close ResultSet

toObject

fun <T : Any> ResultSet.toObject(clazz: KClass<T>): T?

Get columns' values of the first row as a DTO of type clazz, then close ResultSet

toScalar

fun <T : Any> ResultSet.toScalar(): T?

toScalarList

fun <T : Any> ResultSet.toScalarList(initialArraySize: Int = 0): List<T?>