com.adobe.cq.commerce.common

Class EnumerateAxisFilter

java.lang.Object

com.adobe.cq.commerce.common.EnumerateAxisFilter

All Implemented Interfaces:

VariantFilter

public class EnumerateAxisFilter
extends java.lang.Object
implements VariantFilter

A VariantFilter for enumerating variants along a given axis. A single variation will be returned for each enumeration.

For example, given the variations:

• small-blue
• small-black
• small-tan
• large-green
• large-brown
• large-red

this call:

    product.getVariants(new EnumerateAxisFilter("size"));

will return two products: small-blue and large-green.

NB: the particular variation chosen to represent each enumeration is not defined. The example above could have also returned small-black and large-red.

Constructor Summary

Constructors

Constructor and Description
EnumerateAxisFilter(java.lang.String axis)

Method Summary

Modifier and Type	Method and Description
boolean	includes(Product product) Decides if a product is to be included by this filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumerateAxisFilter

public EnumerateAxisFilter(java.lang.String axis)

Method Detail

includes

public boolean includes(Product product)

Description copied from interface: VariantFilter

Decides if a product is to be included by this filter.

Specified by:

includes in interface VariantFilter

Returns: