• Home
• io.sphere.sdk.jvm
• sphere-common
• 1.0.0-M24
• source code
• FacetExpression.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

package io.sphere.sdk.search;

import javax.annotation.Nullable;

/**
 * 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();

    /**
     * Gets the defined alias.
     * @return the alias of the facet
     */
    @Nullable
    String alias();
}