Package org.primefaces.model

Class JPALazyDataModel<T>

java.lang.Object

javax.faces.model.DataModel<T>

org.primefaces.model.LazyDataModel<T>

org.primefaces.model.JPALazyDataModel<T>

Type Parameters:

T - The model class.

All Implemented Interfaces:

Serializable, Iterable<T>, SelectableDataModel<T>

public class JPALazyDataModel<T>
extends LazyDataModel<T>
implements Serializable

Basic LazyDataModel implementation with JPA and Criteria API.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JPALazyDataModel.Builder<T>
static interface	JPALazyDataModel.FilterEnricher<T>
static interface	JPALazyDataModel.QueryEnricher<T>
static interface	JPALazyDataModel.SortEnricher<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	caseSensitive
protected Class<T>	entityClass
protected Callbacks.SerializableSupplier<javax.persistence.EntityManager>	entityManager
protected JPALazyDataModel.FilterEnricher<T>	filterEnricher
protected JPALazyDataModel.QueryEnricher<T>	queryEnricher
protected Callbacks.SerializableConsumer<List<T>>	resultEnricher
protected String	rowKeyField
protected Callbacks.SerializableFunction<T,Object>	rowKeyProvider
protected Class<?>	rowKeyType
protected JPALazyDataModel.SortEnricher<T>	sortEnricher
protected boolean	wildcardSupport

Fields inherited from class org.primefaces.model.LazyDataModel

rowKeyConverter

Constructor Summary

Constructors

Constructor	Description
JPALazyDataModel()	For serialization only

Method Summary

Modifier and Type	Method	Description
protected void	applyFilters(javax.persistence.criteria.CriteriaBuilder cb, javax.persistence.criteria.CriteriaQuery<?> cq, javax.persistence.criteria.Root<T> root, Map<String,FilterMeta> filterBy)
protected void	applyGlobalFilters(Map<String,FilterMeta> filterBy, javax.persistence.criteria.CriteriaBuilder cb, javax.persistence.criteria.CriteriaQuery<?> cq, javax.persistence.criteria.Root<T> root, List<javax.persistence.criteria.Predicate> predicates)	Deprecated. use the builder and filterEnricher instead
protected void	applySort(javax.persistence.criteria.CriteriaBuilder cb, javax.persistence.criteria.CriteriaQuery<T> cq, javax.persistence.criteria.Root<T> root, Map<String,SortMeta> sortBy)
static <T> JPALazyDataModel.Builder<T>	builder()
int	count(Map<String,FilterMeta> filterBy)	Counts the all available data for the given filters.
protected javax.persistence.criteria.Predicate	createPredicate(FilterMeta filter, PropertyDescriptor pd, javax.persistence.criteria.Root<T> root, javax.persistence.criteria.CriteriaBuilder cb, javax.persistence.criteria.Expression fieldExpression, Object filterValue, Locale locale)
T	getRowData(String rowKey)
String	getRowKey(T obj)
protected String	getStringFilterValue(Object filterValue, Locale locale)
List<T>	load(int first, int pageSize, Map<String,SortMeta> sortBy, Map<String,FilterMeta> filterBy)	Loads the data for the given parameters.
protected javax.persistence.criteria.Expression	resolveFieldExpression(javax.persistence.criteria.CriteriaBuilder cb, javax.persistence.criteria.CriteriaQuery<?> cq, javax.persistence.criteria.Root<T> root, String fieldName)

Methods inherited from class org.primefaces.model.LazyDataModel

getMessage, getPageSize, getRowCount, getRowData, getRowIndex, getRowKeyFromConverter, getWrappedData, isRowAvailable, iterator, iterator, loadOne, recalculateFirst, setPageSize, setRowCount, setRowIndex, setWrappedData

Methods inherited from class javax.faces.model.DataModel

addDataModelListener, getDataModelListeners, removeDataModelListener

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 Details

entityClass

protected Class<T> entityClass

rowKeyField

protected String rowKeyField

caseSensitive

protected boolean caseSensitive

