exposed-dao/org.jetbrains.exposed.dao/EntityClass

EntityClass

abstract class EntityClass<ID : Any, out T : Entity<ID>>(val table: IdTable<ID>, entityType: Class<T>? = null, entityCtor: (EntityID<ID>) -> T? = null)

Base class responsible for the management of Entity instances and the maintenance of their relation to the provided table.

Parameters

table

The IdTable object that stores rows mapped to entities managed by this class.

entityType

The expected Entity class type. This can be left null if it is the class of type argument T provided to this EntityClass instance.

entityCtor

The function invoked to instantiate an Entity using a provided EntityID value. If a reference to a specific entity constructor or a custom function is not passed as an argument, reflection will be used to determine the primary constructor of the associated entity class on first access (which can be slower).

Inheritors

Constructors

EntityClass

constructor(table: IdTable<ID>, entityType: Class<T>? = null, entityCtor: (EntityID<ID>) -> T? = null)

Properties

dependsOnColumns

open val dependsOnColumns: List<Column<out Any?>>

The columns that this EntityClass depends on when maintaining relations with managed Entity instances.

dependsOnTables

open val dependsOnTables: ColumnSet

The IdTable that this EntityClass depends on when maintaining relations with managed Entity instances.

table

val table: IdTable<ID>

Functions

all

open fun all(): SizedIterable<T>

Gets all the Entity instances associated with this EntityClass.

backReferencedOn

infix fun <TargetID : Any, Target : Entity<TargetID>> EntityClass<TargetID, Target>.backReferencedOn(table: IdTable<*>): ReadOnlyProperty<Entity<ID>, Target>

@JvmName(name = "backReferencedOnOpt")

infix fun <TargetID : Any, Target : Entity<TargetID>, REF : Any> EntityClass<TargetID, Target>.backReferencedOn(column: Column<REF?>): ReadOnlyProperty<Entity<ID>, Target>

infix fun <TargetID : Any, Target : Entity<TargetID>, REF : Any> EntityClass<TargetID, Target>.backReferencedOn(column: Column<REF>): ReadOnlyProperty<Entity<ID>, Target>

Registers a reference as an immutable field of the parent entity class, which returns a child object of this EntityClass.

count

fun count(op: Op<Boolean>? = null): Long

Counts the amount of Entity instances that conform to the op conditional expression.

find

fun find(op: SqlExpressionBuilder.() -> Op<Boolean>): SizedIterable<T>

fun find(op: Op<Boolean>): SizedIterable<T>

Gets all the Entity instances that conform to the op conditional expression.

findById

fun findById(id: ID): T?

Gets an Entity by its id value.

open fun findById(id: EntityID<ID>): T?

Gets an Entity by its EntityID value.

findByIdAndUpdate

fun findByIdAndUpdate(id: ID, block: (it: T) -> Unit): T?

Gets an Entity by its id value and updates the retrieved entity.

findSingleByAndUpdate

fun findSingleByAndUpdate(op: Op<Boolean>, block: (it: T) -> Unit): T?

Gets a single Entity that conforms to the op conditional expression and updates the retrieved entity.

findWithCacheCondition

fun findWithCacheCondition(cacheCheckCondition: T.() -> Boolean, op: SqlExpressionBuilder.() -> Op<Boolean>): Sequence<T>

Searches the current EntityCache for all Entity instances that match the provided cacheCheckCondition. If the cache returns no matches, entities that conform to the provided op conditional expression will be retrieved from the database.

forEntityIds

open fun forEntityIds(ids: List<EntityID<ID>>): SizedIterable<T>

Returns a SizedIterable containing all entities with EntityID values from the provided ids list.

forIds

fun forIds(ids: List<ID>): SizedIterable<T>

Returns a SizedIterable containing all entities with id values from the provided ids list.

get

operator fun get(id: ID): T

operator fun get(id: EntityID<ID>): T

isAssignableTo

fun <ID : Any, T : Entity<ID>> isAssignableTo(entityClass: EntityClass<ID, T>): Boolean

Returns whether the entityClass type is equivalent to or a superclass of this EntityClass instance's klass.

memoizedTransform

fun <Unwrapped, Wrapped> Column<Unwrapped>.~~memoizedTransform~~(transformer: ColumnTransformer<Unwrapped, Wrapped>): EntityFieldWithTransform<Unwrapped, Wrapped>

