com.adobe.cq.commerce.common

Class CommerceHelper

java.lang.Object

com.adobe.cq.commerce.common.CommerceHelper

public class CommerceHelper
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CommerceHelper()

Method Summary

Modifier and Type	Method and Description
static void	collectVariants(Resource resource, java.util.Map<java.lang.String,Product> variations) Collects up a map of product variations (including the base product) under a given subtree.
static boolean	copyTags(Product source, Resource dest, Predicate filter) Copies a filtered list of tags from a Product to another Resource.
static Product	findCurrentProduct(Page currentPage) Finds the current Product for a product page.
static Resource	findProductResource(Page page) Finds the current product resource for a page.
static Resource	findProductResource(Resource resource) Finds a product resource at or below the provided resource's path.
static java.lang.String	getCardTitle(Resource resource, PageManager pageManager) Return a title suitable for a card in the touch-optimized GUI.
static java.lang.String	getCatalogCardThumbnail(java.lang.String contextPath, Resource resource, PageManager pageManager) Returns a thumbnail for a card in the catalogs console.
static java.lang.String	getProductCardThumbnail(java.lang.String contextPath, Product product) Return an externalized URL to a product's thumbnail image.
static java.util.Comparator<Product>	getProductSizeComparator() Handles comparison of product "size" fields containing either numeric or letter sizes.
static java.lang.String	mapPathToCurrentLanguage(Page currentPage, java.lang.String srcPath) Maps a designer-supplied resource path (such as /content/geometrixx-outdoors/language-masters/en/user/cart) to the current language (ie: /content/geometrixx-outdoors/de/de/user/cart).
static void	writeCart(JSONWriter writer, CommerceSession commerceSession) Writes a cart to JSON for the CartMgr ClientContextStore.
static void	writeCart(JSONWriter writer, CommerceSession commerceSession, ResourceResolver resolver) Deprecated. since 6.1
static void	writeCart(JSONWriter writer, CommerceSession commerceSession, ResourceResolver resolver, SlingHttpServletRequest request) Deprecated. since 6.1 (moved to ClientContextCartServlet)
static void	writeOrderHistory(JSONWriter writer, PlacedOrderResult orderHistory, OrderHistoryTraitDataProvider[] services) Writes order history trait data to JSON for the OrderHistoryMgr ClientContextStore.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommerceHelper

public CommerceHelper()

Method Detail

mapPathToCurrentLanguage

public static java.lang.String mapPathToCurrentLanguage(Page currentPage,
                                                        java.lang.String srcPath)

Maps a designer-supplied resource path (such as /content/geometrixx-outdoors/language-masters/en/user/cart) to the current language (ie: /content/geometrixx-outdoors/de/de/user/cart).

Parameters:

currentPage - The page being rendered (which controls the language selection)

srcPath - The resource path (usually given in the design language)

Returns:

The srcPath mapped to the currentPage's language

getProductSizeComparator

public static java.util.Comparator<Product> getProductSizeComparator()

Handles comparison of product "size" fields containing either numeric or letter sizes. Both operands must have the same type of size (ie: numeric or letter).

Returns:

a java.util.Comparator

findCurrentProduct

public static Product findCurrentProduct(Page currentPage)

Finds the current Product for a product page. This will be the first Product node or reference within the page's content.

Parameters:

currentPage - The page to search in

Returns:

First Product for a product page

See Also:

findProduct(Resource)

findProductResource

public static Resource findProductResource(Page page)

Finds the current product resource for a page. This will be the first node with a cq:commerceType property of product. As opposed to findCurrentProduct(com.day.cq.wcm.api.Page), this will not try to adapt the resource to a Product, so it will work even for yet-unfilled resources.

Parameters:

page - The page to search in

Returns:

The first cq:commerceType='product' resource, or null if it doesn't exist

See Also:

findProductResource(org.apache.sling.api.resource.Resource)

findProductResource

public static Resource findProductResource(Resource resource)

Finds a product resource at or below the provided resource's path. As opposed to findProduct(org.apache.sling.api.resource.Resource), this will not try to adapt the resource to a Product, so it will work even for yet-unfilled resources.

Parameters:

resource - The resource to start from

Returns:

The first cq:commerceType='product' resource, or null if it doesn't exist

See Also:

findProductResource(com.day.cq.wcm.api.Page)

collectVariants

public static void collectVariants(Resource resource,
                                   java.util.Map<java.lang.String,Product> variations)

Collects up a map of product variations (including the base product) under a given subtree. The map is keyed by the PN_PRODUCT_DATA path.

Parameters:

resource -

variations -

copyTags

public static boolean copyTags(Product source,
                               Resource dest,
                               Predicate filter)
                        throws RepositoryException

Copies a filtered list of tags from a Product to another Resource.

Parameters:

source -

dest -

filter - A Predicate which is passed each com.day.cq.tagging.Tag.

Returns:

true if any tags were copied

Throws:

RepositoryException

writeCart

public static void writeCart(JSONWriter writer,
                             CommerceSession commerceSession)
                      throws CommerceException,
                             JSONException

Writes a cart to JSON for the CartMgr ClientContextStore. Does not support server promotions or promotion maps.

Parameters:

writer - A JSONWriter instance

commerceSession - The commerce session

Throws:

CommerceException

JSONException

writeCart

@Deprecated
public static void writeCart(JSONWriter writer,
                                         CommerceSession commerceSession,
                                         ResourceResolver resolver)
                                  throws CommerceException,
                                         JSONException

Deprecated. since 6.1

Writes a cart to JSON for the CartMgr ClientContextStore. Supports server promotions, but not promotion maps.

Parameters:

writer - A JSONWriter instance

commerceSession - The commerce session

resolver - The resource resolver

Throws:

CommerceException

JSONException

writeCart

@Deprecated
public static void writeCart(JSONWriter writer,
                                         CommerceSession commerceSession,
                                         ResourceResolver resolver,
                                         SlingHttpServletRequest request)
                                  throws CommerceException,
                                         JSONException

Deprecated. since 6.1 (moved to ClientContextCartServlet)

Writes a cart to JSON for the CartMgr ClientContextStore. Supports server promotions and promotionMaps.

Parameters:

writer - A JSONWriter instance

commerceSession - The commerce session

resolver - The resource resolver

request - The current request

Throws:

CommerceException

JSONException

writeOrderHistory

public static void writeOrderHistory(JSONWriter writer,
                                     PlacedOrderResult orderHistory,
                                     OrderHistoryTraitDataProvider[] services)
                              throws CommerceException,
                                     JSONException

Writes order history trait data to JSON for the OrderHistoryMgr ClientContextStore.

Parameters:

writer - A JSONWriter instance

orderHistory - the placed orders

services - the order history trait data provider services

Throws:

CommerceException

JSONException

getCatalogCardThumbnail

public static java.lang.String getCatalogCardThumbnail(java.lang.String contextPath,
                                                       Resource resource,
                                                       PageManager pageManager)

Returns a thumbnail for a card in the catalogs console.

Parameters:

contextPath - the request's contextPath

getCardTitle

public static java.lang.String getCardTitle(Resource resource,
                                            PageManager pageManager)

Return a title suitable for a card in the touch-optimized GUI.

Parameters:

resource -

pageManager -

Returns:

getProductCardThumbnail

public static java.lang.String getProductCardThumbnail(java.lang.String contextPath,
                                                       Product product)

Return an externalized URL to a product's thumbnail image.

Parameters:

contextPath - the request's contextPath