net.runeduniverse.lib.rogm

Interface Session

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

SessionWrapper

public interface Session
extends AutoCloseable

The Session Interface provides access to the connected database.

A Session can be created either by invoking the default DatabasePipelineFactory through create(Configuration) or by initializeing it through a Pipeline.

In any case it may require you to provide you a Configuration, it is recommended to use the Configuration provided with the Database-Module you wish to use (usually prefixed with the Database-Name).

Author:

Pl4yingNight

Method Summary

Modifier and Type	Method and Description
static Session	create(Configuration cnf) Creates a simple Session for direct interaction with a database.
void	delete(Object entity) Deletes the provided Object.
void	deleteAll(Collection<? extends Object> entities) Deletes all provided values of Collection entities.
QueryBuilder	getQueryBuilder() Provides the configured QueryBuilder for the use in custom queries
boolean	isConnected() Provides information of the connection-status.
<T,ID extends Serializable> T	load(Class<T> type, ID id) Loads the Object of Class matching the provided id.
<T,ID extends Serializable> T	load(Class<T> type, ID id, Integer depth) Loads the Object of Class matching the provided id.
<T> T	load(IFilter filter) Deprecated. may not return the Object of the correct Class
<T> Collection<T>	loadAll(Class<T> type) Deprecated. discouraged from using - needlessly fills up RAM
<T,ID extends Serializable> Collection<T>	loadAll(Class<T> type, ID id) Loads all Objects of Class matching the provided id.
<T,ID extends Serializable> Collection<T>	loadAll(Class<T> type, ID id, Integer depth) Loads all Objects of Class matching the provided id.
<T> Collection<T>	loadAll(Class<T> type, Integer depth) Deprecated. discouraged from using - needlessly fills up RAM
<T> Collection<T>	loadAll(IFilter filter) Deprecated. may not return the Object of the correct Class
<T> Collection<T>	loadAllLazy(Class<T> type) Deprecated. discouraged from using - needlessly fills up RAM
<T,ID extends Serializable> Collection<T>	loadAllLazy(Class<T> type, ID id) Lazy-Loads all Objects of Class matching the provided id.
<T,ID extends Serializable> T	loadLazy(Class<T> type, ID id) Lazy-Loads the Object of Class matching the provided id.
void	reload(Object entity) Reloads the Values and Relations of entity.
void	reload(Object entity, Integer depth) Reloads the Values and Relations of entity.
void	reloadAll(Collection<? extends Object> entities) Reloads the Values and Relations of Collection entities.
void	reloadAll(Collection<? extends Object> entities, Integer depth) Reloads the Values and Relations of Collection entities.
void	resolveAllLazyLoaded(Collection<? extends Object> entities) Loads all Relations provided by values of Collection entities.
void	resolveAllLazyLoaded(Collection<? extends Object> entities, Integer depth) Loads all Relations provided by values of Collection entities.
void	resolveLazyLoaded(Object entity) Loads all Relations provided by entity.
void	resolveLazyLoaded(Object entity, Integer depth) Loads all Relations provided by entity.
void	save(Object entity) Saves the provided Object.
void	save(Object entity, Integer depth) Saves the provided Object.
void	saveAll(Collection<? extends Object> entities) Saves all provided values of Collection entities.
void	saveAll(Collection<? extends Object> entities, Integer depth) Saves the provided values of Collection entities.
void	saveAllLazy(Collection<? extends Object> entities) Saves the provided values of Collection entities without saving any Relations.
void	saveLazy(Object entity) Saves the provided Object without any Relations.
void	unload(Object entity) Unloades the provided Object.
void	unloadAll(Collection<? extends Object> entities) Unloades all provided values of Collection entities.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

isConnected

boolean isConnected()

Provides information of the connection-status.

Returns:

status of the database connection

load

<T,ID extends Serializable> T load(Class<T> type,
                                   ID id)

Loads the Object of Class matching the provided id. In case the Object is still buffered the reference will be returned. Returns null in case no Object could be loaded.

Type Parameters:

T - Model-Class provided through the Config

ID - Serializable Object

Parameters:

type - requested Type

id - requested entity-id

Returns:

null, new or buffered Object of the defined type

load

<T,ID extends Serializable> T load(Class<T> type,
                                   ID id,
                                   Integer depth)

Loads the Object of Class matching the provided id. In case the Object is still buffered the reference will be returned. Returns null in case no Object could be loaded.

Depth defines how often the requested Objects Relations will be loaded recursively. 0 will load the Object without any Relations (LAZY).

Type Parameters:

T - Model-Class provided through the Config

ID - Serializable Object

Parameters:

type - requested Type

id - requested entity-id

