com.visenze.visearch.BaseSearchParams Maven / Gradle / Ivy
package com.visenze.visearch;
import com.google.common.base.Joiner;
import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
import com.google.common.collect.HashMultimap;
import com.google.common.collect.Lists;
import com.google.common.collect.Multimap;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* Common parameters for /search, /colorsearch, and /uploadsearch.
* Provide setters to override default values.
*/
public class BaseSearchParams> {
private static final List DEFAULT_FACET_FIELD = Lists.newArrayList();
private static final Boolean DEFAULT_SCORE = false;
private static final Map DEFAULT_FQ = new HashMap();
private static final List DEFAULT_FL = Lists.newArrayList();
private static final Boolean DEFAULT_QINFO = false;
private static final Map DEFAULT_CUSTOM = new HashMap();
private static final Boolean DEFAULT_GET_ALL_FL = false;
private static final Boolean DEFAULT_DEDUP = false;
protected Optional page = Optional.absent();
protected Optional limit = Optional.absent();
protected Optional> facets = Optional.absent();
protected Optional facetsLimit = Optional.absent();
protected Optional facetsShowCount = Optional.absent();
protected Optional score = Optional.absent();
protected Optional scoreMin = Optional.absent();
protected Optional scoreMax = Optional.absent();
protected Optional> fq = Optional.absent();
protected Optional> vsfq = Optional.absent();
protected Optional> fl = Optional.absent();
protected Optional> vsfl = Optional.absent();
protected Optional getAllFl = Optional.absent();
protected Optional qInfo = Optional.absent();
protected Optional> custom = Optional.absent();
protected Optional dedup = Optional.absent();
protected Optional dedupThreshold = Optional.absent();
protected Optional groupBy = Optional.absent();
protected Optional groupLimit = Optional.absent();
protected Optional sortBy = Optional.absent();
protected Optional sortGroupBy = Optional.absent();
protected Optional sortGroupStrategy = Optional.absent();
@SuppressWarnings("unchecked")
public P setPage(Integer page) {
this.page = Optional.fromNullable(page);
return (P) this;
}
@SuppressWarnings("unchecked")
public P setLimit(Integer limit) {
this.limit = Optional.fromNullable(limit);
return (P) this;
}
@SuppressWarnings("unchecked")
public P setFacets(List facetField) {
this.facets = Optional.fromNullable(facetField);
return (P) this;
}
@SuppressWarnings("unchecked")
public P setScore(Boolean score) {
this.score = Optional.fromNullable(score);
return (P) this;
}
@SuppressWarnings("unchecked")
public P setScoreMin(Float scoreMin) {
this.scoreMin = Optional.fromNullable(scoreMin);
return (P) this;
}
@SuppressWarnings("unchecked")
public P setScoreMax(Float scoreMax) {
this.scoreMax = Optional.fromNullable(scoreMax);
return (P) this;
}
@SuppressWarnings("unchecked")
public P setFq(Map fq) {
this.fq = Optional.fromNullable(fq);
return (P) this;
}
public Optional> getVsfq() {
return vsfq;
}
public void setVsfq(Map vsfq) {
this.vsfq = Optional.fromNullable(vsfq);
}
public Optional> getVsfl() {
return vsfl;
}
public void setVsfl(List vsfl) {
this.vsfl = Optional.fromNullable(vsfl);
}
@SuppressWarnings("unchecked")
public P setFl(List fl) {
this.fl = Optional.fromNullable(fl);
return (P) this;
}
@SuppressWarnings("unchecked")
public P setGetAllFl(Boolean getAllFl) {
this.getAllFl = Optional.fromNullable(getAllFl);
return (P) this;
}
@SuppressWarnings("unchecked")
public P setQInfo(Boolean qInfo) {
this.qInfo = Optional.fromNullable(qInfo);
return (P) this;
}
@SuppressWarnings("unchecked")
public P setCustom(Map custom) {
this.custom = Optional.fromNullable(custom);
return (P) this;
}
@SuppressWarnings("unchecked")
public P setDedup(Boolean dedup) {
this.dedup = Optional.fromNullable(dedup);
return (P) this;
}
@SuppressWarnings("unchecked")
public P setDedupThreshold(Float dedupThreshold) {
this.dedupThreshold = Optional.fromNullable(dedupThreshold);
return (P) this;
}
@SuppressWarnings("unchecked")
public P setFacetsLimit(Integer facetsLimit) {
this.facetsLimit = Optional.fromNullable(facetsLimit);
return (P) this;
}
@SuppressWarnings("unchecked")
public P setFacetsShowCount(Boolean facetsShowCount) {
this.facetsShowCount = Optional.fromNullable(facetsShowCount);
return (P) this;
}
@SuppressWarnings("unchecked")
public P setGroupBy(String groupBy) {
this.groupBy = Optional.fromNullable(groupBy);
return (P) this;
}
@SuppressWarnings("unchecked")
public P setGroupLimit(Integer groupLimit) {
this.groupLimit = Optional.fromNullable(groupLimit);
return (P) this;
}
@SuppressWarnings("unchecked")
public P setSortBy(String sortBy) {
this.sortBy = Optional.fromNullable(sortBy);
return (P) this;
}
@SuppressWarnings("unchecked")
public P setSortGroupBy(String sortGroupBy) {
this.sortGroupBy = Optional.fromNullable(sortGroupBy);
return (P) this;
}
@SuppressWarnings("unchecked")
public P setSortGroupStrategy(String sortGroupStrategy) {
this.sortGroupStrategy = Optional.fromNullable(sortGroupStrategy);
return (P) this;
}
public Integer getPage() {
return page.orNull();
}
public Integer getLimit() {
return limit.orNull();
}
public List getFacets() {
return facets.or(DEFAULT_FACET_FIELD);
}
public boolean isScore() {
return score.or(DEFAULT_SCORE);
}
public Float getScoreMin() {
return scoreMin.orNull();
}
public Float getScoreMax() {
return scoreMax.orNull();
}
public Map getFq() {
return fq.or(DEFAULT_FQ);
}
public List getFl() {
return fl.or(DEFAULT_FL);
}
public Boolean isGetAllFl()
{
return getAllFl.or(DEFAULT_GET_ALL_FL);
}
public Boolean isQInfo() {
return qInfo.or(DEFAULT_QINFO);
}
public Map getCustom() {
return custom.or(DEFAULT_CUSTOM);
}
public boolean isDedup() {
return dedup.or(DEFAULT_DEDUP);
}
public Float getDedupThreshold() {
return dedupThreshold.orNull();
}
public Integer getFacetsLimit() {
return facetsLimit.orNull();
}
public Boolean getFacetsShowCount() {
return facetsShowCount.orNull();
}
public String getGroupBy() { return groupBy.orNull(); }
public Integer getGroupLimit() { return groupLimit.orNull(); }
public String getSortBy() {
return sortBy.orNull();
}
public String getSortGroupBy() {
return sortGroupBy.orNull();
}
public String getSortGroupStrategy() {
return sortGroupStrategy.orNull();
}
public Multimap toMap() {
Multimap map = HashMultimap.create();
if (getPage() != null) {
map.put("page", getPage().toString());
}
if (getLimit() != null) {
map.put("limit", getLimit().toString());
}
if (groupBy.isPresent()){
map.put("group_by", getGroupBy() );
}
if (groupLimit.isPresent()){
map.put("group_limit", getGroupLimit().toString() );
}
if (!getFacets().isEmpty()) {
map.put("facets", Joiner.on(",").join(getFacets()));
}
if (facetsLimit.isPresent()) {
map.put("facets_limit", facetsLimit.get().toString());
}
if (facetsShowCount.isPresent()) {
map.put("facets_show_count", facetsShowCount.get().toString());
}
if (isScore()) {
map.put("score", "true");
} else {
map.put("score", "false");
}
if (getScoreMin() != null) {
map.put("score_min", getScoreMin().toString());
}
if (getScoreMax() != null) {
map.put("score_max", getScoreMax().toString());
}
if (sortBy.isPresent()) {
map.put("sort_by", getSortBy() );
}
if (sortGroupBy.isPresent()) {
map.put("sort_group_by" , getSortGroupBy());
}
if (sortGroupStrategy.isPresent()) {
map.put("sort_group_strategy", getSortGroupStrategy());
}
for (Map.Entry entry : getFq().entrySet()) {
map.put("fq", entry.getKey() + ":" + entry.getValue());
}
if (vsfq.isPresent()) {
for (Map.Entry entry : vsfq.get().entrySet()) {
map.put("vs_fq", entry.getKey() + ":" + entry.getValue());
}
}
if (vsfl.isPresent()) {
for (String filter : vsfl.get()) {
map.put("vs_fl", filter);
}
}
for (String filter : getFl()) {
map.put("fl", filter);
}
if (isGetAllFl()) {
map.put("get_all_fl", "true");
}
if (isQInfo()) {
map.put("qinfo", "true");
}
if (isDedup()) {
map.put("dedup", "true");
}
if (getDedupThreshold() != null) {
map.put("dedup_score_threshold", getDedupThreshold().toString());
}
for (Map.Entry entry : getCustom().entrySet()) {
String key = entry.getKey();
String value = entry.getValue();
Preconditions.checkNotNull(key, "Custom search param key must not be null.");
Preconditions.checkNotNull(value, "Custom search param value must not be null.");
map.put(entry.getKey(), entry.getValue());
}
return map;
}
}