fun <Unwrapped, Wrapped> Column<Unwrapped>.~~memoizedTransform~~(unwrap: (Wrapped) -> Unwrapped, wrap: (Unwrapped) -> Wrapped): EntityFieldWithTransform<Unwrapped, Wrapped>

Returns a EntityFieldWithTransform delegate that will cache the transformed value on first read of this same stored Unwrapped value.

fun <TColumn, Unwrapped, Wrapped> EntityFieldWithTransform<TColumn, Unwrapped>.~~memoizedTransform~~(unwrap: (Wrapped) -> Unwrapped, wrap: (Unwrapped) -> Wrapped): EntityFieldWithTransform<TColumn, Wrapped>

Returns a EntityFieldWithTransform that extends transformation of existing EntityFieldWithTransform and caches the transformed value on first read.

new

open fun new(init: T.() -> Unit): T

Creates a new Entity instance with the fields that are set in the init block. The id will be automatically set.

open fun new(id: ID?, init: T.() -> Unit): T

Creates a new Entity instance with the fields that are set in the init block and with the provided id.

optionalBackReferencedOn

infix fun <TargetID : Any, Target : Entity<TargetID>> EntityClass<TargetID, Target>.optionalBackReferencedOn(table: IdTable<*>): OptionalBackReference<TargetID, Target, ID, Entity<ID>, Any>

@JvmName(name = "optionalBackReferencedOnOpt")

infix fun <TargetID : Any, Target : Entity<TargetID>, REF : Any> EntityClass<TargetID, Target>.optionalBackReferencedOn(column: Column<REF?>): OptionalBackReference<TargetID, Target, ID, Entity<ID>, REF>

infix fun <TargetID : Any, Target : Entity<TargetID>, REF : Any> EntityClass<TargetID, Target>.optionalBackReferencedOn(column: Column<REF>): OptionalBackReference<TargetID, Target, ID, Entity<ID>, REF>

Registers an optional reference as an immutable field of the parent entity class, which returns a child object of this EntityClass.

optionalReferencedOn

infix fun optionalReferencedOn(table: IdTable<*>): OptionalReference<Any, ID, T>

infix fun <REF : Any> optionalReferencedOn(column: Column<REF?>): OptionalReference<REF, ID, T>

Registers an optional reference as a field of the child entity class, which returns a parent object of this EntityClass.

optionalReferrersOn

infix fun <TargetID : Any, Target : Entity<TargetID>> EntityClass<TargetID, Target>.optionalReferrersOn(table: IdTable<*>): OptionalReferrers<ID, Entity<ID>, TargetID, Target, Any>

infix fun <TargetID : Any, Target : Entity<TargetID>, REF : Any> EntityClass<TargetID, Target>.optionalReferrersOn(column: Column<REF?>): OptionalReferrers<ID, Entity<ID>, TargetID, Target, REF>

fun <TargetID : Any, Target : Entity<TargetID>> EntityClass<TargetID, Target>.optionalReferrersOn(table: IdTable<*>, cache: Boolean = false): OptionalReferrers<ID, Entity<ID>, TargetID, Target, Any>

fun <TargetID : Any, Target : Entity<TargetID>, REF : Any> EntityClass<TargetID, Target>.optionalReferrersOn(column: Column<REF?>, cache: Boolean = false): OptionalReferrers<ID, Entity<ID>, TargetID, Target, REF>

Registers an optional reference as an immutable field of the parent entity class, which returns a collection of child objects of this EntityClass that all reference the parent.

referencedOn

infix fun referencedOn(table: IdTable<*>): Reference<Any, ID, T>

infix fun <REF : Any> referencedOn(column: Column<REF>): Reference<REF, ID, T>

Registers a reference as a field of the child entity class, which returns a parent object of this EntityClass.

referrersOn

infix fun <TargetID : Any, Target : Entity<TargetID>> EntityClass<TargetID, Target>.referrersOn(table: IdTable<*>): Referrers<ID, Entity<ID>, TargetID, Target, Any>

infix fun <TargetID : Any, Target : Entity<TargetID>, REF : Any> EntityClass<TargetID, Target>.referrersOn(column: Column<REF>): Referrers<ID, Entity<ID>, TargetID, Target, REF>

