de.ipcon.db.core

Interface BOLoaderI

All Superinterfaces:

BLOBLoaderI, BOQueryLoaderI, GrooqlBOLoaderI, SchemaProviderI

All Known Subinterfaces:

BackendBOLoaderI, BackendBOLoaderWithPersistenceHandlerI, BackendConnectionManagerI, BackendQueryAnsweringBOLoaderI, BOLoaderWithCacheI, DBManLocalI

All Known Implementing Classes:

BackendConnectionManager, BOLoaderWrapper, CachingBOLoader, CachingBOLoaderDuringGC, CachingBOLoaderExtended, DBMan, DBManLocalBOLoader, TestBOLoader, TestBOLoaderV2, TestTransaction, TestTransactionV2, Transaction

public interface BOLoaderI
extends GrooqlBOLoaderI, BLOBLoaderI, BOQueryLoaderI

This interface is a common loader for lazy loading as well as loading BOs in a client or server environment. It's implemented by Transaction, BackendConnectionManager and many others to conveniently support querying for more objects. As BOs are supposed to have a BOLoader this interface can be used to get other objects by query or id from within BO methods.

See Also:

Transaction, BackendConnectionManager

Nested Class Summary

Nested classes/interfaces inherited from interface de.ipcon.db.core.BOQueryLoaderI

BOQueryLoaderI.InternalHelper

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	$0
static java.lang.InheritableThreadLocal	rootPaneToLockOnConnectionInterrupt The value of the ThreadLocal is set whenever a request to the server will be triggered.

Method Summary

Modifier and Type	Method and Description
void	drain() If this BOLoader has a cache, we request it to empty it.
void	execute(BatchedBackendRequestI[] srs)
boolean	exists(java.lang.Long id) wrapper for exists(id, null).
boolean	exists(java.lang.Long id, java.lang.Class<? extends BOI> classtip) Returns true if a BO with the given id exists.
default BO[]	frapBOArrayFromCache(BO[] arr)
default BOI[]	frapBOIArrayFromCache(BOI[] arr)
default java.util.Collection<? extends BOI>	frapBOsFromCache(java.util.Collection<? extends BOI> c)
BO	frapFromCache(BO bo) Put a BO instance to further use in this BOLoader, cloning it in case it's unknown, giving back a cached instance in case it's cached, in any way returning an instance without making further reloads (which would make the effort of caching it useless).
default BOI	frapFromCache(BOI bo) Put a BOI instance to further use in this BOLoader, cloning it in case it's unknown, giving back a cached instance in case it's cached, in any way returning an instance without making further reloads (which would make the effort of caching it useless).
BO	getBO(java.lang.Long id) wrapper for getBO(id, null).
BO	getBO(java.lang.Long id, java.lang.Class<? extends BOI> classtip) Returns the BO with the given id.
BO[]	getBOs(long[] ids) wrapper for getBOs(ids, null)
BO[]	getBOs(java.lang.Long[] ids) wrapper for getBOs(ids, null)
BO[]	getBOs(long[] ids, java.lang.Class<? extends BOI> classtip) returns the BOs with the given ids.
BO[]	getBOs(java.lang.Long[] ids, java.lang.Class<? extends BOI> classtip) returns the BOs with the given ids.
BOT	getBOT(java.lang.Class<? extends BOI> clazz)
BO	getBOUncached(java.lang.Long id)
BO	getBOUncached(java.lang.Long id, java.lang.Class<? extends BOI> classtip) Loads and returns the BO with this Id with a non caching BOLoader.
CryptoHandlerI	getCryptoHandler() get a reference to the CryptoHandler used.
default java.util.Locale	getDefaultLocale()
DBManEventProviderI	getEventProvider() Returns the DBManEventProviderI of this BOLoader, if any.
FeatureManagerI	getFeatureManager()
FileVaultI	getFileVault()
java.lang.Long	getNextId() get a unique Long id from the backend.
default BOLoaderI	getNonCachingLoader() If this loader is not caching, simply returns this instance.
BOLoaderI	getParentLoader() returns the BOLoader which this BOLoader uses to load its objects.
BO[]	getRelationBOs(java.lang.Long id, java.lang.Class<? extends BOI> classtip, java.lang.String attributeName) this method is used by the lazy loading map/list implementation to load related objects when needed.
BOLoaderI	getRootLoader() Returns the root BOLoader of this BOLoader or this if there is no more parent loader.
SchemaI	getSchema() gets a reference to the schema which is used by this BOLoader.
static boolean	isAncestorOf(BOLoaderI ancestor, BOLoaderI descendant) Checks if one BOLoaderI is an ancestor of another.
boolean	isCaching() If true, then this BOLoaderI uses an internal cache, holding all BOs hat were loaded or frapped into it.
java.lang.Boolean	isLoggedIn(Benutzer user) Tells if the given Benutzer is currently logged in.
boolean	isLoggedInNN(Benutzer user) Tells if the given Benutzer is currently logged in.
boolean	isRecording() Returns true if this BOLoaderI records changes.
default boolean	isRootLoader() Returns true if this is a root BOLoader
default boolean	isServerSide() Returns true if this BOLoaderI or any loader in its loader-chain is a BackendBOLoaderI and thus this BOLoaderI is located on server-side.
default boolean	isTesting() Returns true if this BOLoaderI is for testing only, i.e. used in JUnit testing environments only.
default BatchedBackendRequestI	prepareQuery(BOQuery boq)
default BatchedBackendRequestI	prepareQuery(java.lang.String s)
default BatchedBackendRequestI	prepareQuery(java.lang.String s, java.lang.Object[] o)
BatchedBackendRequestI	prepareQuery(java.lang.String s, java.lang.Object[] o, java.lang.String language)
de.ipcon.db.core.QueryResultsI	query(BOQuery q) query objects in an iterative way to hide backend processing time.
default de.ipcon.db.core.QueryResultsI	query(java.lang.String t) wrapper for query(t, Object[0], null)
default de.ipcon.db.core.QueryResultsI	query(java.lang.String t, java.lang.Object[] pvals) wrapper for query(t, pvals, null)
de.ipcon.db.core.QueryResultsI	query(java.lang.String t, java.lang.Object[] pvals, java.lang.String language) query objects in an iterative way to hide backend processing time.
java.util.List	queryBO(BOQuery q) query objects and block until all objects are transferred, returns Objects as a List.
java.util.List	queryBO(java.lang.String t) wrapper for queryBO(String, Object[0])
java.util.List	queryBO(java.lang.String t, java.lang.Object[] pvals) query objects and block until all objects are transferred, returns Objects as a List.
de.ipcon.db.core.QueryResultsI	queryRelation(long id, java.lang.Class<? extends BOI> classtip, java.lang.String attributeName) does the same as @see #getRelationBOs, but returns a QueryResultsI like @see #query.
java.lang.Long	testAuth(Anmeldung a) Tests whether given credentials can be verified.
boolean	testAuth(de.ipcon.db.core.PasswortUeberpruefung a) Tests whether given credentials can be verified.