wildcardSupport

protected boolean wildcardSupport

rowKeyType

protected Class<?> rowKeyType

queryEnricher

protected JPALazyDataModel.QueryEnricher<T> queryEnricher

filterEnricher

protected JPALazyDataModel.FilterEnricher<T> filterEnricher

sortEnricher

protected JPALazyDataModel.SortEnricher<T> sortEnricher

entityManager

protected Callbacks.SerializableSupplier<javax.persistence.EntityManager> entityManager

rowKeyProvider

protected Callbacks.SerializableFunction<T,Object> rowKeyProvider

resultEnricher

protected Callbacks.SerializableConsumer<List<T>> resultEnricher

Constructor Details

JPALazyDataModel

public JPALazyDataModel()

For serialization only

Method Details

count

public int count(Map<String,FilterMeta> filterBy)

Description copied from class: LazyDataModel

Counts the all available data for the given filters. In case of SQL, this would execute a "SELECT COUNT ... WHERE ...". In case you dont use SQL and receive both rowCount and data within a single call, this method should just return 0. You must call LazyDataModel.recalculateFirst(int, int, int) and LazyDataModel.setRowCount(int) in your LazyDataModel.load(int, int, java.util.Map, java.util.Map) method.

Specified by:

count in class LazyDataModel<T>

Parameters:

filterBy - a map with all filter information (only relevant for DataTable, not for eg DataView)

Returns:

the data count

load

public List<T> load(int first,
 int pageSize,
 Map<String,SortMeta> sortBy,
 Map<String,FilterMeta> filterBy)

Description copied from class: LazyDataModel

Loads the data for the given parameters.

Specified by:

load in class LazyDataModel<T>

Parameters:

first - the first entry

pageSize - the page size

sortBy - a map with all sort information (only relevant for DataTable, not for eg DataView)

filterBy - a map with all filter information (only relevant for DataTable, not for eg DataView)

Returns:

the data

applyFilters

protected void applyFilters(javax.persistence.criteria.CriteriaBuilder cb,
 javax.persistence.criteria.CriteriaQuery<?> cq,
 javax.persistence.criteria.Root<T> root,
 Map<String,FilterMeta> filterBy)

applyGlobalFilters

@Deprecated
protected void applyGlobalFilters(Map<String,FilterMeta> filterBy,
 javax.persistence.criteria.CriteriaBuilder cb,
 javax.persistence.criteria.CriteriaQuery<?> cq,
 javax.persistence.criteria.Root<T> root,
 List<javax.persistence.criteria.Predicate> predicates)

Deprecated.

use the builder and filterEnricher instead

createPredicate

protected javax.persistence.criteria.Predicate createPredicate(FilterMeta filter,
 PropertyDescriptor pd,
 javax.persistence.criteria.Root<T> root,
 javax.persistence.criteria.CriteriaBuilder cb,
 javax.persistence.criteria.Expression fieldExpression,
 Object filterValue,
 Locale locale)

getStringFilterValue

protected String getStringFilterValue(Object filterValue,
 Locale locale)

applySort

protected void applySort(javax.persistence.criteria.CriteriaBuilder cb,
 javax.persistence.criteria.CriteriaQuery<T> cq,
 javax.persistence.criteria.Root<T> root,
 Map<String,SortMeta> sortBy)

resolveFieldExpression

protected javax.persistence.criteria.Expression resolveFieldExpression(javax.persistence.criteria.CriteriaBuilder cb,
 javax.persistence.criteria.CriteriaQuery<?> cq,
 javax.persistence.criteria.Root<T> root,
 String fieldName)

getRowData

public T getRowData(String rowKey)

Specified by:

getRowData in interface SelectableDataModel<T>

Overrides:

getRowData in class LazyDataModel<T>

getRowKey

public String getRowKey(T obj)

Specified by:

getRowKey in interface SelectableDataModel<T>

Overrides:

getRowKey in class LazyDataModel<T>

builder

public static <T> JPALazyDataModel.Builder<T> builder()