io.coodoo.framework.listing.boundary

Class Listing

java.lang.Object

io.coodoo.framework.listing.boundary.Listing

public class Listing
extends Object

Author:

coodoo GmbH (coodoo.io)

Constructor Summary

Constructors

Constructor and Description
Listing()

Method Summary

Modifier and Type	Method and Description
static <T> Long	countListing(javax.persistence.EntityManager entityManager, Class<T> entityClass, Integer page, Integer limit) Gets the count of the found instances of the target entity
static <T> Long	countListing(javax.persistence.EntityManager entityManager, Class<T> entityClass, Integer page, Integer limit, String sortAttribute) Gets the count of the found instances of the target entity
static <T> Long	countListing(javax.persistence.EntityManager entityManager, Class<T> entityClass, ListingParameters parameters) Gets the count of the found instances of the target entity
static <T> List<T>	getListing(javax.persistence.EntityManager entityManager, Class<T> entityClass, Integer page, Integer limit) Gets the list of found instances
static <T> List<T>	getListing(javax.persistence.EntityManager entityManager, Class<T> entityClass, Integer page, Integer limit, String sortAttribute) Gets the list of found instances
static <T> List<T>	getListing(javax.persistence.EntityManager entityManager, Class<T> entityClass, ListingParameters parameters) Gets the list of found instances
static <T> ListingResult<T>	getListingResult(javax.persistence.EntityManager entityManager, Class<T> entityClass, Integer page, Integer limit) Gets the listing result
static <T> ListingResult<T>	getListingResult(javax.persistence.EntityManager entityManager, Class<T> entityClass, Integer page, Integer limit, String sortAttribute) Gets the listing result
static <T> ListingResult<T>	getListingResult(javax.persistence.EntityManager entityManager, Class<T> entityClass, ListingParameters parameters) Gets the listing result URL query parameters filter: The filter value gets applied to every column of the table.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Listing

public Listing()

Method Detail

getListingResult

public static <T> ListingResult<T> getListingResult(javax.persistence.EntityManager entityManager,
                                                    Class<T> entityClass,
                                                    ListingParameters parameters)

Gets the listing result

URL query parameters

• filter: The filter value gets applied to every column of the table. Every row where a column matches this filter will be part of the result (disjunctive). It can be used as a sort of global search on a Table.
• filter-xxx: filter attributes where xxx is the row name (attribute of the target entity) and the filter value the filter for that row. Every row where all filter attributes matches will be part of the result (conjunctive).
• sort: Given a row name will sort the result in ascending order, to get a descending sorted result a the row name must start with "-"

Pagination

• limit: Amount of maximal expected results per request to fit on a page (default = 10)
• page: Current page (default = 1)
• index: Index (default = 0)

Type Parameters:

T - type of target entity class

Parameters:

entityManager - entity manager of designated persistence unit

entityClass - target entity class

parameters - defines the listing queue. It contains optional query parameters as described above

Returns:

a ListingResult object containing metadata and the resulting list of the target entity instances (sublist in case of pagination)

Metadata

• count: Amount of matching results
• currentPage: Current page (pagination)
• numPages: Amount of available pages (pagination)
• limit: Amount of given result for the current page, see list results (pagination, if 0 then there is no limit)
• sort: Current order by this row (ascending except if it starts with "-" = descending)
• startIndex: Index of the first result in this page (pagination)
• endIndex: Index of the last result in this page (pagination)

getListing

public static <T> List<T> getListing(javax.persistence.EntityManager entityManager,
                                     Class<T> entityClass,
                                     ListingParameters parameters)

Gets the list of found instances

Type Parameters:

T - type of target entity class

Parameters:

entityManager - entity manager of designated persistence unit

entityClass - target entity class

parameters - defines the listing queue. It contains optional query parameters as described above

Returns:

generic list of found instances

countListing

public static <T> Long countListing(javax.persistence.EntityManager entityManager,
                                    Class<T> entityClass,
                                    ListingParameters parameters)

Gets the count of the found instances of the target entity

Type Parameters:

T - type of target entity class

Parameters:

entityManager - entity manager of designated persistence unit

entityClass - target entity class

parameters - defines the listing queue. It contains optional query parameters as described above

Returns:

the amount of found instances

getListingResult

public static <T> ListingResult<T> getListingResult(javax.persistence.EntityManager entityManager,
                                                    Class<T> entityClass,
                                                    Integer page,
                                                    Integer limit)

Gets the listing result

Type Parameters:

T - type of target entity class

Parameters:

entityManager - entity manager of designated persistence unit

entityClass - target entity class

page - Current page (pagination)

limit - Amount of given result for the current page, see list results (pagination, if 0 then there is no limit)

Returns:

a ListingResult object containing metadata and the resulting list of the target entity instances (sublist in case of pagination)

getListing

public static <T> List<T> getListing(javax.persistence.EntityManager entityManager,
                                     Class<T> entityClass,
                                     Integer page,
                                     Integer limit)

Gets the list of found instances

Type Parameters:

T - type of target entity class

Parameters:

entityManager - entity manager of designated persistence unit

entityClass - target entity class

page - Current page (pagination)

limit - Amount of given result for the current page, see list results (pagination, if 0 then there is no limit)

Returns:

generic list of found instances

countListing

public static <T> Long countListing(javax.persistence.EntityManager entityManager,
                                    Class<T> entityClass,
                                    Integer page,
                                    Integer limit)

Gets the count of the found instances of the target entity

Type Parameters:

T - type of target entity class

Parameters:

entityManager - entity manager of designated persistence unit

entityClass - target entity class

page - Current page (pagination)

limit - Amount of given result for the current page, see list results (pagination, if 0 then there is no limit)

Returns:

the amount of found instances

getListingResult

public static <T> ListingResult<T> getListingResult(javax.persistence.EntityManager entityManager,
                                                    Class<T> entityClass,
                                                    Integer page,
                                                    Integer limit,
                                                    String sortAttribute)

Gets the listing result

Type Parameters:

T - type of target entity class

Parameters:

entityManager - entity manager of designated persistence unit

entityClass - target entity class

page - Current page (pagination)

limit - Amount of given result for the current page, see list results (pagination, if 0 then there is no limit)

sortAttribute - Current order by this row (ascending except if it starts with "-" = descending)

Returns:

a ListingResult object containing metadata and the resulting list of the target entity instances (sublist in case of pagination)

getListing

public static <T> List<T> getListing(javax.persistence.EntityManager entityManager,
                                     Class<T> entityClass,
                                     Integer page,
                                     Integer limit,
                                     String sortAttribute)

Gets the list of found instances

Type Parameters:

T - type of target entity class

Parameters:

entityManager - entity manager of designated persistence unit

entityClass - target entity class

page - Current page (pagination)

limit - Amount of given result for the current page, see list results (pagination, if 0 then there is no limit)

sortAttribute - Current order by this row (ascending except if it starts with "-" = descending)

Returns:

generic list of found instances

countListing

public static <T> Long countListing(javax.persistence.EntityManager entityManager,
                                    Class<T> entityClass,
                                    Integer page,
                                    Integer limit,
                                    String sortAttribute)

Gets the count of the found instances of the target entity

Type Parameters:

T - type of target entity class

Parameters:

entityManager - entity manager of designated persistence unit

entityClass - target entity class

page - Current page (pagination)

limit - Amount of given result for the current page, see list results (pagination, if 0 then there is no limit)

sortAttribute - Current order by this row (ascending except if it starts with "-" = descending)

Returns:

the amount of found instances