io.requery

Interface EntityStore<T,R>

Type Parameters:

T - the base class or interface to restrict all entities that are stored to (e.g. Persistable or Object or Serializable for instance. The purpose is to aid in the prevention of runtime errors by restricting the types at compile time.

R - the operation return type. For an asynchronous implementation may return a Future or other type of promise representing the result of the operation.

All Superinterfaces:

AutoCloseable, Queryable<T>

All Known Subinterfaces:

BlockingEntityStore<T>, CompletionStageEntityStore<T>

All Known Implementing Classes:

CompletableEntityStore, EntityDataStore, ReactiveEntityStore, ReactorEntityStore, SingleEntityStore

public interface EntityStore<T,R>
extends Queryable<T>, AutoCloseable

The primary interface for interacting with Entity objects. This interface supports the basic insert/update/delete operations.

Method Summary

Modifier and Type	Method and Description
void	close() Close the entity store.
<E extends T> R	delete(E entity) Deletes the given entity from the store.
<E extends T> R	delete(Iterable<E> entities) Deletes multiple entities.
<E extends T,K> R	findByKey(Class<E> type, K key) Find an entity by the given key.
<E extends T> R	insert(E entity) Inserts the given entity.
<K,E extends T> R	insert(E entity, Class<K> keyClass) Inserts the given entity returning the generated key after the entity is inserted.
<E extends T> R	insert(Iterable<E> entities) Insert a collection of entities.
<K,E extends T> R	insert(Iterable<E> entities, Class<K> keyClass) Insert a collection of entities returning the generated keys for the inserted entities in the order they were inserted.
<E extends T> R	refresh(E entity) Refresh the given entity.
<E extends T> R	refresh(E entity, Attribute<?,?>... attributes) Refresh the given entity on specific attributes.
<E extends T> R	refresh(Iterable<E> entities, Attribute<?,?>... attributes) Refresh the given entities on specific attributes.
<E extends T> R	refreshAll(E entity) Refresh the given entity on all of its attributes including relational ones.
BlockingEntityStore<T>	toBlocking()
<E extends T> R	update(E entity) Update the given entity.
<E extends T> R	update(E entity, Attribute<?,?>... attributes) Update specific attributes of entity regardless of any modification state.
<E extends T> R	update(Iterable<E> entities) Updates a collection of entities.
<E extends T> R	upsert(E entity) Upserts (insert or update) the given entity.
<E extends T> R	upsert(Iterable<E> entities) Upserts (inserts or updates) a collection of entities.

Methods inherited from interface io.requery.Queryable

count, count, delete, delete, insert, raw, raw, select, select, select, select, update, update

Method Detail

close

void close()

Close the entity store. After close has been called all methods and any open Result instances may throw a PersistenceException.

Specified by:

close in interface AutoCloseable

insert

<E extends T> R insert(E entity)

Inserts the given entity. This entity must not have previously been inserted otherwise an PersistenceException may be thrown.

Type Parameters:

E - entity type

Parameters:

entity - non null entity to insert

Returns:

the operation result.

insert

<E extends T> R insert(Iterable<E> entities)

Insert a collection of entities. This method may perform additional optimizations not present in the single element insert method.

Type Parameters:

E - entity type

Parameters:

entities - to insert

Returns:

the operation result.

insert

<K,E extends T> R insert(E entity,
                         Class<K> keyClass)

Inserts the given entity returning the generated key after the entity is inserted. This entity must not have previously been inserted otherwise an PersistenceException may be thrown.

Type Parameters:

K - key type

E - entity type

Parameters:

entity - non null entity to insert

keyClass - key class

Returns:

the operation result.

insert

<K,E extends T> R insert(Iterable<E> entities,
                         Class<K> keyClass)

Insert a collection of entities returning the generated keys for the inserted entities in the order they were inserted.

Type Parameters:

K - key type

E - entity type

Parameters:

entities - to insert

keyClass - key class

Returns:

the operation result.

update

<E extends T> R update(E entity)

Update the given entity. If the given entity has modified properties those changes will be persisted otherwise the method will do nothing. A property is considered modified if its associated setter has been called, modifying the state of a property's content will not cause an update to happen.

Type Parameters:

E - entity type

Parameters:

entity - to update

Returns:

the operation result.

update

<E extends T> R update(Iterable<E> entities)

Updates a collection of entities. This method may perform additional optimizations not present in the single element update method.

Type Parameters:

E - entity type

Parameters:

entities - to update

Returns:

the operation result.

update

<E extends T> R update(E entity,
                       Attribute<?,?>... attributes)

Update specific attributes of entity regardless of any modification state.

Type Parameters:

E - entity type

Parameters:

entity - to refresh

attributes - attributes to update, attributes should be of type E

Returns:

the operation result.

upsert

<E extends T> R upsert(E entity)

Upserts (insert or update) the given entity. Note that upserting may be an expensive operation on some platforms and may not be supported in all cases or platforms.

Type Parameters:

E - entity type

Parameters:

entity - non null entity to insert

Returns:

the operation result.

upsert

<E extends T> R upsert(Iterable<E> entities)

Upserts (inserts or updates) a collection of entities. This method may perform additional optimizations not present in the single upsert method.

Type Parameters:

E - entity type

Parameters:

entities - to update

Returns:

the operation result.

refresh

<E extends T> R refresh(E entity)

Refresh the given entity. This refreshes the already loaded properties in the entity. If no properties are loaded then the default properties will be loaded.

Type Parameters:

E - entity type

Parameters:

entity - to insert

Returns:

the operation result.

refresh

<E extends T> R refresh(E entity,
                        Attribute<?,?>... attributes)

Refresh the given entity on specific attributes.

Type Parameters:

E - entity type

Parameters:

entity - to refresh

attributes - attributes to refresh, attributes should be of type E (not enforced due to erasure)

Returns:

the operation result.

refresh

<E extends T> R refresh(Iterable<E> entities,
                        Attribute<?,?>... attributes)

Refresh the given entities on specific attributes.

Type Parameters:

E - entity type

Parameters:

entities - to refresh

attributes - attributes to refresh, attributes should be of type E (not enforced due to erasure)

Returns:

the operation result.

refreshAll

<E extends T> R refreshAll(E entity)

Refresh the given entity on all of its attributes including relational ones.

Type Parameters:

E - entity type

Parameters:

entity - to refresh

Returns:

the operation result.

delete

<E extends T> R delete(E entity)

Deletes the given entity from the store.

Type Parameters:

E - entity type.

Parameters:

entity - to delete

Returns:

the operation result.

delete

<E extends T> R delete(Iterable<E> entities)

Deletes multiple entities.

Type Parameters:

E - entity type

Parameters:

entities - to delete

Returns:

the operation result.

findByKey

@CheckReturnValue
<E extends T,K> R findByKey(Class<E> type,
                                              K key)

Find an entity by the given key. This differs from selecting the key using a query in that the EntityCache if available may be checked first for the object. If an entity is found in the cache it will be returned and potentially no query will be made.

Type Parameters:

E - entity type

K - key type

Parameters:

type - non null entity class type

key - non null key value

Returns:

an operation returning the entity if found.

toBlocking

@CheckReturnValue
BlockingEntityStore<T> toBlocking()

Returns:

a BlockingEntityStore version of this entity store. If the implementation is already blocking may return itself.