com.adobe.cq.commerce.common

Class AbstractJcrProduct

java.lang.Object

org.apache.sling.api.adapter.SlingAdaptable

org.apache.sling.adapter.SlingAdaptable

com.adobe.cq.commerce.common.AbstractJcrProduct

All Implemented Interfaces:

Product, Adaptable

@ConsumerType
public abstract class AbstractJcrProduct
extends SlingAdaptable
implements Product

This class is meant to be used as a base class for a Product implementation built on top of a JCR repository. GeoProductImpl is an example.

Field Summary

Fields inherited from interface com.adobe.cq.commerce.api.Product

RESOURCE_TYPE_PRODUCT

Constructor Summary

Constructors

Constructor and Description
AbstractJcrProduct(Resource resource) Constructor

Method Summary

Modifier and Type	Method and Description
<AdapterType> AdapterType	adaptTo(java.lang.Class<AdapterType> type) Calls into the registered AdapterManager to adapt this object to the desired type.
boolean	axisIsVariant(java.lang.String axis) Tests a single axis (property) for variation.
boolean	equals(java.lang.Object obj)
Resource	getAsset() Get the primary asset for this product, or null if no asset was found.
java.util.List<Resource>	getAssets() Get all the assets for this product.
java.util.List<Resource>	getAssets(java.util.List<java.lang.String> mimeTypes) Returns the assets filtered by the mime type
Product	getBaseProduct() Returns the product which forms the base of a set of variations.
java.lang.String	getDescription() Returns the product's description.
java.lang.String	getDescription(java.lang.String selectorString) Returns the product's description based on the given selector.
ImageResource	getImage() Get the primary image for this product, or null if no image was found.
java.lang.String	getImagePath() Deprecated.
java.util.List<ImageResource>	getImages() Get all the images for this product.
java.lang.String	getImageUrl() Deprecated.
java.lang.String	getPagePath() Get the path of the parent page which renders the product/variation.
java.lang.String	getPath() Get the underlying resource's path.
Product	getPIMProduct() Returns the PIM Product (under /var/commerce/products) which stores this product's data.
<T> T	getProperty(java.lang.String name, java.lang.Class<T> type) Returns a product property.
<T> T	getProperty(java.lang.String name, java.lang.String selectorString, java.lang.Class<T> type) Return a product property based on the given selector.
ImageResource	getThumbnail() Deprecated.
java.lang.String	getThumbnailUrl() Returns the URL to the product's thumbnail image.
java.lang.String	getThumbnailUrl(int width) Returns the URL to the product's thumbnail image, resized to the specified width.
java.lang.String	getThumbnailUrl(java.lang.String selectorString) When the selectorString contains "image", it returns the thumbnail based on the product image by calling getImage(), otherwise it returns the thumbnail based on the product asset by calling getAsset()
java.lang.String	getTitle() Returns the product's title.
java.lang.String	getTitle(java.lang.String selectorString) Returns the product's title based on the given selector.
java.util.Iterator<java.lang.String>	getVariantAxes() Returns an iterator over the property names of the variant axes.
java.util.Iterator<Product>	getVariants() Returns an iterator over the list of all product variations to which this particular product/variant belongs.
java.util.Iterator<Product>	getVariants(VariantFilter filter) Returns an iterator over the list of product variants for this product filtered by the VariantFilter.
int	hashCode()
static boolean	isABaseProduct(Resource resource) Returns true if resource's cq:commerceType is "product".
static boolean	isAProductOrVariant(Resource resource) Returns true if resource's cq:commerceType is "product" or "variant".
static boolean	isAVariant(Resource resource) Returns true if resource's cq:commerceType is "variant".

Methods inherited from class org.apache.sling.api.adapter.SlingAdaptable

setAdapterManager, unsetAdapterManager

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.adobe.cq.commerce.api.Product

getSKU

Constructor Detail

AbstractJcrProduct

