io.sphere.sdk.search.model.MultiValueSortSearchModel 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.model;

import io.sphere.sdk.search.SortExpression;

import static io.sphere.sdk.search.SearchSortDirection.*;

/**
 * A sort model to decide the direction of a model with multiple values per resource.
 * @see MultiValueSortSearchModelFactory to instantiate this class
 */
public class MultiValueSortSearchModel extends SortSearchModelImpl {

    MultiValueSortSearchModel(final SearchModel searchModel) {
        super(searchModel);
    }

    /**
     * When the sort direction is ascending, the minimum value is used.
     * @return the ascending sort direction
     */
    @Override
    public SortExpression byAsc() {
        return super.byAsc();
    }

    /**
     * When the direction is descending, the maximum value is used.
     * @return the descending sort direction
     */
    @Override
    public SortExpression byDesc() {
        return super.byDesc();
    }

    /**
     * Changes the default behaviour of the ascending sort by using the maximum value instead.
     * @return the ascending sort direction using the maximum value
     */
    public SortExpression byAscWithMax() {
        return by(ASC_MAX);
    }

    /**
     * Changes the default behaviour of the descending sort by using the minimum value instead.
     * @return the descending sort direction using the minimum value
     */
    public SortExpression byDescWithMin() {
        return by(DESC_MIN);
    }

    /**
     * Creates an instance of the search model to generate multi-valued sort expressions.
     * @param attributePath the path of the attribute as expected by Commercetools Platform (e.g. "variants.attributes.color.key")
     * @param  type of the resource
     * @return new instance of MultiValueSortSearchModel
     */
    public static  MultiValueSortSearchModel of(final String attributePath) {
        return new MultiValueSortSearchModel<>(new SearchModelImpl<>(attributePath));
    }
}