JpaRepository

java.lang.Object
- me.nunum.whereami.framework.persistence.repositories.impl.jpa.JpaRepository<T,K>

Type Parameters:

T - the entity type that we want to build a repository for

K - the key type of the entity

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Iterable<T>, DeleteableRepository<T,K>, IterableRepository<T,K>, Repository<T,K>

Direct Known Subclasses:

AlgorithmProviderRepositoryJpa, AlgorithmRepositoryJpa, DeviceRepositoryJpa, FeedbackRepositoryJpa, FingerprintRepositoryJpa, LocalizationRepositoryJpa, LocalizationSpamRepositoryJpa, PositionRepositoryJpa, PositionSpamRepositoryJpa, PostRepositoryJpa, PredictionRepositoryJpa, ProviderRepositoryJpa, RoleRepositoryJpa, TaskRepositoryJpa, TrainingRepositoryJpa
```
public abstract class JpaRepository<T,K extends java.io.Serializable>
extends java.lang.Object
implements Repository<T,K>, IterableRepository<T,K>, DeleteableRepository<T,K>, java.lang.AutoCloseable
```
An utility abstract class for implementing JPA repositories.

Field Summary

Fields
Modifier and Type Field and Description

protected static int DEFAULT_PAGE_SIZE

protected static java.util.logging.Logger LOGGER

Fields
Modifier and Type	Field and Description
`protected static int`	`DEFAULT_PAGE_SIZE`
`protected static java.util.logging.Logger`	`LOGGER`

Constructor Summary

Constructors
Constructor and Description

JpaRepository()

Constructors
Constructor and Description
`JpaRepository()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(T entity)` adds and commits a new entity to the persistence store
`java.util.List<T>`	`all()` gets all entities from the repository.
`void`	`close()`
`T`	`create(T entity)` adds a new entity to the persistence store
`void`	`delete(T entity)` removes the object from the persistence storage.
`boolean`	`deleteById(K entityId)` Removes the entity with the specified ID from the repository.
`protected javax.persistence.EntityManager`	`entityManager()`
`protected javax.persistence.EntityManagerFactory`	`entityManagerFactory()`
`java.util.Optional<T>`	`findById(K id)` reads an entity given its K
`java.util.Optional<T>`	`first()`
`java.util.List<T>`	`first(int n)` returns the first n entities according to its "natural" order
`java.util.Iterator<T>`	`iterator()`
`java.util.Iterator<T>`	`iterator(int pagesize)` returns a paged iterator
`T`	`last()`
`java.util.List<T>`	`page(int pageNumber, int pageSize)`
`java.util.List<T>`	`pageWithFiltering(javax.persistence.criteria.CriteriaQuery<T> query, int pageNumber)`
`protected abstract java.lang.String`	`persistenceUnitName()` Derived classes should implement this method to return the name of the persistence unit
`T`	`read(K id)` reads an entity given its K
`T`	`save(T entity)` Inserts or updates an entity and commits.
`long`	`size()` returns the number of entities in the persistence store
`T`	`update(T entity)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - DEFAULT_PAGE_SIZE
```
protected static final int DEFAULT_PAGE_SIZE
```
    See Also:
    
    Constant Field Values
  - LOGGER
```
protected static final java.util.logging.Logger LOGGER
```
- Constructor Detail
  - JpaRepository
```
public JpaRepository()
```
- Method Detail
  - entityManagerFactory
```
protected javax.persistence.EntityManagerFactory entityManagerFactory()
```
  - entityManager
```
protected javax.persistence.EntityManager entityManager()
```
  - create
```
public T create(T entity)
```
    adds a new entity to the persistence store
    
    Parameters:
    
    entity -
    
    Returns:
    
    the newly created persistent object
  - read
```
public T read(K id)
```
    reads an entity given its K
    
    Parameters:
    
    id -
    
    Returns:
  - findById
```
public java.util.Optional<T> findById(K id)
```
    reads an entity given its K
    
    Specified by:
    
    findById in interface Repository<T,K extends java.io.Serializable>
    
    Parameters:
    
    id -
    
    Returns:
  - update
```
public T update(T entity)
```
  - delete
```
public void delete(T entity)
```
    removes the object from the persistence storage. the object reference is still valid but the persisted entity is/will be deleted
    
    Specified by:
    
    delete in interface DeleteableRepository<T,K extends java.io.Serializable>
    
    Specified by:
    
    delete in interface Repository<T,K extends java.io.Serializable>
    
    Parameters:
    
    entity -
  - deleteById
```
public boolean deleteById(K entityId)
```
    Removes the entity with the specified ID from the repository.
    
    Specified by:
    
    deleteById in interface DeleteableRepository<T,K extends java.io.Serializable>
    
    Parameters:
    
    entityId - if the delete operation makes no sense for this repository
  - size
```
public long size()
```
    returns the number of entities in the persistence store
    
    Specified by:
    
    size in interface Repository<T,K extends java.io.Serializable>
    
    Returns:
    
    the number of entities in the persistence store
  - add
```
public boolean add(T entity)
```
    adds and commits a new entity to the persistence store
    
    It is controversial if the repository class should have explicit knowledge of when to start a transaction and end it as well as to know when to open a connection and close it. this is the kind of stuff that the container (e.g., web server) should handle declaratively
    the following methods open and commit a transaction: add() save() replace() remove()
    note that other methods in this class just work with the JPA unit of work and expect the container to begin/commit transactions. they are: create() update() delete()
    
    Specified by:
    
    add in interface Repository<T,K extends java.io.Serializable>
    
    Parameters:
    
    entity -
    
    Returns:
    
    the newly created persistent object
  - close
```
public void close()
           throws java.lang.Exception
