NameUsageSearchWsClient.java

/*
 * Copyright 2011 Global Biodiversity Information Facility (GBIF)
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.gbif.checklistbank.ws.client;

import org.gbif.api.model.checklistbank.search.NameUsageSearchParameter;
import org.gbif.api.model.checklistbank.search.NameUsageSearchRequest;
import org.gbif.api.model.checklistbank.search.NameUsageSearchResult;
import org.gbif.api.model.checklistbank.search.NameUsageSuggestRequest;
import org.gbif.api.model.checklistbank.search.NameUsageSuggestResult;
import org.gbif.api.model.common.search.SearchResponse;
import org.gbif.api.service.checklistbank.NameUsageSearchService;
import org.gbif.checklistbank.ws.client.guice.ChecklistBankWs;
import org.gbif.ws.client.BaseWsSuggestClient;

import java.util.Collection;
import java.util.List;
import javax.annotation.Nullable;
import javax.ws.rs.core.MultivaluedMap;

import com.google.common.collect.Lists;
import com.google.inject.Inject;
import com.sun.jersey.api.client.GenericType;
import com.sun.jersey.api.client.WebResource;

import static org.gbif.ws.util.WebserviceParameter.PARAM_EXTENDED;
import static org.gbif.ws.util.WebserviceParameter.PARAM_HIGHLIGHT_CONTEXT;
import static org.gbif.ws.util.WebserviceParameter.PARAM_HIGHLIGHT_FIELD;
import static org.gbif.ws.util.WebserviceParameter.PARAM_QUERY_FIELD;

/**
 * Client-side implementation to the NameUsageSearchService.
 */
public class NameUsageSearchWsClient
  extends BaseWsSuggestClient<NameUsageSearchResult, NameUsageSearchParameter,
  NameUsageSearchRequest, NameUsageSuggestResult, NameUsageSuggestRequest> implements NameUsageSearchService {

  private static final GenericType<SearchResponse<NameUsageSearchResult, NameUsageSearchParameter>> SEARCH_TYPE =
    new GenericType<SearchResponse<NameUsageSearchResult, NameUsageSearchParameter>>() {
    };

  private static final GenericType<List<NameUsageSuggestResult>> SUGGEST_TYPE =
    new GenericType<List<NameUsageSuggestResult>>() {
    };

  @Inject
  public NameUsageSearchWsClient(@ChecklistBankWs WebResource resource) {
    super(resource.path("species"), SEARCH_TYPE, SUGGEST_TYPE);
  }

  @Override
  protected MultivaluedMap<String, String> getParameterFromRequest(@Nullable NameUsageSearchRequest searchRequest) {
    MultivaluedMap<String, String> params = super.getParameterFromRequest(searchRequest);

    if (searchRequest != null) {
      params.putSingle(PARAM_EXTENDED, Boolean.toString(searchRequest.isExtended()));

      if (searchRequest.getHighlightContext() != null) {
        params.putSingle(PARAM_HIGHLIGHT_CONTEXT, Integer.toString(searchRequest.getHighlightContext()));
      }

      putFields(params, PARAM_QUERY_FIELD, searchRequest.getQueryFields());

      putFields(params, PARAM_HIGHLIGHT_FIELD, searchRequest.getHighlightFields());
    }

    return params;
  }

  private static void putFields(MultivaluedMap<String, String> params, String param, Collection<NameUsageSearchRequest.QueryField> qFields) {
    List<String>fields = Lists.newArrayList();
    for (NameUsageSearchRequest.QueryField field : qFields) {
      fields.add(field.name());
    }

    if (!fields.isEmpty()) {
      params.put(param, fields);
    }
  }
}