de.ipcon.db.core

Interface BOQueryLoaderI

All Superinterfaces:

SchemaProviderI

All Known Subinterfaces:

BackendBOLoaderI, BackendBOLoaderWithPersistenceHandlerI, BackendConnectionManagerI, BackendQueryAnsweringBOLoaderI, BOLoaderI, BOLoaderWithCacheI, DBManLocalI

All Known Implementing Classes:

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

public interface BOQueryLoaderI
extends SchemaProviderI

Provides access to BO instances. Commonly, but not limited to, by having access to a database. Classes that implement this interface do not give any guarantee regarding the used BOLoader of the returned BO, unless the the class implements the BOLoaderI interface as well.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BOQueryLoaderI.InternalHelper Internal helper class to hold a protected default implementation, allowing subclasses that override getBOsByAttrs(java.lang.Class, java.lang.String[], java.lang.Object[], boolean[], int, java.util.Set)} to access the interface implementation as well.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	$0

Method Summary

Modifier and Type	Method and Description
default BO	getBOByAttr(java.lang.Class<? extends BOI> clazz, java.lang.String attributeName, java.lang.Object value) Gets one BO by a single Attribute-Value pair.
default BO	getBOByAttr(java.lang.Class<? extends BOI> clazz, java.lang.String attributeName, java.lang.Object value, boolean nullIfNotFound)
default BO	getBOByAttr(java.lang.Class<? extends BOI> clazz, java.lang.String attributeName, java.lang.Object value, boolean nullIfNotFound, boolean ignoreNotUnique)
default BO	getBOByAttrs(java.lang.Class<? extends BOI> clazz, java.lang.String[] attributeNames, java.lang.Object[] values) Calls getBOsByAttrs and returns the first result.
default BO	getBOByAttrs(java.lang.Class<? extends BOI> clazz, java.lang.String[] attributeNames, java.lang.Object[] values, boolean nullIfNotFound)
default BO	getBOByAttrs(java.lang.Class<? extends BOI> clazz, java.lang.String[] attributeNames, java.lang.Object[] values, boolean nullIfNotFound, boolean ignoreNotUnique)
default java.util.List	getBOsByAttrs(java.lang.Class<? extends BOI> clazz, java.lang.String[] attributeNames, java.lang.Object[] values) Looks up a BO by the given attributes.
default java.util.List	getBOsByAttrs(java.lang.Class<? extends BOI> clazz, java.lang.String[] attributeNames, java.lang.Object[] values, boolean[] notValue)
default java.util.List	getBOsByAttrs(java.lang.Class<? extends BOI> clazz, java.lang.String[] attributeNames, java.lang.Object[] values, boolean[] notValue, int limit)
default java.util.List	getBOsByAttrs(java.lang.Class<? extends BOI> clazz, java.lang.String[] attributeNames, java.lang.Object[] values, boolean[] notValue, int limit, java.util.Set<java.lang.Long> excludeBOIds)
default BO	getOneBOByAttr(java.lang.Class<? extends BOI> clazz, java.lang.String attributeName, java.lang.Object values) Looks up a BO by the given attribute or null, if no such BO exists.
default BO	getUniqueBOByAttr(java.lang.Class<? extends BOI> clazz, java.lang.String attributeName, java.lang.Object value) Looks up a BO with a unique attribute-value-pair.
default de.ipcon.db.core.QueryResultsI	query(java.lang.String t) Alias for query(String, Object[]) with no parameters, i.e. an empty Object array.
de.ipcon.db.core.QueryResultsI	query(java.lang.String t, java.lang.Object[] pvals) Query objects in an iterative way to hide backend processing time.
default java.util.List	queryBO(java.lang.String t) Alias for queryBO(String, Object[]) with no parameters, i.e. an empty Object array.
java.util.List	queryBO(java.lang.String t, java.lang.Object[] pvals) Executes a query and returns all results as a List.

Methods inherited from interface de.ipcon.schema.SchemaProviderI

getSchema

Field Detail

$0

static final java.lang.String $0

See Also:

Constant Field Values

Method Detail

query

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

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.

Returns:

QueryResults iterator through the query results.

queryBO

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

Executes a query and returns all results as a List.

See Also:

query(java.lang.String, java.lang.Object[])

query

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

Alias for query(String, Object[]) with no parameters, i.e. an empty Object array.

queryBO

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

Alias for queryBO(String, Object[]) with no parameters, i.e. an empty Object array.

getBOByAttrs

default BO getBOByAttrs(java.lang.Class<? extends BOI> clazz,
                        java.lang.String[] attributeNames,
                        java.lang.Object[] values)

Calls getBOsByAttrs and returns the first result. The result is checked to be unique and not null by default, unless otherwise specified by the parameters explicitly.

Parameters:

class - the clazz of the BO to get

attributeNames - a list of attribute names to check, nonnull.

values - a list of attribute values to check, paired by index with attrs-list, nonnull.

nullIfNotFound - if false (default), then an ObjectForConditionNotFoundException is thrown if no BO matches the provided filter. If true, then this method simply returns null in this case.

ignoreNotUnique - if false (default), then an ObjectForConditionNotUniqueException is thrown if two or more objects match the provided filter. Otherwise, any one of these objects are returned. This method makes no guarantees to return the same object on successive calls in this case.

