equinox-backend/com.tecknobit.equinoxbackend.batch/BatchSynchronizationProcedure

BatchSynchronizationProcedure

abstract class BatchSynchronizationProcedure<O, D, V> : EquinoxItemsHelper

The BatchSynchronizationProcedure class is designed to compact and to clean implement a batch synchronization procedure giving the base behavior that a batch synchronization need to have

Author

N7ghtm4r3 - Tecknobit

Since

1.0.8

Parameters

<O>

The type of the owner entity

<D>

The type of the owned entity

<V>

The type of the support item used during the synchronization such JoinTableSyncBatchItem

Constructors

BatchSynchronizationProcedure

constructor(owner: O, ownedItems: Collection<D>, table: String, entityManager: EntityManager)

Constructor to init the sync procedure

Types

CurrentDataCallback

interface CurrentDataCallback<D>

The CurrentDataCallback interface is useful to define a retriever used to retrieve the current data currently owned by the owner entity

Properties

_IN_CLAUSE_

private val _IN_CLAUSE_: String = " IN "

IN_CLAUSE in clause query part

_VALUES_

val _VALUES_: String = " VALUES "

VALUES values query part

_WHERE_

val _WHERE_: String = " WHERE "

WHERE where query part

batchQuery

protected val batchQuery: EquinoxItemsHelper.BatchQuery<V>

batchQuery the manager of the batch query to execute

CLOSED_ROUND_BRACKET

val CLOSED_ROUND_BRACKET: String = ")"

CLOSED_ROUND_BRACKET closed round bracket character

COMMA

val COMMA: String = ","

COMMA comma character

currentDataCallback

protected open var currentDataCallback: BatchSynchronizationProcedure.CurrentDataCallback<D>

currentDataCallback the callback used to retrieve the current data owned by the owner entity

DELETE_FROM_

val DELETE_FROM_: String = "DELETE FROM "

DELETE_FROM_ delete from query command

entityManager

protected open var entityManager: EntityManager

entityManager entity manager helper

model

protected val model: EquinoxItemsHelper.SyncBatchModel

model the model to use during the synchronization procedure

OPENED_ROUND_BRACKET

val OPENED_ROUND_BRACKET: String = "("

OPENED_ROUND_BRACKET opened round bracket character

ownedItems

protected val ownedItems: Collection<D>

ownedItems the collection of the entities owned by the owner entity

owner

protected val owner: O

owner the owner entity in the relationship

QUESTION_MARK

val QUESTION_MARK: String = "?"

QUESTION_MARK question mark character

SINGLE_QUOTE

val SINGLE_QUOTE: String = "'"

SINGLE_QUOTE single quote character

table

protected val table: String

table the table where execute the synchronization

Functions

batchDelete

protected open fun batchDelete(table: String, values: Collection<out Any>, @NotNull columns: Array<@NotNull String>)

Method used to execute a batch delete of a single list of data simultaneously

batchInsert

protected open fun <V> batchInsert( command: EquinoxItemsHelper.InsertCommand, table: String, batchQuery: EquinoxItemsHelper.BatchQuery<V>)

Method used to execute a batch insert of a list of data simultaneously

createBatchQuery

protected abstract fun createBatchQuery(): EquinoxItemsHelper.BatchQuery<V>

Method used to create the batch query used by the procedure

createModel

protected abstract fun createModel(): EquinoxItemsHelper.SyncBatchModel

Method used to create the sync batch model used by the procedure

executeBatchSynchronization

open fun executeBatchSynchronization()

open fun executeBatchSynchronization(command: EquinoxItemsHelper.InsertCommand)

Method used to execute the batch synchronization

getBatchQuery

open fun getBatchQuery(): EquinoxItemsHelper.BatchQuery<V>

Method used to get the batchQuery

getCurrentDataCallback

open fun getCurrentDataCallback(): BatchSynchronizationProcedure.CurrentDataCallback<D>

Method used to get the currentDataCallback

getModel

open fun getModel(): EquinoxItemsHelper.SyncBatchModel

Method used to get the model

getOwnedItems

open fun getOwnedItems(): Collection<D>

Method used to get the ownedItems

getOwner

open fun getOwner(): O

Method used to get the owner

getTable

open fun getTable(): String

Method used to get the table

loadDataList

protected abstract fun loadDataList(rawData: Collection<D>): Collection<V>

Method used to loads and convert a raw collection of data to the collection used by the procedure

setCurrentDataCallback

open fun setCurrentDataCallback(currentDataCallback: BatchSynchronizationProcedure.CurrentDataCallback<D>)

Method used to set the currentDataCallback instance

syncBatch

protected open fun <V> syncBatch(model: EquinoxItemsHelper.SyncBatchModel, table: String, batchQuery: EquinoxItemsHelper.BatchQuery<V>)

protected open fun <V> syncBatch( model: EquinoxItemsHelper.SyncBatchModel, command: EquinoxItemsHelper.InsertCommand, table: String, batchQuery: EquinoxItemsHelper.BatchQuery<V>)

Method used to execute a batch synchronization of a list of data simultaneously