depth - requested load depth

Returns:

null, new or buffered Object of the defined type

loadLazy

<T,ID extends Serializable> T loadLazy(Class<T> type,
                                       ID id)

Lazy-Loads the Object of Class matching the provided id. Except the Object is still buffered the buffered reference (LAZY or not) will be returned. Returns null in case no Object could be loaded.

Type Parameters:

T - Model-Class provided through the Config

ID - Serializable Object

Parameters:

type - requested Type

id - requested entity-id

Returns:

null, new or buffered Object of the defined type

See Also:

load(Class, Serializable, Integer)

load

<T> T load(IFilter filter)

Deprecated. may not return the Object of the correct Class

Loads the first Object defined through the IFilter Object. Returns null in case the Filter had no loadedable results.

In case of use it is recommended to build the Filter with the QueryBuilder acquirable through getQueryBuilder().

Type Parameters:

T - Model-Class provided through the Config

Parameters:

filter - Custom-Filter

Returns:

null, new or buffered Object defined through the IFilter Object

loadAll

<T,ID extends Serializable> Collection<T> loadAll(Class<T> type,
                                                  ID id)

Loads all Objects of Class matching the provided id. In case an Object is still buffered the reference will be returned. Returns an empty Collection in case no Objects could be loaded.

Type Parameters:

T - Model-Class provided through the Config

ID - Serializable Object

Parameters:

type - requested Type

id - requested entity-id

Returns:

Collection with none, new or buffered Objects of the defined type

loadAll

<T,ID extends Serializable> Collection<T> loadAll(Class<T> type,
                                                  ID id,
                                                  Integer depth)

Loads all Objects of Class matching the provided id. In case an Object is still buffered the reference will be returned. Returns an empty Collection in case no Objects could be loaded.

Depth defines how often the requested Objects Relations will be loaded recursively. 0 will load the Object without any Relations (LAZY).

Type Parameters:

T - Model-Class provided through the Config

ID - Serializable Object

Parameters:

type - requested Type

id - requested entity-id

depth - requested load depth

Returns:

Collection with none, new or buffered Objects of the defined type

loadAllLazy

<T,ID extends Serializable> Collection<T> loadAllLazy(Class<T> type,
                                                      ID id)

Lazy-Loads all Objects of Class matching the provided id. Except the Object is still buffered the buffered reference (LAZY or not) will be returned. Returns an empty Collection in case no Objects could be loaded.

Type Parameters:

T - Model-Class provided through the Config

ID - Serializable Object

Parameters:

type - requested Type

id - requested entity-id

Returns:

Collection with none, new or buffered Objects of the defined type

See Also:

loadAll(Class, Serializable, Integer)

loadAll

<T> Collection<T> loadAll(Class<T> type)

Deprecated. discouraged from using - needlessly fills up RAM

Loads all Objects of Class. In case an Object is still buffered the reference will be returned. Returns an empty Collection in case no Objects could be loaded.

Type Parameters:

T - Model-Class provided through the Config

Parameters:

type - requested Type

Returns:

Collection with none, new or buffered Objects of the defined type

loadAll

<T> Collection<T> loadAll(Class<T> type,
                          Integer depth)

Deprecated. discouraged from using - needlessly fills up RAM

Loads all Objects of Class. In case an Object is still buffered the reference will be returned. Returns an empty Collection in case no Objects could be loaded.

Depth defines how often the requested Objects Relations will be loaded recursively. 0 will load the Object without any Relations (LAZY).

Type Parameters:

T - Model-Class provided through the Config

Parameters:

type - requested Type

depth - requested load depth

Returns:

Collection with none, new or buffered Objects of the defined type

loadAllLazy

<T> Collection<T> loadAllLazy(Class<T> type)

Deprecated. discouraged from using - needlessly fills up RAM

Lazy-Loads all Objects of Class. Except the Object is still buffered the buffered reference (LAZY or not) will be returned. Returns an empty Collection in case no Objects could be loaded.

Type Parameters:

T - Model-Class provided through the Config

Parameters:

type - requested Type

Returns:

Collection with none, new or buffered Objects of the defined type

See Also:

loadAll(Class, Integer)

loadAll

<T> Collection<T> loadAll(IFilter filter)

Deprecated. may not return the Object of the correct Class

Loads all Objects defined through the IFilter Object. Returns an empty Collection in case no Objects could be loaded.

In case of use it is recommended to build the Filter with the QueryBuilder acquirable through getQueryBuilder().

Type Parameters:

T - Model-Class provided through the Config

Parameters:

filter - Custom-Filter

Returns:

Collection with none, new or buffered Objects defined through the IFilter Object

resolveLazyLoaded

