de.ipcon.gui

Class ClientPersistenceHelper

java.lang.Object

de.ipcon.gui.AbstractClientHelper

de.ipcon.gui.ClientPersistenceHelper

All Implemented Interfaces:

de.ipcon.db.core.SaveBOListenerI, de.ipcon.db.core.TransactionBuilderI, de.ipcon.db.core.TransactionProviderI, FormTransactionBuilderI, java.io.Serializable

public class ClientPersistenceHelper
extends AbstractClientHelper
implements FormTransactionBuilderI, de.ipcon.db.core.TransactionProviderI, de.ipcon.db.core.SaveBOListenerI

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClientPersistenceHelper(Client _client)

Method Summary

Modifier and Type	Method and Description
void	addSaveBOListener(de.ipcon.db.core.SaveBOListenerI l) Adds the passed SaveBOListenerI to the list of listeners, wrapped in a WeakReference.
void	flushCaches()
BO	getBO(java.lang.Long id, java.lang.Class classTip)
de.ipcon.db.core.CodebausteinStorageI	getCodebausteinStorage() Returns the lazily initialized storage provider for Codebausteine.
FulltextSearcherI	getFulltextSearcher()
Transaction	getNewFormTransaction() Creates an interactive form transaction initialized with the current user.
Transaction	getNewFormTransaction(java.lang.String desc) Creates an interactive form transaction initialized with the current user and an identifying description for auditing and debugging.
Transaction	getNewTransaction()
Transaction	getNewTransaction(BOLoaderI loader, SchemaI txSchema, java.lang.String desc, TemporaryIdSupplierI tempIdSupplier) Central internal factory method to create and fully initialize a new database transaction.
Transaction	getNewTransaction(java.lang.String desc)
Transaction	getNewTransaction(java.lang.String desc, TemporaryIdSupplierI tempIdSupplier)
Transaction	getNewTransaction(TemporaryIdSupplierI tempIdSupplier)
Transaction	getNewTransactionWithInstrumentedSchema()
Transaction	getNewTransactionWithInstrumentedSchema(java.lang.String desc)
Transaction	getNewTransactionWithInstrumentedSchema(java.lang.String desc, TemporaryIdSupplierI tempIdSupplier)
Transaction	getNewTransactionWithInstrumentedSchema(TemporaryIdSupplierI tempIdSupplier)
StrukturCache	getStrukturCache()
boolean	isMemoryTightClient() Checks non-blockingly whether the client's local persistence and caching layer is operating under memory constraints.
boolean	isNotificationSystemActivated()
java.util.List	queryBO(groovy.lang.GString gs) Executes a database query dynamically constructed via Groovy GString interpolation.
java.util.List	queryBO(java.lang.String query)
java.util.List	queryBO(java.lang.String query, java.lang.Object[] params)
void	removeSaveBOListener(de.ipcon.db.core.SaveBOListenerI l) Removes the passed SaveBOListenerI from the list of listeners.
TransactionAnswer	saveBO(Transaction tx)
TransactionAnswer	saveBO(Transaction tx, boolean ignoreConflicts) Saves the provided transaction.
void	transactionSaveSuccess(Transaction stubTx, java.util.Map<java.lang.Long,java.lang.Long> tempIdToDbIdMap, java.util.function.Predicate<Transaction> isSavedTransactionInstancePredicate) Notifies all registered SaveBOListenerI-s about a successfully saved Transaction via the transactionSaveSuccess-callback.

Methods inherited from class de.ipcon.gui.AbstractClientHelper

client

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.ipcon.db.core.TransactionProviderI

saveWithRetries, saveWithRetries

Constructor Detail

ClientPersistenceHelper

public ClientPersistenceHelper(Client _client)

Method Detail

saveBO

public TransactionAnswer saveBO(Transaction tx)

Specified by:

saveBO in interface de.ipcon.db.core.TransactionProviderI

saveBO

public TransactionAnswer saveBO(Transaction tx,
                                boolean ignoreConflicts)

Saves the provided transaction. Warning: Contrary to other saveBO methods, the default value of the ignoreConflicts argument is 1/true here that is ignoreConflicts is activated if this parameter is missing (for backwards compatibility). If saving was successful, then the transaction won't be active anymore. If saving wasn't successful, then the transaction is still active, but might've fixed any conflicts and probably succeeds if saved again. But there are no guarentees about data integrity in the latter case, e.g. if the same attribute was changed, which is the 'real' value?

Specified by:

saveBO in interface de.ipcon.db.core.TransactionProviderI

getNewFormTransaction

public Transaction getNewFormTransaction()

Description copied from interface: FormTransactionBuilderI

Creates an interactive form transaction initialized with the current user.

Specified by:

getNewFormTransaction in interface FormTransactionBuilderI

Returns:

a new transaction configured for form execution

