Package com.broadleafcommerce.catalog.service.category.commerce

Class DefaultCategoryDetailsService

java.lang.Object

com.broadleafcommerce.catalog.service.category.commerce.DefaultCategoryDetailsService

All Implemented Interfaces:

CategoryDetailsService

public class DefaultCategoryDetailsService
extends Object
implements CategoryDetailsService

Author:

Nathan Moore (nathandmoore)

Constructor Summary

Constructors

Constructor	Description
DefaultCategoryDetailsService(List<CategoryDetailsContributor> detailsContributors, List<CategoryDetailsContextContributor> contextContributors, List<CategoryDetailsContextConsolidator> contextConsolidators, CategoryService<Category> categoryService, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected CategoryDetailsContext	buildContext(@NonNull CategoryDetailsRequest request, @NonNull Category resolvedCategory, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds a CategoryDetailsContext in response to a CategoryDetailsRequest.
protected CategoryDetails	buildDetails(@NonNull CategoryDetailsContext detailsContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds out the CategoryDetails in response to a CategoryDetailsRequest.
CategoryDetails	getCategoryDetailsForCategory(@NonNull CategoryDetailsRequest request, @NonNull Category category, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Gets a CategoryDetails for the CategoryDetailsRequest.
Optional<CategoryDetails>	getCategoryDetailsForRequest(@NonNull CategoryDetailsRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Gets a CategoryDetails for the CategoryDetailsRequest.
protected CategoryService<Category>	getCategoryService()
protected List<CategoryDetailsContextConsolidator>	getContextConsolidators()
protected List<CategoryDetailsContextContributor>	getContextContributors()
protected List<CategoryDetailsContributor>	getDetailsContributors()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected Optional<Category>	resolveCategory(@NonNull CategoryDetailsRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Resolves the base category for the given request.
protected void	validateRequest(@NonNull CategoryDetailsRequest request)	Validates the CategoryDetailsRequest.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultCategoryDetailsService

public DefaultCategoryDetailsService(List<CategoryDetailsContributor> detailsContributors,
 List<CategoryDetailsContextContributor> contextContributors,
 List<CategoryDetailsContextConsolidator> contextConsolidators,
 CategoryService<Category> categoryService,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

getCategoryDetailsForRequest

public Optional<CategoryDetails> getCategoryDetailsForRequest(@NonNull
 @NonNull CategoryDetailsRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: CategoryDetailsService

Gets a CategoryDetails for the CategoryDetailsRequest.

Specified by:

getCategoryDetailsForRequest in interface CategoryDetailsService

Parameters:

request - the CategoryDetailsRequest with additional request context for identifying the category for which to retrieve details and defining the how much detail to go into.

contextInfo - context information surrounding sandboxing/multitenant state

Returns:

a CategoryDetails for the CategoryDetailsRequest.

getCategoryDetailsForCategory

public CategoryDetails getCategoryDetailsForCategory(@NonNull
 @NonNull CategoryDetailsRequest request,
 @NonNull
 @NonNull Category category,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: CategoryDetailsService

Gets a CategoryDetails for the CategoryDetailsRequest.

Specified by:

getCategoryDetailsForCategory in interface CategoryDetailsService

Parameters:

request - The originating CategoryDetailsRequest

category - the Category for which to build a CategoryDetails.

contextInfo - context information surrounding sandboxing/multitenant state

Returns:

a CategoryDetails for the CategoryDetailsRequest.

validateRequest

protected void validateRequest(@NonNull
 @NonNull CategoryDetailsRequest request)

Validates the CategoryDetailsRequest.

Parameters:

request - The CategoryDetailsRequest to validate

Throws:

CategoryDetailsRequestException - Thrown if the request is invalid such as missing both the category URI and ID.

resolveCategory

protected Optional<Category> resolveCategory(@NonNull
 @NonNull CategoryDetailsRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Resolves the base category for the given request.

Parameters:

request - The CategoryDetailsRequest to use to resolve the base category

contextInfo - context information surrounding sandboxing/multitenant state

Returns:

the resolved base category

buildContext

protected CategoryDetailsContext buildContext(@NonNull
 @NonNull CategoryDetailsRequest request,
 @NonNull
 @NonNull Category resolvedCategory,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Builds a CategoryDetailsContext in response to a CategoryDetailsRequest. This facilitates gathering all of the related catalog entities to the requested category all at once to allow fewer DB calls throughout the process of building a CategoryDetails. It first gathers all of the context info using all of the CategoryDetailsContextContributors. Then, it consolidates the context info onto the related entities using the CategoryDetailsContextConsolidators.

Parameters:

request - the CategoryDetailsRequest with additional request context for identifying the category for which to retrieve details and defining the how much detail to go into.

resolvedCategory - The Category found to match the request that needs to be turned into a CategoryDetails response.

contextInfo - context information surrounding sandboxing/multitenant state

Returns:

a CategoryDetailsContext in response to a CategoryDetailsRequest.

buildDetails

protected CategoryDetails buildDetails(@NonNull
 @NonNull CategoryDetailsContext detailsContext,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Builds out the CategoryDetails in response to a CategoryDetailsRequest. It relies on all of the CategoryDetailsContributors.

Parameters:

detailsContext - The CategoryDetailsContext created in response to a CategoryDetailsRequest. This contains context information and all of the catalog entities related to the requested category pre-fetched and consolidated.

contextInfo - context information surrounding sandboxing/multitenant state

Returns:

the CategoryDetails in response to a CategoryDetailsRequest.

getDetailsContributors

protected List<CategoryDetailsContributor> getDetailsContributors()

getContextContributors

protected List<CategoryDetailsContextContributor> getContextContributors()

getContextConsolidators

protected List<CategoryDetailsContextConsolidator> getContextConsolidators()

getCategoryService

protected CategoryService<Category> getCategoryService()

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()