com.broadleafcommerce.enterprise.common.dao.batch

Interface EnterpriseCollectionDao

public interface EnterpriseCollectionDao

Provides a facility to batch fetch important collections for an entire list of containing entities. Normally, for sandboxable collections, if you iterate through the containing entities and touch each of the lazy collections, you will emit additional queries to retrieve the collection members. For a large list of containing entities, this can result in a lot of additional queries and possibly impact performance. Batch fetching through this class allows the system to emit a single query to retrieve collection members for all the containing entities in the list in a single query, which results in less queries overall and possibly increased performance.

Generally, this optimization is best when applied against installations with very large catalogs. The prime use case is for search results that often return varied and uncached results. However, for small catalogs, the minimal performance gain on uncached search results generally does not justify the small overhead of running the batch fetch query for all results. Note, the batch fetch query is also cached, so subsequent runs of the same query do not hit the database, but there is still a minimal overhead involved for query construction and level 2 cache hydration.

The functionality provided by this class is disabled by default. To enable, include allow.resultset.sandbox.collection.batch.fetch = true in your implementation's property file.

Author:

Jeff Fischer

Method Summary

Modifier and Type	Method and Description
List	batchFetchSandBoxCollectionMembers(List<Serializable> fkValue, SandBoxCollectionHelper helper) Batch fetch the members for specific collection.
void	batchFetchSandBoxCollectionsForProducts(List<org.broadleafcommerce.core.catalog.domain.Product> products) Utility method for batch fetching a number of preset collections for a list of products.
void	batchFetchSandBoxCollectionsForSkus(List<org.broadleafcommerce.core.catalog.domain.Sku> skus) Utility method for batch fetching a number of preset collections for a list of skus.
List	getSandBoxCollectionMembers(List<Serializable> fkValue, SandBoxCollectionHelper helper) Retrieve the collection members across an entire list of containing entities.
List	getSandBoxCollectionMembers(Serializable fkValue, SandBoxCollectionHelper helper) Retrieve the collection members for a single containing entity.

Method Detail

batchFetchSandBoxCollectionsForProducts

void batchFetchSandBoxCollectionsForProducts(List<org.broadleafcommerce.core.catalog.domain.Product> products)

Utility method for batch fetching a number of preset collections for a list of products. This is optimized for general search result usage. Subclasses may override for specialized behavior.

Parameters:

products -

batchFetchSandBoxCollectionsForSkus

void batchFetchSandBoxCollectionsForSkus(List<org.broadleafcommerce.core.catalog.domain.Sku> skus)

Utility method for batch fetching a number of preset collections for a list of skus. This is optimized for general search result usage. Subclasses may override for specialized behavior.

Parameters:

skus -

batchFetchSandBoxCollectionMembers

List batchFetchSandBoxCollectionMembers(List<Serializable> fkValue,
                                        SandBoxCollectionHelper helper)

Batch fetch the members for specific collection. The results are added to an internal cache, scoped to the request, that is available during subsequent collection lazy initialization.

Parameters:

fkValue - the list of primary key values for the containing entities

helper - the collection configuration

Returns:

the list of all collection members across all the containing entities

getSandBoxCollectionMembers

@Nonnull
List getSandBoxCollectionMembers(Serializable fkValue,
                                          SandBoxCollectionHelper helper)

Retrieve the collection members for a single containing entity.

Parameters:

fkValue - the primary key of the containing entity

helper - the collection configuration

Returns:

the list of collections members related to the containing entity

getSandBoxCollectionMembers

List getSandBoxCollectionMembers(List<Serializable> fkValue,
                                 SandBoxCollectionHelper helper)

Retrieve the collection members across an entire list of containing entities. The results here are not cached. Use batchFetchSandBoxCollectionMembers(List, SandBoxCollectionHelper) for the same results with caching behavior.

Parameters:

fkValue - the list of primary key values for the containing entities

helper - the collection configuration

Returns:

the list of all collection members across all the containing entities