cdmlib-ext/src/main/java/eu/etaxonomy/cdm/ext/geo/IEditGeoService.java

   1 // $Id$
   2 /**
   3 * Copyright (C) 2009 EDIT
   4 * European Distributed Institute of Taxonomy
   5 * http://www.e-taxonomy.eu
   6 *
   7 * The contents of this file are subject to the Mozilla Public License Version 1.1
   8 * See LICENSE.TXT at the top of this package for the full license terms.
   9 */
  10 package eu.etaxonomy.cdm.ext.geo;
  11
  12 import java.awt.Color;
  13 import java.util.List;
  14 import java.util.Map;
  15
  16 import eu.etaxonomy.cdm.model.common.Language;
  17 import eu.etaxonomy.cdm.model.description.PresenceAbsenceTermBase;
  18 import eu.etaxonomy.cdm.model.description.TaxonDescription;
  19 import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;
  20 import eu.etaxonomy.cdm.model.taxon.Taxon;
  21
  22 /**
  23  * @author a.kohlbecker
  24  * @date 18.06.2009
  25  * @author n.hoffmann
  26  *
  27  */
  28 public interface IEditGeoService {
  29
  30         /**
  31          * Retrieve a parameter string to pass to an EditGeoService endpoint
  32          * The endpoint will deliver a  a map generated by the Edit Geo Service for the given
  33          * <code>TaxonDescription</code>
  34          *
  35          * @param taxonDescriptions
  36          *                      A List of <code>TaxonDescription</code> holding the distribution data
  37          * @param presenceAbsenceTermColors
  38          *                      A map that classifies which <code>PresenceAbsenceTermBase</code> should
  39          *                      be assigned which <code>Color</code>
  40          * @param width
  41          *                      The width of the map image
  42          * @param height
  43          *                      The height of the map image
  44          * @param bbox
  45          *
  46          * @param backLayer
  47          * @return
  48          *
  49          */
  50         public String getDistributionServiceRequestParameterString(
  51                         List<TaxonDescription> taxonDescriptions,
  52                         Map<PresenceAbsenceTermBase<?>, Color> presenceAbsenceTermColors,
  53                         int width, int height, String bbox, String backLayer,
  54                         List<Language> langs);
  55
  56         /**
  57          * Retrieve a parameter string to pass to an EditGeoService endpoint
  58          * The endpoint will deliver a  a map generated by the Edit Geo Service for the given
  59          * <code>TaxonDescription</code>
  60          *
  61          * @param description
  62          *                      The <code>TaxonDescription</code> holding the distribution data
  63          * @param presenceAbsenceTermColors
  64          *                      A map that classifies which <code>PresenceAbsenceTermBase</code> should
  65          *                      be assigned which <code>Color</code>
  66          * @param width
  67          *                      The width of the map image
  68          * @param height
  69          *                      The height of the map image
  70          * @param bbox
  71          *
  72          * @param backLayer
  73          * @return
  74          *
  75          */
  76         public String getDistributionServiceRequestParameterString(TaxonDescription description,
  77                         Map<PresenceAbsenceTermBase<?>,Color> presenceAbsenceTermColors,
  78                         int width,
  79                         int height,
  80                         String bbox,
  81                         String backLayer,
  82                         List<Language> langs);
  83
  84         /**
  85          *
  86          *
  87          * @param taxon
  88          * @param presenceAbsenceTermColors
  89          * @param width
  90          * @param height
  91          * @param bbox
  92          * @param backLayer
  93          * @return
  94          * @deprecated
  95          *                      this method throws all distribution data from all taxon descriptions in one big pot
  96          *                      and returns a map based on this data. However this might be useful for certain
  97          *                      use cases it does not really make sense to mix data from different taxon descriptions.
  98          *                      Why have they been separated in the first place?
  99          *
 100          */
 101         @Deprecated
 102         public String getDistributionServiceRequestParameterString(Taxon taxon,
 103                         Map<PresenceAbsenceTermBase<?>,Color> presenceAbsenceTermColors,
 104                         int width,
 105                         int height,
 106                         String bbox,
 107                         String backLayer,
 108                         List<Language> langs);
 109
 110
 111         public String getOccurrenceServiceRequestParameterString(
 112                         List<SpecimenOrObservationBase> specimensOrObersvations,
 113                         Map<Class<? extends SpecimenOrObservationBase>,Color> specimenOrObservationTypeColors,
 114                         Boolean doReturnImage,
 115                         Integer width,
 116                         Integer height,
 117                         String bbox,
 118                         String backLayer);
 119
 120 }