io.sphere.sdk.search.FacetExpression Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sphere-common Show documentation

sphere-common

There is a newer version: 1.0.0-M26

package io.sphere.sdk.search;

/**
 * Facets calculate statistical counts to aid in faceted navigation.
 * @param  Type of the resource for the faceted search
 */
public interface FacetExpression {
    /**
     * returns a facet expression.
     * Example: variants.attributes.color as myColor
     * @return String with unescaped sphere facet expression
     */
    String toSearchExpression();

    /**
     * Generates the attribute path for the facet.
     * Example: variants.attributes.color
     * @return the path for the attribute to be faceted
     */
    String attributePath();

    static  FacetExpression of(final String sphereFacetExpression) {
        return new SimpleFacetExpression<>(sphereFacetExpression);
    }
}