fun <TargetID : Any, Target : Entity<TargetID>> EntityClass<TargetID, Target>.referrersOn(table: IdTable<*>, cache: Boolean): Referrers<ID, Entity<ID>, TargetID, Target, Any>

fun <TargetID : Any, Target : Entity<TargetID>, REF : Any> EntityClass<TargetID, Target>.referrersOn(column: Column<REF>, cache: Boolean): Referrers<ID, Entity<ID>, TargetID, Target, REF>

Registers a reference as an immutable field of the parent entity class, which returns a collection of child objects of this EntityClass that all reference the parent.

reload

fun reload(entity: Entity<ID>, flush: Boolean = false): T?

Reloads the fields of an entity from the database and returns the entity as a new object.

removeFromCache

fun removeFromCache(entity: Entity<ID>)

Removes the specified entity from the current EntityCache, as well as any stored references to or from the removed entity.

searchQuery

open fun searchQuery(op: Op<Boolean>): Query

Returns a Query to select all columns in dependsOnTables with a WHERE clause that includes the provided op conditional expression.

testCache

fun testCache(cacheCheckCondition: T.() -> Boolean): Sequence<T>

Searches the current EntityCache for all Entity instances that match the provided cacheCheckCondition.

fun testCache(id: EntityID<ID>): T?

Searches the current EntityCache for an Entity by its EntityID value.

transform

fun <Unwrapped, Wrapped> Column<Unwrapped>.~~transform~~(transformer: ColumnTransformer<Unwrapped, Wrapped>): EntityFieldWithTransform<Unwrapped, Wrapped>

fun <Unwrapped, Wrapped> Column<Unwrapped>.~~transform~~(unwrap: (Wrapped) -> Unwrapped, wrap: (Unwrapped) -> Wrapped): EntityFieldWithTransform<Unwrapped, Wrapped>

Returns a EntityFieldWithTransform delegate that transforms this stored Unwrapped value on every read.

fun <TColumn, Unwrapped, Wrapped> EntityFieldWithTransform<TColumn, Unwrapped>.~~transform~~(unwrap: (Wrapped) -> Unwrapped, wrap: (Unwrapped) -> Wrapped): EntityFieldWithTransform<TColumn, Wrapped>

Returns a EntityFieldWithTransform that extends transformation of existing EntityFieldWithTransform.

view

inline fun view(op: SqlExpressionBuilder.() -> Op<Boolean>): View<T>

Creates a View or subset of Entity instances, which are managed by this EntityClass and conform to the specified op conditional expression.

warmUpLinkedReferences

fun <SID : Any> warmUpLinkedReferences(references: List<EntityID<SID>>, linkTable: Table, forUpdate: Boolean? = null, optimizedLoad: Boolean = false): List<T>

Returns a list of retrieved Entity instances whose reference column matches any of the EntityID values in references. Both the entity's source and target reference columns should have been defined in linkTable.

warmUpOptReferences

fun <SID> warmUpOptReferences(references: List<SID>, refColumn: Column<SID?>, forUpdate: Boolean? = null): List<T>

Returns a list of retrieved Entity instances whose refColumn optionally matches any of the id values in references.

warmUpReferences

fun <SID> warmUpReferences(references: List<SID>, refColumn: Column<SID>, forUpdate: Boolean? = null): List<T>

Returns a list of retrieved Entity instances whose refColumn matches any of the id values in references.

wrap

fun wrap(id: EntityID<ID>, row: ResultRow?): T

Returns an Entity with the provided EntityID value, or, if an entity was not found in the current EntityCache, creates a new instance using the data in row.

wrapRow

fun wrapRow(row: ResultRow): T

fun wrapRow(row: ResultRow, alias: Alias<IdTable<*>>): T

fun wrapRow(row: ResultRow, alias: QueryAlias): T

Wraps the specified ResultRow data into an Entity instance.

wrapRows

fun wrapRows(rows: SizedIterable<ResultRow>): SizedIterable<T>

fun wrapRows(rows: SizedIterable<ResultRow>, alias: Alias<IdTable<*>>): SizedIterable<T>

fun wrapRows(rows: SizedIterable<ResultRow>, alias: QueryAlias): SizedIterable<T>

Returns a SizedIterable containing entities generated using data retrieved from a database result set in rows.