X-Git-Url: https://dev.e-taxonomy.eu/gitweb/cdmlib.git/blobdiff_plain/8621e56a49fa044b54224c1a263a8aceec0937b8..fe3d023fce484d02ce1c8da54979fe2ad983d5ca:/cdmlib-remote/src/main/java/eu/etaxonomy/cdm/remote/controller/TaxonListController.java

diff --git a/cdmlib-remote/src/main/java/eu/etaxonomy/cdm/remote/controller/TaxonListController.java b/cdmlib-remote/src/main/java/eu/etaxonomy/cdm/remote/controller/TaxonListController.java
index 3433f501cb..6b8679a91d 100644
--- a/cdmlib-remote/src/main/java/eu/etaxonomy/cdm/remote/controller/TaxonListController.java
+++ b/cdmlib-remote/src/main/java/eu/etaxonomy/cdm/remote/controller/TaxonListController.java
@@ -12,6 +12,9 @@ package eu.etaxonomy.cdm.remote.controller;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collection;
+import java.util.EnumSet;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
 import java.util.UUID;
@@ -19,9 +22,13 @@ import java.util.UUID;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
+import org.apache.commons.lang.BooleanUtils;
 import org.apache.lucene.queryParser.ParseException;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.WebDataBinder;
+import org.springframework.web.bind.annotation.InitBinder;
+import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.bind.annotation.RequestParam;
@@ -29,14 +36,17 @@ import org.springframework.web.bind.annotation.RequestParam;
 import eu.etaxonomy.cdm.api.service.IClassificationService;
 import eu.etaxonomy.cdm.api.service.ITaxonService;
 import eu.etaxonomy.cdm.api.service.ITermService;
-import eu.etaxonomy.cdm.api.service.config.IFindTaxaAndNamesConfigurator;
+import eu.etaxonomy.cdm.api.service.TaxaAndNamesSearchMode;
 import eu.etaxonomy.cdm.api.service.config.FindTaxaAndNamesConfiguratorImpl;
+import eu.etaxonomy.cdm.api.service.config.IFindTaxaAndNamesConfigurator;
 import eu.etaxonomy.cdm.api.service.pager.Pager;
+import eu.etaxonomy.cdm.api.service.search.LuceneMultiSearchException;
 import eu.etaxonomy.cdm.api.service.search.SearchResult;
 import eu.etaxonomy.cdm.model.common.IdentifiableEntity;
 import eu.etaxonomy.cdm.model.common.Language;
 import eu.etaxonomy.cdm.model.description.DescriptionElementBase;
 import eu.etaxonomy.cdm.model.description.Feature;
+import eu.etaxonomy.cdm.model.description.PresenceAbsenceTermBase;
 import eu.etaxonomy.cdm.model.location.NamedArea;
 import eu.etaxonomy.cdm.model.taxon.Classification;
 import eu.etaxonomy.cdm.model.taxon.Synonym;
@@ -45,6 +55,8 @@ import eu.etaxonomy.cdm.model.taxon.TaxonBase;
 import eu.etaxonomy.cdm.persistence.query.MatchMode;
 import eu.etaxonomy.cdm.persistence.query.OrderHint;
 import eu.etaxonomy.cdm.remote.controller.util.PagerParameters;
