io.jmix.core.repository

Interface JmixDataRepository<T,ID>

Type Parameters:

T - the domain type the repository manages

ID - the type of the id of the entity the repository manages

All Superinterfaces:

org.springframework.data.repository.CrudRepository<T,ID>, org.springframework.data.repository.PagingAndSortingRepository<T,ID>, org.springframework.data.repository.Repository<T,ID>

All Known Implementing Classes:

JmixDataRepositoryImpl

@NoRepositoryBean
public interface JmixDataRepository<T,ID>
extends org.springframework.data.repository.PagingAndSortingRepository<T,ID>

Central Jmix data repository interface.

Extends functionality of PagingAndSortingRepository by adding FetchPlan parameters to common methods and providing other Jmix-specific methods

See Also:

PagingAndSortingRepository

Method Summary

Modifier and Type	Method and Description
T	create() Instantiate an entity.
java.lang.Iterable<T>	findAll(FetchPlan fetchPlan) Returns all instances of the type T loaded according to fetchPlan
java.lang.Iterable<T>	findAll(java.lang.Iterable<ID> ids, FetchPlan fetchPlan) Returns all instances of the type T with the given IDs loaded according to fetchPlan
org.springframework.data.domain.Page<T>	findAll(org.springframework.data.domain.Pageable pageable, FetchPlan fetchPlan) Returns a Page of entities meeting the paging restriction provided in the Pageable object.
java.lang.Iterable<T>	findAll(org.springframework.data.domain.Sort sort, FetchPlan fetchPlan) Returns all entities sorted by the given options and loaded by specified FetchPlan.
java.util.Optional<T>	findById(ID id, FetchPlan fetchPlan) Loads an entity by its id according to fetchPlan
T	getById(ID id, FetchPlan fetchPlan) Loads an entity by its id according to fetchPlan

Methods inherited from interface org.springframework.data.repository.PagingAndSortingRepository

findAll, findAll

Methods inherited from interface org.springframework.data.repository.CrudRepository

count, delete, deleteAll, deleteAll, deleteAllById, deleteById, existsById, findAll, findAllById, findById, save, saveAll

Method Detail

create

T create()

Instantiate an entity. Invokes Metadata.create(Class)

Returns:

new instance of <T>.

findById

java.util.Optional<T> findById(ID id,
                               FetchPlan fetchPlan)

Loads an entity by its id according to fetchPlan

Parameters:

id - must not be null.

Returns:

the entity with the given id or Optional#empty() if none found.

getById

T getById(ID id,
          FetchPlan fetchPlan)

Loads an entity by its id according to fetchPlan

Parameters:

id - must not be null.

Returns:

the entity with the given id

Throws:

java.lang.IllegalStateException - if nothing was loaded

findAll

java.lang.Iterable<T> findAll(FetchPlan fetchPlan)

Returns all instances of the type T loaded according to fetchPlan

Returns:

all entities

findAll

java.lang.Iterable<T> findAll(java.lang.Iterable<ID> ids,
                              @Nullable
                              FetchPlan fetchPlan)

Returns all instances of the type T with the given IDs loaded according to fetchPlan

If some or all ids are not found, no entities are returned for these IDs.

Parameters:

fetchPlan - defines entity graph to load. FetchPlan#BASE will be used instead in case of null.

ids - must not be null nor contain any null values.

Returns:

guaranteed to be not null. The size can be equal or less than the number of given ids.

Throws:

java.lang.IllegalArgumentException - in case the given ids or one of its items is null.

findAll

java.lang.Iterable<T> findAll(org.springframework.data.domain.Sort sort,
                              @Nullable
                              FetchPlan fetchPlan)

Returns all entities sorted by the given options and loaded by specified FetchPlan.

Parameters:

fetchPlan - to load entity. FetchPlan#BASE will be used if fetchPlan == null

Returns:

all entities sorted by the given options

findAll

org.springframework.data.domain.Page<T> findAll(org.springframework.data.domain.Pageable pageable,
                                                @Nullable
                                                FetchPlan fetchPlan)

Returns a Page of entities meeting the paging restriction provided in the Pageable object. Entities will be loaded according to passed fetchPlan

Parameters:

fetchPlan - to load entities. FetchPlan#BASE will be used if fetchPlan == null

Returns:

a page of entities