void resolveLazyLoaded(Object entity)

Loads all Relations provided by entity.

Parameters:

entity - Object of Model-Class provided through the Config

resolveLazyLoaded

void resolveLazyLoaded(Object entity,
                       Integer depth)

Loads all Relations provided by entity.

Depth defines how often the requested Objects Relations will be loaded recursively. 0 will load the Object without any Relations (LAZY).

Parameters:

entity - Object of Model-Class provided through the Config

depth - requested load depth

resolveAllLazyLoaded

void resolveAllLazyLoaded(Collection<? extends Object> entities)

Loads all Relations provided by values of Collection entities.

Parameters:

entities - Collection with Objects of Model-Classes provided through the Config

resolveAllLazyLoaded

void resolveAllLazyLoaded(Collection<? extends Object> entities,
                          Integer depth)

Loads all Relations provided by values of Collection entities.

Depth defines how often the requested Objects Relations will be loaded recursively. 0 will load the Object without any Relations (LAZY).

Parameters:

entities - Collection with Objects of Model-Classes provided through the Config

depth - requested load depth

reload

void reload(Object entity)

Reloads the Values and Relations of entity.

Parameters:

entity - entity Object of Model-Class provided through the Config

reload

void reload(Object entity,
            Integer depth)

Reloads the Values and Relations of entity.

Depth defines how often the requested Objects Relations will be loaded recursively. 0 will only reload the Values and skip reloading any Relations.

Parameters:

entity - entity Object of Model-Class provided through the Config

depth - requested reload depth

reloadAll

void reloadAll(Collection<? extends Object> entities)

Reloads the Values and Relations of Collection entities.

Parameters:

entities - Collection of Model-Classes provided through the Config

reloadAll

void reloadAll(Collection<? extends Object> entities,
               Integer depth)

Reloads the Values and Relations of Collection entities.

Depth defines how often the requested Objects Relations will be loaded recursively. 0 will only reload the Values and skip reloading any Relations.

Parameters:

entities - Collection with Collection of Model-Classes provided through the Config

depth - requested reload depth

save

void save(Object entity)

Saves the provided Object.

Parameters:

entity - Object of Model-Class provided through the Config

save

void save(Object entity,
          Integer depth)

Saves the provided Object.

Depth defines how many of the Object's Relations will be saved recursively. 0 will save the Object without saving any Relations.

Parameters:

entity - Object of Model-Class provided through the Config

depth - requested load depth

saveLazy

void saveLazy(Object entity)

Saves the provided Object without any Relations.

Parameters:

entity - Object of Model-Class provided through the Config

See Also:

save(Object, Integer)

saveAll

void saveAll(Collection<? extends Object> entities)

Saves all provided values of Collection entities.

Parameters:

entities - Collection of Objects of Model-Classes provided through the Config

saveAll

void saveAll(Collection<? extends Object> entities,
             Integer depth)

Saves the provided values of Collection entities.

Depth defines how many of the Object's Relations will be saved recursively. 0 will save the Object without saving any Relations.

Parameters:

entities - Collection of Objects of Model-Classes provided through the Config

depth - requested load depth

saveAllLazy

void saveAllLazy(Collection<? extends Object> entities)

Saves the provided values of Collection entities without saving any Relations.

Parameters:

entities - Collection of Objects of Model-Classes provided through the Config

See Also:

saveAll(Collection, Integer)

delete

void delete(Object entity)

Deletes the provided Object.

Parameters:

entity - Object of Model-Class provided through the Config

deleteAll

void deleteAll(Collection<? extends Object> entities)

Deletes all provided values of Collection entities.

Parameters:

entities - Collection of Objects of Model-Classes provided through the Config

unload

void unload(Object entity)

Unloades the provided Object.

(Removes the provided Object and all Relations from the Buffer)

Parameters:

entity - Object of Model-Class provided through the Config

unloadAll

void unloadAll(Collection<? extends Object> entities)

Unloades all provided values of Collection entities.

(Removes all provided values of Collection entities and all fo their Relations from the Buffer)

Parameters:

entities - Collection of Objects of Model-Classes provided through the Config

getQueryBuilder

QueryBuilder getQueryBuilder()

Provides the configured QueryBuilder for the use in custom queries

Returns:

configured QueryBuilder instance

create

static Session create(Configuration cnf)
               throws Exception

Creates a simple Session for direct interaction with a database.

The Configuration cnf should be use the Configuration provided with the Database-Module you wish to use (usually prefixed with the Database-Name).

Parameters:

cnf - Configuration of the database

Returns:

Session for direct interaction with a database

Throws:

Exception - re-throws any Exception that might accure during Pipeline creation.