+import eu.etaxonomy.cdm.remote.editor.DefinedTermBaseList;
+import eu.etaxonomy.cdm.remote.editor.TermBaseListPropertyEditor;
 import eu.etaxonomy.cdm.remote.editor.UuidList;
 
 /**
@@ -58,6 +70,11 @@ import eu.etaxonomy.cdm.remote.editor.UuidList;
 public class TaxonListController extends IdentifiableListController<TaxonBase, ITaxonService> {
 
 
+    private static final List<String> SIMPLE_TAXON_INIT_STRATEGY = DEFAULT_INIT_STRATEGY;
+    protected List<String> getSimpleTaxonInitStrategy() {
+        // TODO Auto-generated method stub
+        return SIMPLE_TAXON_INIT_STRATEGY;
+    }
 
     /**
      *
@@ -82,6 +99,103 @@ public class TaxonListController extends IdentifiableListController<TaxonBase, I
     @Autowired
     private ITermService termService;
 
+    @InitBinder
+    @Override
+    public void initBinder(WebDataBinder binder) {
+        super.initBinder(binder);
+        binder.registerCustomEditor(DefinedTermBaseList.class, new TermBaseListPropertyEditor<NamedArea>(termService));
+    }
+
+    /**
+     * Find Taxa, Synonyms, Common Names by name, either globally or in a specific geographic area.
+     * <p>
+     * URI: <b>&#x002F;{datasource-name}&#x002F;portal&#x002F;taxon&#x002F;find</b>
+     *
+     * @param query
+     *            the string to query for. Since the wildcard character '*'
+     *            internally always is appended to the query string, a search
+     *            always compares the query string with the beginning of a name.
+     *            - <i>required parameter</i>
+     * @param treeUuid
+     *            the {@link UUID} of a {@link Classification} to which the
+     *            search is to be restricted. - <i>optional parameter</i>
+     * @param areas
+     *            restrict the search to a set of geographic {@link NamedArea}s.
+     *            The parameter currently takes a list of TDWG area labels.
+     *            - <i>optional parameter</i>
+     * @param pageNumber
+     *            the number of the page to be returned, the first page has the
+     *            pageNumber = 1 - <i>optional parameter</i>
+     * @param pageSize
+     *            the maximum number of entities returned per page (can be -1
+     *            to return all entities in a single page) - <i>optional parameter</i>
+     * @param doTaxa
+     *            weather to search for instances of {@link Taxon} - <i>optional parameter</i>
+     * @param doSynonyms
+     *            weather to search for instances of {@link Synonym} - <i>optional parameter</i>
+     * @param doTaxaByCommonNames
+     *            for instances of {@link Taxon} by a common name used - <i>optional parameter</i>
+     * @return a Pager on a list of {@link IdentifiableEntity}s initialized by
+     *         the following strategy {@link #SIMPLE_TAXON_INIT_STRATEGY}
+     * @throws IOException
+     * @throws LuceneMultiSearchException
+     * @throws ParseException
+     */
+    @RequestMapping(method = RequestMethod.GET, value={"search"})
+    public Pager<SearchResult<TaxonBase>> doSearch(
+            @RequestParam(value = "query", required = true) String query,
+            @RequestParam(value = "tree", required = false) UUID treeUuid,
+            @RequestParam(value = "area", required = false) DefinedTermBaseList<NamedArea> areaList,
+            @RequestParam(value = "status", required = false) Set<PresenceAbsenceTermBase<?>> status,
+            @RequestParam(value = "pageNumber", required = false) Integer pageNumber,
+            @RequestParam(value = "pageSize", required = false) Integer pageSize,
+            @RequestParam(value = "doTaxa", required = false) Boolean doTaxa,
+            @RequestParam(value = "doSynonyms", required = false) Boolean doSynonyms,
+            @RequestParam(value = "doMisappliedNames", required = false) Boolean doMisappliedNames,
+            @RequestParam(value = "doTaxaByCommonNames", required = false) Boolean doTaxaByCommonNames,
+            HttpServletRequest request,
+            HttpServletResponse response
+            )
+             throws IOException, ParseException, LuceneMultiSearchException {
+
+
+        logger.info("search : " + requestPathAndQuery(request) );
+
+        Set<NamedArea> areaSet = null;
+        if(areaList != null){
+            areaSet = new HashSet<NamedArea>(areaList.size());
+            areaSet.addAll(areaList);
+            TaxonListController.includeAllSubAreas(areaSet, termService);
+        }
+
+        PagerParameters pagerParams = new PagerParameters(pageSize, pageNumber);
+        pagerParams.normalizeAndValidate(response);
+
+        // TODO change type of do* parameters  to TaxaAndNamesSearchMode
+        EnumSet<TaxaAndNamesSearchMode> searchModes = EnumSet.noneOf(TaxaAndNamesSearchMode.class);
+        if(BooleanUtils.toBoolean(doTaxa)) {
+            searchModes.add(TaxaAndNamesSearchMode.doTaxa);
+        }
+        if(BooleanUtils.toBoolean(doSynonyms)) {
+            searchModes.add(TaxaAndNamesSearchMode.doSynonyms);
+        }
+        if(BooleanUtils.toBoolean(doMisappliedNames)) {
+            searchModes.add(TaxaAndNamesSearchMode.doMisappliedNames);
+        }
+        if(BooleanUtils.toBoolean(doTaxaByCommonNames)) {
+            searchModes.add(TaxaAndNamesSearchMode.doTaxaByCommonNames);
+        }
+
+        Classification classification = null;
+        if(treeUuid != null){
+            classification = classificationService.find(treeUuid);
+        }
+
+        return service.findTaxaAndNamesByFullText(searchModes, query,
+                classification, areaSet, status, null,
+                false, pagerParams.getPageSize(), pagerParams.getPageIndex(),
+                OrderHint.NOMENCLATURAL_SORT_ORDER, getSimpleTaxonInitStrategy());
+    }
 
     /**
      * Find Taxa, Synonyms, Common Names by name, either globally or in a specific geographic area.
@@ -118,8 +232,8 @@ public class TaxonListController extends IdentifiableListController<TaxonBase, I
      *         the following strategy {@link #SIMPLE_TAXON_INIT_STRATEGY}
      * @throws IOException
      */