```
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.lang.Exception
  - save
```
public T save(T entity)
```
    Inserts or updates an entity and commits.
    note that you should reference the return value to use the persisted entity, as the original object passed as argument might be copied to a new object
    check JPA implementation patterns for a discussion on saveOrUpdate() behavior and merge()
    
    Specified by:
    
    save in interface Repository<T,K extends java.io.Serializable>
    
    Parameters:
    
    entity -
    
    Returns:
    
    the persisted entity - might be a different object than the parameter
  - first
```
public java.util.List<T> first(int n)
```
    returns the first n entities according to its "natural" order
    
    Parameters:
    
    n -
    
    Returns:
  - first
```
public java.util.Optional<T> first()
```
  - last
```
public T last()
```
  - page
```
public java.util.List<T> page(int pageNumber,
                              int pageSize)
```
  - iterator
```
public java.util.Iterator<T> iterator(int pagesize)
```
    returns a paged iterator
    
    Specified by:
    
    iterator in interface IterableRepository<T,K extends java.io.Serializable>
    
    Parameters:
    
    pagesize -
    
    Returns:
  - pageWithFiltering
```
public java.util.List<T> pageWithFiltering(javax.persistence.criteria.CriteriaQuery<T> query,
                                           int pageNumber)
```
  - iterator
```
public java.util.Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<T>
  - all
```
public java.util.List<T> all()
```
    Description copied from interface: Repository
    
    gets all entities from the repository.
    
    Specified by:
    
    all in interface Repository<T,K extends java.io.Serializable>
    
    Returns:
  - persistenceUnitName
```
protected abstract java.lang.String persistenceUnitName()
```
    Derived classes should implement this method to return the name of the persistence unit
    
    Returns:
    
    Name of the persistence unit

Class JpaRepository<T,K extends java.io.Serializable>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

DEFAULT_PAGE_SIZE

LOGGER

Constructor Detail

JpaRepository

Method Detail

entityManagerFactory

entityManager

create

read

findById

update

delete

deleteById

size

add

close

save

first

first

last

page

iterator

pageWithFiltering

iterator

all

persistenceUnitName