Methods inherited from interface de.ipcon.db.blob.BLOBLoaderI

getBLOB, getBLOB, getBLOB, getBLOB, getBLOB, getBLOB, getBLOB, getBLOB, getBLOBInfo, getBLOBInfo, hasBLOB, hasBLOB, haveBLOB, haveBLOB, haveBLOB

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

getBOByAttr, getBOByAttr, getBOByAttr, getBOByAttrs, getBOByAttrs, getBOByAttrs, getBOsByAttrs, getBOsByAttrs, getBOsByAttrs, getBOsByAttrs, getOneBOByAttr, getUniqueBOByAttr

Field Detail

$0

static final java.lang.String $0

See Also:

Constant Field Values

rootPaneToLockOnConnectionInterrupt

static final java.lang.InheritableThreadLocal rootPaneToLockOnConnectionInterrupt

The value of the ThreadLocal is set whenever a request to the server will be triggered. It contains the JRootPane we need to lock in case the connection is interrupted when someone needs to call the server. The correct JRootPane is set in the BOLoaderI from the Client, if a new window is opened. The BackendConnectionManager in the same Thread can access this value and actually render the locking graphics and remove it again once a connection has been reestablished. This saves passing around the JRootPane through all interfaces and methods. After the result has been acquired, the value of the ThreadLocal is set to null again in the finally- clause. We are using an InheritableThreadLocal as e.g. in bookmarks the values are loaded asynchronously in a new Thread, but if that Thread encounters a connection error, we still need to know, which pane to lock! Thus we need the value passed to any child-process. FIXME!!! But this does not help yet... :-(

Method Detail

isAncestorOf

static boolean isAncestorOf(BOLoaderI ancestor,
                            BOLoaderI descendant)

Checks if one BOLoaderI is an ancestor of another. A BOLoader is considered an ancestor of itself. A null descendant never has an ancestor. A null ancestor can never be an ancestor of any descendant.

Parameters:

ancestor - The BOLoaderI to check if it's an ancestor.

descendant - The BOLoaderI to check if it's a descendant.

Returns:

true if ancestor is an ancestor of descendant, false otherwise.

getSchema

SchemaI getSchema()

gets a reference to the schema which is used by this BOLoader. Within the schema, you can find methods to set/get values, gather information about available entities and their attributes and many other things, too.

Specified by:

getSchema in interface SchemaProviderI

Returns:

the schema of this BOLoader instance.

getDefaultLocale

default java.util.Locale getDefaultLocale()

getCryptoHandler

CryptoHandlerI getCryptoHandler()

get a reference to the CryptoHandler used. On the server side, this will be a a ServerCryptoHandler, on the client side a ClientCryptoHandler. The main difference between these two is that the server side can calculate hashes, whereas the client side cannot.

Returns:

the cryptohandler used by this BOLoader instance.

getFileVault

FileVaultI getFileVault()

getFeatureManager

FeatureManagerI getFeatureManager()

getBOT

BOT getBOT(java.lang.Class<? extends BOI> clazz)

exists

boolean exists(java.lang.Long id,
               java.lang.Class<? extends BOI> classtip)

Returns true if a BO with the given id exists. The class tip is just what the name suggests, just a tip and will only have performance consequences if wrong or null.

Parameters:

id - the id of the BO

classtip - a guess which class the object has. May be null.

Returns:

true if a BO with the given id exists

exists

boolean exists(java.lang.Long id)

wrapper for exists(id, null).

See Also:

exists(Long, Class)

getBO

BO getBO(java.lang.Long id,
         java.lang.Class<? extends BOI> classtip)

Returns the BO with the given id. If the BOLoader instance has an instance cache (like the Transaction class), then multiple calls to this method with the same id will return the exact same object, which means getBO(id,...)==getBO(id,...). The class tip is just what the name suggests, just a tip and will only have performance consequences if a wrong or null value is passed. FIXME!! TT 2023-05-11: This method can probably return null in a few cases but I have no information what exactly these might be and it also depends on the actual implementing class. Also some implementations (DBMan for example) will throw ObjectNotPersistentException if no matching BO is found, while other implementations will not. Some classes - for example Mandant from crm-accounts module - will rely in ObjectNotPersistentException being thrown.

Parameters:

id - the id of the BO

classtip - a guess which class the object has. May be null.

Returns:

BO with the given id.

getBO

BO getBO(java.lang.Long id)

wrapper for getBO(id, null). FIXME!! TT 2023-05-11: This method can probably return null in a few cases but I have no information what exactly these might be and it also depends on the actual implementing class. Also some implementations (DBMan for example) will throw ObjectNotPersistentException if no matching BO is found, while other implementations will not. Some classes - for example Mandant from crm-accounts module - will rely in ObjectNotPersistentException being thrown.

See Also:

getBO(Long, Class)

getBOUncached

BO getBOUncached(java.lang.Long id,
                 java.lang.Class<? extends BOI> classtip)

Loads and returns the BO with this Id with a non caching BOLoader. The BOLoader of the returned BO can (but doesn't have to) be different than the BOLoader this method was called on, e.g. isCaching() BOLoaderI instances.

getBOUncached

BO getBOUncached(java.lang.Long id)

getBOs

BO[] getBOs(java.lang.Long[] ids,
            java.lang.Class<? extends BOI> classtip)

returns the BOs with the given ids. If the BOLoader instance has an instance cache (like the Transaction class), then multiple calls to this method will return an array with the exact same objects. The class tip is common for all objects within this call and may be null.

Parameters:

ids - array of Longs with ids for the requested BOs.

classtip - guess for classes which the BOs belong to, may be null.

Returns:

BO[] with the requested BOs.

See Also:

Transaction

getBOs

BO[] getBOs(java.lang.Long[] ids)

wrapper for getBOs(ids, null)

See Also:

getBOs(Long[],Class)

getBOs

BO[] getBOs(long[] ids,
            java.lang.Class<? extends BOI> classtip)

returns the BOs with the given ids. If the BOLoader instance has an instance cache (like the Transaction class), then multiple calls to this method will return an array with the exact same objects. The class tip is common for all objects within this call and may be null.

Parameters:

ids - array of longs with ids for the requested BOs.

classtip - guess for classes which the BOs belong to, may be null.

Returns:

BO[] with the requested BOs.

See Also:

Transaction

getBOs

BO[] getBOs(long[] ids)

wrapper for getBOs(ids, null)

See Also:

getBOs(long[],Class)

getRelationBOs

BO[] getRelationBOs(java.lang.Long id,
                    java.lang.Class<? extends BOI> classtip,
                    java.lang.String attributeName)

this method is used by the lazy loading map/list implementation to load related objects when needed. It's not thought for day to day use.

Parameters:

id - id of the BO which the requested BOs has a relation to

classtip - common superclass of the requested bos

attributeName - name of the relation from the BO to the requested ones

Returns:

bo[id].attributeName as array.

queryRelation

de.ipcon.db.core.QueryResultsI queryRelation(long id,
                                             java.lang.Class<? extends BOI> classtip,
                                             java.lang.String attributeName)

does the same as @see #getRelationBOs, but returns a QueryResultsI like @see #query.

query

default de.ipcon.db.core.QueryResultsI query(java.lang.String t)

wrapper for query(t, Object[0], null)

Specified by:

query in interface BOQueryLoaderI

See Also:

query(String, Object[], String)

query

default de.ipcon.db.core.QueryResultsI query(java.lang.String t,
                                             java.lang.Object[] pvals)

wrapper for query(t, pvals, null)

Specified by:

query in interface BOQueryLoaderI

Specified by:

query in interface GrooqlBOLoaderI

Parameters:

t - the query to fetch, written in OQL

pvals - an object array corresponding with $n entries, $1 is pvals[0] and so forth. Must not be null.

Returns:

QueryResults iterator through the query results.

See Also:

query(String, Object[], String)

query

de.ipcon.db.core.QueryResultsI query(java.lang.String t,
                                     java.lang.Object[] pvals,
                                     java.lang.String language)

query objects in an iterative way to hide backend processing time. The QueryResults interface "feels" like the standard iterator interface from the collections framework and it's thought to be used like this: This sample shows how to query bla BOs though this method do it = bol.query("bla from pack.bo bla where not Ldel limit 2") loop while it.hasNext() bo = BO it.getCurrentObject() -- hopefully this IS a BO, depends on the query. -- do whatever you have to do with the bo finally it.close() end The finally clause is very important to free up database and backend resources, so please don't forget this step!

Parameters:

t - the query to fetch, written in OQL

pvals - an object array corresponding with $n entries, $1 is pvals[0] and so forth. Must not be null.

language - the strict 2-letter language code to use for our standard hstore keys for L10nString-s

Returns:

QueryResults iterator through the query results.

query

de.ipcon.db.core.QueryResultsI query(BOQuery q)

query objects in an iterative way to hide backend processing time.

Parameters:

q - the query to fetch, written in OQL

Returns:

QueryResults iterator through the query results.

queryBO

java.util.List queryBO(java.lang.String t,
                       java.lang.Object[] pvals)

query objects and block until all objects are transferred, returns Objects as a List. If at all possible, use query() instead of this, as it's a resource hogger and rather slow - except if you need a complete and rather small set of objects in this or an equivalent form and no further processing.

Specified by:

queryBO in interface BOQueryLoaderI

Specified by:

queryBO in interface GrooqlBOLoaderI

Parameters:

t - the query to fetch, written in OQL

pvals - an object array corresponding with $n entries, $1 is pvals[0] and so forth. Must not be null.

Returns:

List with the requested objects.

See Also:

query(String, Object[])

queryBO

java.util.List queryBO(java.lang.String t)

wrapper for queryBO(String, Object[0])

Specified by:

queryBO in interface BOQueryLoaderI

See Also:

queryBO(String, Object[])

queryBO

java.util.List queryBO(BOQuery q)

query objects and block until all objects are transferred, returns Objects as a List.

Parameters:

q - the query to fetch, written in OQL

Returns:

List with the requested objects.

getNextId

java.lang.Long getNextId()

get a unique Long id from the backend. Please note that the ids drawn here are considered 'consumed'. An intentional delay in the backend safeguards that the process of consuming all usable ids from an instance will take at least about 29247120867 years.

Returns:

Long id which is guaranteed to be unique within the whole cluster.

testAuth

java.lang.Long testAuth(Anmeldung a)

Tests whether given credentials can be verified. Returns long denoting the internal BO object in case the verification succeeded.

Returns:

Long id of the Benutzer object in case the verification succeeded, null otherwise (aside a server-dependent lag).

testAuth

boolean testAuth(de.ipcon.db.core.PasswortUeberpruefung a)

Tests whether given credentials can be verified. Returns true in case the verification succeeded.

Returns:

true in case the verification succeeded, false otherwise.

prepareQuery

default BatchedBackendRequestI prepareQuery(BOQuery boq)

prepareQuery

default BatchedBackendRequestI prepareQuery(java.lang.String s)

prepareQuery

default BatchedBackendRequestI prepareQuery(java.lang.String s,
                                            java.lang.Object[] o)

prepareQuery

BatchedBackendRequestI prepareQuery(java.lang.String s,
                                    java.lang.Object[] o,
                                    java.lang.String language)

execute

void execute(BatchedBackendRequestI[] srs)

isLoggedIn

java.lang.Boolean isLoggedIn(Benutzer user)

Tells if the given Benutzer is currently logged in.

Parameters:

user - the Benutzer for which the logged in state should be checked

Returns:

Boolean.TRUE if Benutzer is currently logged in, Boolean.FALSE if not and null if this info is not available

isLoggedInNN

boolean isLoggedInNN(Benutzer user)

Tells if the given Benutzer is currently logged in.

Parameters:

user - the Benutzer for which the logged in state should be checked

Returns:

true if Benutzer is currently logged in, false if not or if this info is not available

drain

void drain()

If this BOLoader has a cache, we request it to empty it. The BOLoader should make every effort to keep valuable data though, but objects not "nailed" (=included in a transaction) should be reloaded or removed from the cache so that a further request will fetch them again. If isCaching() returns false, this is a nop.

isCaching

boolean isCaching()

If true, then this BOLoaderI uses an internal cache, holding all BOs hat were loaded or frapped into it. In this case, the BOLoader should not be expected to handle automatic cache eviction (some might). A BOLoader that is caching can be expected to deduplicate BOs with the same Id from different sources to create a stable, self contained BO graph. Caching BOLoaders should not be expected to always hold the most up to date version of a BO, even after frapping a newer BO with it, i.e. an already cached BO is might always be preferred. If false, then this BOLoader will not hold references to loaded BOs, allowing them to be garbage collected as soon as they're no longer referenced outside of this class. As a result, this Interface makes no guarantees regarding deduplication of BOs in the returned graph.

Returns:

true if this BOLoaderI uses a cache, false if loaded BOs aren't cached.

getNonCachingLoader

default BOLoaderI getNonCachingLoader()

If this loader is not caching, simply returns this instance. Otherwise returns the first not caching loader in the ancestor chain (@see getParentLoader()}. If no loader in the chaing is not caching, returns null.

Returns:

the first loader in the ancestor chain (starting with this instance) that has isCaching() = false; null if no such loader is found

isRecording

boolean isRecording()

Returns true if this BOLoaderI records changes.

frapFromCache

BO frapFromCache(BO bo)

Put a BO instance to further use in this BOLoader, cloning it in case it's unknown, giving back a cached instance in case it's cached, in any way returning an instance without making further reloads (which would make the effort of caching it useless).

frapBOArrayFromCache

default BO[] frapBOArrayFromCache(BO[] arr)

frapFromCache

default BOI frapFromCache(BOI bo)

Put a BOI instance to further use in this BOLoader, cloning it in case it's unknown, giving back a cached instance in case it's cached, in any way returning an instance without making further reloads (which would make the effort of caching it useless).

frapBOIArrayFromCache

default BOI[] frapBOIArrayFromCache(BOI[] arr)

frapBOsFromCache

default java.util.Collection<? extends BOI> frapBOsFromCache(java.util.Collection<? extends BOI> c)

getParentLoader

BOLoaderI getParentLoader()

returns the BOLoader which this BOLoader uses to load its objects. If this is a Root BOLoader, then null is returned.

getRootLoader

BOLoaderI getRootLoader()

Returns the root BOLoader of this BOLoader or this if there is no more parent loader.

isRootLoader

default boolean isRootLoader()

Returns true if this is a root BOLoader

isServerSide

default boolean isServerSide()

Returns true if this BOLoaderI or any loader in its loader-chain is a BackendBOLoaderI and thus this BOLoaderI is located on server-side.

getEventProvider

DBManEventProviderI getEventProvider()

Returns the DBManEventProviderI of this BOLoader, if any.

isTesting

default boolean isTesting()

Returns true if this BOLoaderI is for testing only, i.e. used in JUnit testing environments only.