getNewFormTransaction

public Transaction getNewFormTransaction(java.lang.String desc)

Description copied from interface: FormTransactionBuilderI

Creates an interactive form transaction initialized with the current user and an identifying description for auditing and debugging.

Specified by:

getNewFormTransaction in interface FormTransactionBuilderI

Parameters:

desc - transaction description; may be null

Returns:

a new transaction configured for form execution

getNewTransaction

public Transaction getNewTransaction()

Specified by:

getNewTransaction in interface de.ipcon.db.core.TransactionBuilderI

getNewTransaction

public Transaction getNewTransaction(java.lang.String desc)

Specified by:

getNewTransaction in interface de.ipcon.db.core.TransactionBuilderI

getNewTransaction

public Transaction getNewTransaction(TemporaryIdSupplierI tempIdSupplier)

Specified by:

getNewTransaction in interface de.ipcon.db.core.TransactionBuilderI

getNewTransaction

public Transaction getNewTransaction(java.lang.String desc,
                                     TemporaryIdSupplierI tempIdSupplier)

Specified by:

getNewTransaction in interface de.ipcon.db.core.TransactionBuilderI

getNewTransactionWithInstrumentedSchema

public Transaction getNewTransactionWithInstrumentedSchema()

Specified by:

getNewTransactionWithInstrumentedSchema in interface de.ipcon.db.core.TransactionBuilderI

getNewTransactionWithInstrumentedSchema

public Transaction getNewTransactionWithInstrumentedSchema(java.lang.String desc)

Specified by:

getNewTransactionWithInstrumentedSchema in interface de.ipcon.db.core.TransactionBuilderI

getNewTransactionWithInstrumentedSchema

public Transaction getNewTransactionWithInstrumentedSchema(TemporaryIdSupplierI tempIdSupplier)

Specified by:

getNewTransactionWithInstrumentedSchema in interface de.ipcon.db.core.TransactionBuilderI

getNewTransactionWithInstrumentedSchema

public Transaction getNewTransactionWithInstrumentedSchema(java.lang.String desc,
                                                           TemporaryIdSupplierI tempIdSupplier)

Specified by:

getNewTransactionWithInstrumentedSchema in interface de.ipcon.db.core.TransactionBuilderI

getNewTransaction

public Transaction getNewTransaction(BOLoaderI loader,
                                     SchemaI txSchema,
                                     java.lang.String desc,
                                     TemporaryIdSupplierI tempIdSupplier)

Central internal factory method to create and fully initialize a new database transaction.

Parameters:

loader - The BO loader to use.

txSchema - The schema to use (optional).

desc - A description for the transaction (optional).

tempIdSupplier - A supplier for temporary IDs (optional).

Returns:

The initialized Transaction.

Throws:

java.lang.IllegalStateException - if not connected to a server.

transactionSaveSuccess

public void transactionSaveSuccess(Transaction stubTx,
                                   java.util.Map<java.lang.Long,java.lang.Long> tempIdToDbIdMap,
                                   java.util.function.Predicate<Transaction> isSavedTransactionInstancePredicate)

Notifies all registered SaveBOListenerI-s about a successfully saved Transaction via the transactionSaveSuccess-callback.

Specified by:

transactionSaveSuccess in interface de.ipcon.db.core.SaveBOListenerI

addSaveBOListener

public void addSaveBOListener(de.ipcon.db.core.SaveBOListenerI l)

Adds the passed SaveBOListenerI to the list of listeners, wrapped in a WeakReference.

removeSaveBOListener

public void removeSaveBOListener(de.ipcon.db.core.SaveBOListenerI l)

Removes the passed SaveBOListenerI from the list of listeners.

queryBO

public java.util.List queryBO(groovy.lang.GString gs)

Executes a database query dynamically constructed via Groovy GString interpolation.

Parameters:

gs - The GString query template.

Returns:

A List containing the queried Business Objects (BOs).

queryBO

public java.util.List queryBO(java.lang.String query)

queryBO

public java.util.List queryBO(java.lang.String query,
                              java.lang.Object[] params)

getBO

public BO getBO(java.lang.Long id,
                java.lang.Class classTip)

flushCaches

public void flushCaches()

isMemoryTightClient

public boolean isMemoryTightClient()

Checks non-blockingly whether the client's local persistence and caching layer is operating under memory constraints.

Returns:

true if memory is tight or restricted; false otherwise

isNotificationSystemActivated

public boolean isNotificationSystemActivated()

getFulltextSearcher

public FulltextSearcherI getFulltextSearcher()

getCodebausteinStorage

public de.ipcon.db.core.CodebausteinStorageI getCodebausteinStorage()

Returns the lazily initialized storage provider for Codebausteine.

Returns:

the active CodebausteinStorageI instance

getStrukturCache

public StrukturCache getStrukturCache()