public AbstractJcrProduct(Resource resource)

Constructor

Parameters:

resource - the Resource storing the product (or variant) info

Method Detail

getPath

public java.lang.String getPath()

Description copied from interface: Product

Get the underlying resource's path. This must be unique for a particular variation.

Specified by:

getPath in interface Product

Returns:

getPagePath

public java.lang.String getPagePath()

Description copied from interface: Product

Get the path of the parent page which renders the product/variation.

Specified by:

getPagePath in interface Product

Returns:

getTitle

public java.lang.String getTitle()

Description copied from interface: Product

Returns the product's title.

Specified by:

getTitle in interface Product

Returns:

getTitle

public java.lang.String getTitle(java.lang.String selectorString)

Description copied from interface: Product

Returns the product's title based on the given selector.

The selector is often a language token, but could also be a regional identifier or some other discriminator.

Specified by:

getTitle in interface Product

Returns:

getDescription

public java.lang.String getDescription()

Description copied from interface: Product

Returns the product's description.

Specified by:

getDescription in interface Product

Returns:

getDescription

public java.lang.String getDescription(java.lang.String selectorString)

Description copied from interface: Product

Returns the product's description based on the given selector.

The selector is often a language token, but could also be a regional identifier or some other discriminator.

Specified by:

getDescription in interface Product

Returns:

getImagePath

@Deprecated
public java.lang.String getImagePath()

Deprecated.

Description copied from interface: Product

Returns the JCR path to the product's primary image.

Specified by:

getImagePath in interface Product

Returns:

getImageUrl

@Deprecated
public java.lang.String getImageUrl()

Deprecated.

Description copied from interface: Product

Returns the URL to the product's primary image.

Specified by:

getImageUrl in interface Product

Returns:

getThumbnail

@Deprecated
public ImageResource getThumbnail()

Deprecated.

Description copied from interface: Product

Get a thumbnail for this product, or null if no thumbnail was found.

Specified by:

getThumbnail in interface Product

Returns:

getThumbnailUrl

public java.lang.String getThumbnailUrl()

Description copied from interface: Product

Returns the URL to the product's thumbnail image.

Specified by:

getThumbnailUrl in interface Product

Returns:

getThumbnailUrl

public java.lang.String getThumbnailUrl(int width)

Description copied from interface: Product

Returns the URL to the product's thumbnail image, resized to the specified width.

Specified by:

getThumbnailUrl in interface Product

Returns:

getThumbnailUrl

public java.lang.String getThumbnailUrl(java.lang.String selectorString)

When the selectorString contains "image", it returns the thumbnail based on the product image by calling getImage(), otherwise it returns the thumbnail based on the product asset by calling getAsset()

Specified by:

getThumbnailUrl in interface Product

Returns:

getImage

public ImageResource getImage()

Description copied from interface: Product

Get the primary image for this product, or null if no image was found.

Specified by:

getImage in interface Product

Returns:

getAsset

public Resource getAsset()

Description copied from interface: Product

Get the primary asset for this product, or null if no asset was found.

Specified by:

getAsset in interface Product

Returns:

getImages

public java.util.List<ImageResource> getImages()

Description copied from interface: Product

Get all the images for this product. Can return an empty list if no images were found.

Specified by:

getImages in interface Product

Returns:

getAssets

public java.util.List<Resource> getAssets()

Description copied from interface: Product

Get all the assets for this product. Can return an empty list if no assets were found.

Specified by:

getAssets in interface Product

Returns:

getAssets

public java.util.List<Resource> getAssets(java.util.List<java.lang.String> mimeTypes)

Returns the assets filtered by the mime type

Parameters:

mimeTypes -

Returns:

getProperty

public <T> T getProperty(java.lang.String name,
                         java.lang.Class<T> type)

Description copied from interface: Product

Returns a product property.

Specified by:

getProperty in interface Product

Parameters:

name - The property name

