io.sphere.internal.facets.FacetBase Maven / Gradle / Ivy

Go to download

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

sphere-java-client

There is a newer version: 0.72.1

package io.sphere.internal.facets;

import io.sphere.client.facets.Facet;
import io.sphere.client.QueryParam;

import static io.sphere.internal.util.QueryStringConstruction.*;

import java.util.List;
import java.util.Map;

/** Facet that matches on a custom attribute.
 *
 *  @param  Type of items returned for this facet:
 *  {@link io.sphere.client.model.facets.TermFacetItem},
 *  {@link io.sphere.client.model.facets.RangeFacetItem}. */
public abstract class FacetBase implements Facet {
    /** Name of the application-level query parameter for this facet. */
    protected String queryParam;
    /** Backend name of the custom attribute. */
    protected String attribute;
    /** The attribute on which this facet matches and aggregates counts. */
    public String getAttributeName() {
        return attribute;
    }
    /** If true, only one value can be selected by user at a time. */
    protected boolean isSingleSelect = false;

    protected FacetBase(String attribute) {
        this.attribute = attribute;
        this.queryParam = attribute;
    }

    /** {@inheritDoc} */
    public abstract List getUrlParams(T item);
    /** {@inheritDoc} */
    @Override public final String getSelectLink(T item, Map queryParams) {
        if (isSingleSelect) {
            // If single select, remove all existing query params for this facet.
            List itemUrlParams = getUrlParams(item);
            return makeLink(toQueryString(addURLParams(clearParams(queryParams, itemUrlParams), itemUrlParams)));
        } else {
            return makeLink(toQueryString(addURLParams(queryParams, getUrlParams(item))));
        }
    }
    /** {@inheritDoc} */
    @Override public final String getUnselectLink(T item, Map queryParams) {
        return makeLink(toQueryString(removeURLParams(queryParams, getUrlParams(item))));
    }
    /** {@inheritDoc} */
    @Override public final boolean isSelected(T item, Map queryParams) {
        return containsAllURLParams(queryParams, getUrlParams(item));
    }
}