io.sphere.internal.filters.MultiSelectFilterBase Maven / Gradle / Ivy
package io.sphere.internal.filters;
import com.google.common.collect.ImmutableList;
import io.sphere.client.filters.MultiSelectFilter;
import io.sphere.client.QueryParam;
import static io.sphere.internal.util.QueryStringConstruction.*;
import static io.sphere.internal.util.ListUtil.*;
import java.util.Collection;
import java.util.List;
import java.util.Map;
/** Helper base class for implementations of {@link MultiSelectFilter}s. */
public abstract class MultiSelectFilterBase implements MultiSelectFilter {
/** Name of the application-level query parameter for this filter. */
protected String queryParam;
/** Backend name of the custom attribute. */
protected String attribute;
/** The attribute on which this filter matches. */
public String getAttributeName() {
return attribute;
}
private final ImmutableList values;
/** {@inheritDoc} */
public List getValues() {
return values;
}
/** If true, only one value can be selected by user at a time. */
protected boolean isSingleSelect = false;
public MultiSelectFilterBase(String attribute, T value, T... values) {
this(attribute, list(value, values));
}
public MultiSelectFilterBase(String attribute, Collection values) {
this.attribute = attribute; this.queryParam = attribute; this.values = toList(values);
}
public MultiSelectFilterBase(String attribute, String queryParam, T value, T... values) {
this(attribute, queryParam, list(value, values));
}
public MultiSelectFilterBase(String attribute, String queryParam, Collection values) {
this.attribute = attribute; this.queryParam = queryParam; this.values = toList(values);
}
/** Returns the values that the user selected for this filter (passed in application's URL).
* Used in implementations of {@link io.sphere.client.filters.Filter#parse}. */
protected abstract List parseValues(Map queryString);
/** {@inheritDoc} */
public abstract List getUrlParams(T value);
/** {@inheritDoc} */
@Override public final String getSelectLink(T value, Map queryParams) {
if (isSingleSelect) {
// If single select, remove all existing query params for this filter.
Map queryString = queryParams;
for (T v: getValues()) {
queryString = clearParams(queryString, getUrlParams(v));
}
return makeLink(toQueryString(addURLParams(queryString, getUrlParams(value))));
} else {
return makeLink(toQueryString(addURLParams(queryParams, getUrlParams(value))));
}
}
/** {@inheritDoc} */
@Override public final String getUnselectLink(T value, Map queryParams) {
return makeLink(toQueryString(removeURLParams(queryParams, getUrlParams(value))));
}
/** {@inheritDoc} */
@Override public final boolean isSelected(T value, Map queryParams) {
return containsAllURLParams(queryParams, getUrlParams(value));
}
}