Returns:

a BO matching the provided filters. Only nullable if nullIfNotFound was set to true. A returned BO is guaranteed to be unique, unless ignoreNotUnique is set to true.

Throws:

ObjectForConditionNotUniqueException - if the given criteria does match more than 1 BO and ignoreNotUnique is false (default)

ObjectForConditionNotFoundException - if the given criteria doesn't match any BO and nullIfNotFound is false (default)

getBOByAttrs

default BO getBOByAttrs(java.lang.Class<? extends BOI> clazz,
                        java.lang.String[] attributeNames,
                        java.lang.Object[] values,
                        boolean nullIfNotFound)

getBOByAttrs

default BO getBOByAttrs(java.lang.Class<? extends BOI> clazz,
                        java.lang.String[] attributeNames,
                        java.lang.Object[] values,
                        boolean nullIfNotFound,
                        boolean ignoreNotUnique)

getBOByAttr

default BO getBOByAttr(java.lang.Class<? extends BOI> clazz,
                       java.lang.String attributeName,
                       java.lang.Object value)

Gets one BO by a single Attribute-Value pair.

See Also:

getBOByAttrs(java.lang.Class, java.lang.String[], java.lang.Object[], boolean, boolean)

getBOByAttr

default BO getBOByAttr(java.lang.Class<? extends BOI> clazz,
                       java.lang.String attributeName,
                       java.lang.Object value,
                       boolean nullIfNotFound)

getBOByAttr

default BO getBOByAttr(java.lang.Class<? extends BOI> clazz,
                       java.lang.String attributeName,
                       java.lang.Object value,
                       boolean nullIfNotFound,
                       boolean ignoreNotUnique)

getUniqueBOByAttr

default BO getUniqueBOByAttr(java.lang.Class<? extends BOI> clazz,
                             java.lang.String attributeName,
                             java.lang.Object value)
                      throws ObjectForConditionNotUniqueException

Looks up a BO with a unique attribute-value-pair.

Parameters:

clazz - the class of the desired BO

attributeName - the name of the attribute, e.g. 'Tid'

value - the value of the attribute which would identify the uniqueness of the wanted BO

Returns:

the desired BO, or null if none was found matching the given criteria

Throws:

ObjectForConditionNotUniqueException - if the given criteria matches more than one BO

getOneBOByAttr

default BO getOneBOByAttr(java.lang.Class<? extends BOI> clazz,
                          java.lang.String attributeName,
                          java.lang.Object values)

Looks up a BO by the given attribute or null, if no such BO exists. In case multiple BOs match the requested parameters, then one of them is returned. If multiple BOs match, then no guarantee on the selected instance is given. i.e. successive calls might return the same or a different BO each time.

Parameters:

clazz - the class of the desired BO

attributeName - the name of the attribute, e.g. 'Tid'

values - the value of the attribute which would identify the wanted BO

Returns:

the first found BO matching the given criteria (whereas 'the first' is not guaranteed to be always the same BO), or null if none was found

getBOsByAttrs

default java.util.List getBOsByAttrs(java.lang.Class<? extends BOI> clazz,
                                     java.lang.String[] attributeNames,
                                     java.lang.Object[] values)

Looks up a BO by the given attributes. Will return all matching BOs until the 'limit' parameter is reached, if it has a value > 0. Only returns BOs that are not deleted, unless Attribute Ldel is explicitly specified as true. Attribute chains can be interpreted as inner joins, i.e. 'Elter.Elter' for persisted attributes. This implies a nonnull value in the first 'Elter'. For non persistent attributes, the default behaviour of SchemaI.getValue(Object, String) is used. If limit > 0, then subsequent calls of this method with identical parameters can return a different set of values each time. Supports lookup by non-persistent attributes by loading all persistently matching BOs and filtering the results during postprocessing. This can cause a significant slowdown and memory pressure, please use non-persistent attributes sparingly.

Parameters:

clazz - the class of the desired BO, nonnull.

attributeNames - the names of the attributes, nonnull

values - the values of the attributes, using the same index, that identify the wanted BO. Nonnull

notValue - if true for a given index, inverts this attrs-values check. (Default: null) If this array is smaller than the attrs parameter, any missing index values are interpreted as "value should be equal".

limit - the maximum number of BOs that are returned. Zero for unlimited, which is the default.

excludeBOIds - exclude the given BOIds during lookup. Nullable.

Returns:

a List containing all BOs of that clazz that fit the filters.

getBOsByAttrs

default java.util.List getBOsByAttrs(java.lang.Class<? extends BOI> clazz,
                                     java.lang.String[] attributeNames,
                                     java.lang.Object[] values,
                                     boolean[] notValue)

getBOsByAttrs

default java.util.List getBOsByAttrs(java.lang.Class<? extends BOI> clazz,
                                     java.lang.String[] attributeNames,
                                     java.lang.Object[] values,
                                     boolean[] notValue,
                                     int limit)

getBOsByAttrs

default java.util.List getBOsByAttrs(java.lang.Class<? extends BOI> clazz,
                                     java.lang.String[] attributeNames,
                                     java.lang.Object[] values,
                                     boolean[] notValue,
                                     int limit,
                                     java.util.Set<java.lang.Long> excludeBOIds)