-    @RequestMapping(method = RequestMethod.GET, value={"findTaxaAndNames"})
-    public Pager<IdentifiableEntity> doFindTaxaAndNames(
+    @RequestMapping(method = RequestMethod.GET, value={"find"})
+    public Pager<IdentifiableEntity> doFind(
             @RequestParam(value = "query", required = true) String query,
             @RequestParam(value = "tree", required = false) UUID treeUuid,
             @RequestParam(value = "area", required = false) Set<NamedArea> areas,
@@ -136,15 +250,12 @@ public class TaxonListController extends IdentifiableListController<TaxonBase, I
              throws IOException {
 
 
-        logger.info("findTaxaAndNames : " + request.getRequestURI() + "?" + request.getQueryString() );
+        logger.info("find : " + request.getRequestURI() + "?" + request.getQueryString() );
 
         PagerParameters pagerParams = new PagerParameters(pageSize, pageNumber);
         pagerParams.normalizeAndValidate(response);
 
         IFindTaxaAndNamesConfigurator config = new FindTaxaAndNamesConfiguratorImpl();
-
-        config.setTaxonPropertyPath(initializationStrategy);
-
         config.setPageNumber(pagerParams.getPageIndex());
         config.setPageSize(pagerParams.getPageSize());
         config.setTitleSearchString(query);
@@ -153,17 +264,18 @@ public class TaxonListController extends IdentifiableListController<TaxonBase, I
         config.setDoMisappliedNames(doMisappliedNames != null ? doMisappliedNames : Boolean.FALSE);
         config.setDoTaxaByCommonNames(doTaxaByCommonNames != null ? doTaxaByCommonNames : Boolean.FALSE );
         config.setMatchMode(matchMode != null ? matchMode : MatchMode.BEGINNING);
-//        config.setTaxonPropertyPath(SIMPLE_TAXON_INIT_STRATEGY);
+        config.setTaxonPropertyPath(getSimpleTaxonInitStrategy());
         config.setNamedAreas(areas);
         if(treeUuid != null){
             Classification classification = classificationService.find(treeUuid);
             config.setClassification(classification);
         }
 
-        return (Pager<IdentifiableEntity>) service.findTaxaAndNames(config);
+        return service.findTaxaAndNames(config);
 
     }
 
+
     /**
      * @param clazz
      * @param queryString
@@ -179,7 +291,7 @@ public class TaxonListController extends IdentifiableListController<TaxonBase, I
      */
     @RequestMapping(method = RequestMethod.GET, value={"findByDescriptionElementFullText"})
     public Pager<SearchResult<TaxonBase>> dofindByDescriptionElementFullText(
-            @RequestParam(value = "clazz", required = false) Class clazz,
+            @RequestParam(value = "clazz", required = false) Class<? extends DescriptionElementBase> clazz,
             @RequestParam(value = "query", required = true) String queryString,
             @RequestParam(value = "tree", required = false) UUID treeUuid,
             @RequestParam(value = "features", required = false) UuidList featureUuids,
@@ -192,7 +304,7 @@ public class TaxonListController extends IdentifiableListController<TaxonBase, I
             )
              throws IOException, ParseException {
 
-         logger.info("findByDescriptionElementFullText : " + request.getRequestURI() + "?" + request.getQueryString() );
+         logger.info("findByDescriptionElementFullText : " + requestPathAndQuery(request) );
 
          PagerParameters pagerParams = new PagerParameters(pageSize, pageNumber);
          pagerParams.normalizeAndValidate(response);
@@ -214,7 +326,109 @@ public class TaxonListController extends IdentifiableListController<TaxonBase, I
             }
         }
 
-        Pager<SearchResult<TaxonBase>> pager = service.findByDescriptionElementFullText(clazz, queryString, classification, features, languages, highlighting, pagerParams.getPageSize(), pagerParams.getPageIndex(), ((List<OrderHint>)null), initializationStrategy);
+        Pager<SearchResult<TaxonBase>> pager = service.findByDescriptionElementFullText(
+                clazz, queryString, classification, features, languages, highlighting,
+                pagerParams.getPageSize(), pagerParams.getPageIndex(),
+                ((List<OrderHint>)null), getSimpleTaxonInitStrategy());
+        return pager;
+    }
+
+    @RequestMapping(method = RequestMethod.GET, value={"findByFullText"})
+    public Pager<SearchResult<TaxonBase>> dofindByFullText(
+            @RequestParam(value = "clazz", required = false) Class<? extends TaxonBase> clazz,
+            @RequestParam(value = "query", required = true) String queryString,
+            @RequestParam(value = "tree", required = false) UUID treeUuid,
+            @RequestParam(value = "languages", required = false) List<Language> languages,
+            @RequestParam(value = "hl", required = false) Boolean highlighting,
+            @RequestParam(value = "pageNumber", required = false) Integer pageNumber,
+            @RequestParam(value = "pageSize", required = false) Integer pageSize,
+            HttpServletRequest request,
+            HttpServletResponse response
+            )
+             throws IOException, ParseException {
+
+         logger.info("findByFullText : " + requestPathAndQuery(request)  );
+
+         PagerParameters pagerParams = new PagerParameters(pageSize, pageNumber);
+         pagerParams.normalizeAndValidate(response);
+
+         if(highlighting == null){
+             highlighting = false;
+         }
+
+         Classification classification = null;
+        if(treeUuid != null){
+            classification = classificationService.find(treeUuid);
+        }
+
+        Pager<SearchResult<TaxonBase>> pager = service.findByFullText(clazz, queryString, classification, languages,
+                highlighting, pagerParams.getPageSize(), pagerParams.getPageIndex(), ((List<OrderHint>)  null),
+                initializationStrategy);
+        return pager;
+    }
+
+    @RequestMapping(method = RequestMethod.GET, value={"findByEverythingFullText"})
+    public Pager<SearchResult<TaxonBase>> dofindByEverythingFullText(
+            @RequestParam(value = "clazz", required = false) Class<? extends TaxonBase> clazz,
+            @RequestParam(value = "query", required = true) String queryString,
+            @RequestParam(value = "tree", required = false) UUID treeUuid,
+            @RequestParam(value = "languages", required = false) List<Language> languages,
+            @RequestParam(value = "hl", required = false) Boolean highlighting,
+            @RequestParam(value = "pageNumber", required = false) Integer pageNumber,
+            @RequestParam(value = "pageSize", required = false) Integer pageSize,
+            HttpServletRequest request,
+            HttpServletResponse response
+            )
+             throws IOException, ParseException, LuceneMultiSearchException {
+
+         logger.info("findByEverythingFullText : " + requestPathAndQuery(request) );
+
+         PagerParameters pagerParams = new PagerParameters(pageSize, pageNumber);
+         pagerParams.normalizeAndValidate(response);
+
+         if(highlighting == null){
+             highlighting = false;
+         }
+
+         Classification classification = null;
+        if(treeUuid != null){
+            classification = classificationService.find(treeUuid);
+        }
+
+        Pager<SearchResult<TaxonBase>> pager = service.findByEverythingFullText(
+                queryString, classification, languages, highlighting,
+                pagerParams.getPageSize(), pagerParams.getPageIndex(),
+                ((List<OrderHint>)null), initializationStrategy);
         return pager;
     }
+
+    /**
+     * @param areaSet
+     */
+    static public void includeAllSubAreas(Set<NamedArea> areaSet, ITermService termService) {
+        Collection<NamedArea> tmpAreas = new HashSet<NamedArea>(areaSet);
+        // expand all areas to include also the sub areas
+        Pager<NamedArea> pager = null;
+        while(true){
+            pager = termService.getIncludes(tmpAreas, 1000, null, null);
+            if(pager.getCount() == 0){
+                break;
+            }
+            tmpAreas = pager.getRecords();
+            tmpAreas.removeAll(areaSet);
+            areaSet.addAll(tmpAreas);
+        }
+    }
+
+    @RequestMapping(value = "bestMatchingTaxon/{taxonName}", method = RequestMethod.GET)
+    public TaxonBase doFindBestMatchingTaxon(
+             @PathVariable("taxonName") String taxonName,
+            HttpServletRequest request,
+            HttpServletResponse response)throws IOException {
+
+        Taxon bestMatchingTaxon =  service.findBestMatchingTaxon(taxonName);
+
+        return bestMatchingTaxon;
+    }
+
 }
\ No newline at end of file