type - The type the property value should be converted to

Returns:

getProperty

public <T> T getProperty(java.lang.String name,
                         java.lang.String selectorString,
                         java.lang.Class<T> type)

Description copied from interface: Product

Return a product property based on the given selector.

The selector is often a language token, but could also be a regional identifier or some other discriminator.

Specified by:

getProperty in interface Product

Returns:

getVariants

public java.util.Iterator<Product> getVariants()
                                        throws CommerceException

Description copied from interface: Product

Returns an iterator over the list of all product variations to which this particular product/variant belongs. Within a hierarchy this routine should return the leaf nodes, regardless of the intervening nodes or the point of entry. For instance, given:

    coat/
        coat-blue/
            coat-blue-S
            coat-blue-M
        coat-green/
            coat-green-S

it must return [coat-blue-S, coat-blue-M, coat-green-S] whether called from the Product representing coat or coat-green-S.

Specified by:

getVariants in interface Product

Returns:

Throws:

CommerceException

axisIsVariant

public boolean axisIsVariant(java.lang.String axis)

Description copied from interface: Product

Tests a single axis (property) for variation.

Specified by:

axisIsVariant in interface Product

Parameters:

axis - The name of the property

Returns:

true if the given axis is variant

getVariants

public java.util.Iterator<Product> getVariants(VariantFilter filter)
                                        throws CommerceException

Description copied from interface: Product

Returns an iterator over the list of product variants for this product filtered by the VariantFilter.

Example usages:

To get the complete list of sizes, irrespective of color:

    Iterator<Product> iter = product.getVariants(new EnumerateAxisFilter("size"));

To get the list of sub-variants of the color "blue":

    Iterator<Product> iter = product.getVariants(new AxisFilter("color", "blue"));

Specified by:

getVariants in interface Product

Returns:

Throws:

CommerceException

See Also:

VariantFilter, EnumerateAxisFilter, AxisFilter

getVariantAxes

public java.util.Iterator<java.lang.String> getVariantAxes()

Description copied from interface: Product

Returns an iterator over the property names of the variant axes. For instance: ["color", "size"].

Specified by:

getVariantAxes in interface Product

Returns:

getBaseProduct

public Product getBaseProduct()
                       throws CommerceException

Description copied from interface: Product

Returns the product which forms the base of a set of variations. If called on a Product which is already the base, will return this.

Specified by:

getBaseProduct in interface Product

Returns:

The base Product

Throws:

CommerceException

getPIMProduct

public Product getPIMProduct()
                      throws CommerceException

Description copied from interface: Product

Returns the PIM Product (under /var/commerce/products) which stores this product's data. (Will return null for products which don't refer to PIM data.)

Specified by:

getPIMProduct in interface Product

Returns:

The PIM Product

Throws:

CommerceException

isAVariant

public static boolean isAVariant(Resource resource)

Returns true if resource's cq:commerceType is "variant".

Parameters:

resource -

Returns:

isABaseProduct

public static boolean isABaseProduct(Resource resource)

Returns true if resource's cq:commerceType is "product".

Parameters:

resource -

Returns:

isAProductOrVariant

public static boolean isAProductOrVariant(Resource resource)

Returns true if resource's cq:commerceType is "product" or "variant".

Parameters:

resource -

Returns:

adaptTo

public <AdapterType> AdapterType adaptTo(java.lang.Class<AdapterType> type)

Calls into the registered AdapterManager to adapt this object to the desired type.

This method implements a cache of adapters to improve performance. That is repeated calls to this method with the same class will result in the same object to be returned.

Specified by:

adaptTo in interface Adaptable

Overrides:

adaptTo in class SlingAdaptable

Type Parameters:

AdapterType - The generic type to which this resource is adapted to

Parameters:

type - The Class object of the target type, such as javax.jcr.Node.class or java.io.File.class

Returns:

The adapter target or null if the resource cannot adapt to the requested type

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object