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.
 * Example: variants.attributes.color:"green","yellow"
 * @param  Type of the resource for the facet
 */
public interface FacetExpression extends SearchExpression {

    /**
     * Gets the path of the facet result, which is either the alias or the search path if no alias defined.
     * Example: variants.attributes.color
     * @return the path to access the facet result.
     */
    String resultPath();
}