com.broadleafcommerce.enterprise.common.dao.batch

Interface RefinedHelper

public interface RefinedHelper

Provides more fine-grained control over batch fetch behavior. Able to provide a result set page size. Useful for data fetch operations that need to break up large result sets into smaller pages of data for more efficient memory usage. Also able to provide the query execution itself and result retrieval for special cases.

Author:

Jeff Fischer

Method Summary

Modifier and Type	Method and Description
int	getPageSize() The limit on the result set size.
List	getResults(javax.persistence.EntityManager em, String queryTemplate, List<Serializable> fkValue) Optional.
void	padList(List<Serializable> fkValue) Optional.

Method Detail

getPageSize

int getPageSize()

The limit on the result set size. If the foreign key values for the batch fetch exceed the page size, then multiple queries are emitted in "chunks" until all the fk values are queried.

Returns:

padList

void padList(List<Serializable> fkValue)

Optional. Used to maintain IN clause sizes. An implementation can pad the fkValue with junk values if the list is smaller than the getPageSize().

Parameters:

fkValue -

getResults

List getResults(javax.persistence.EntityManager em,
                String queryTemplate,
                List<Serializable> fkValue)

Optional. The implementation may execute the query and retrieve the results itself. This is useful when some form of special handling (e.g. native sql) is required. Implementations that don't wish to handle this method should return null.

Parameters:

em -

queryTemplate -

fkValue -

Returns: