3 * Copyright (C) 2009 EDIT
4 * European Distributed Institute of Taxonomy
5 * http://www.e-taxonomy.eu
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.
10 package eu
.etaxonomy
.cdm
.ext
.geo
;
12 import java
.awt
.Color
;
13 import java
.util
.List
;
17 import javax
.xml
.stream
.XMLStreamException
;
19 import eu
.etaxonomy
.cdm
.model
.common
.Language
;
20 import eu
.etaxonomy
.cdm
.model
.description
.Distribution
;
21 import eu
.etaxonomy
.cdm
.model
.description
.PresenceAbsenceTermBase
;
22 import eu
.etaxonomy
.cdm
.model
.description
.TaxonDescription
;
23 import eu
.etaxonomy
.cdm
.model
.location
.NamedArea
;
24 import eu
.etaxonomy
.cdm
.model
.occurrence
.SpecimenOrObservationBase
;
27 * @author a.kohlbecker
32 public interface IEditGeoService
{
35 * Retrieve a parameter string to pass to an EditGeoService endpoint
36 * The endpoint will deliver a a map generated by the Edit Geo Service for the given
37 * <code>TaxonDescription</code>
39 * @param taxonDescriptions
40 * A List of <code>TaxonDescription</code> holding the distribution data
41 * @param presenceAbsenceTermColors
42 * A map that classifies which <code>PresenceAbsenceTermBase</code> should
43 * be assigned which <code>Color</code>
45 * The width of the map image
47 * The height of the map image
54 public String
getDistributionServiceRequestParameterString(
55 List
<TaxonDescription
> taxonDescriptions
,
56 Map
<PresenceAbsenceTermBase
<?
>, Color
> presenceAbsenceTermColors
,
57 int width
, int height
, String bbox
, String backLayer
,
58 List
<Language
> langs
);
63 * @param distributions
64 * @param presenceAbsenceTermColors
72 public String
getDistributionServiceRequestParameterString(Set
<Distribution
> distributions
, Map
<PresenceAbsenceTermBase
<?
>, Color
> presenceAbsenceTermColors
, int width
,
73 int height
, String bbox
, String backLayer
, List
<Language
> langs
);
77 * Retrieve a parameter string to pass to an EditGeoService endpoint
78 * The endpoint will deliver a a map generated by the Edit Geo Service for the given
79 * <code>TaxonDescription</code>
82 * The <code>TaxonDescription</code> holding the distribution data
83 * @param presenceAbsenceTermColors
84 * A map that classifies which <code>PresenceAbsenceTermBase</code> should
85 * be assigned which <code>Color</code>
87 * The width of the map image
89 * The height of the map image
95 * @deprecated use {@link #getDistributionServiceRequestParameterString(List, Map, int, int, String, String, List)} instead
98 public String
getDistributionServiceRequestParameterString(TaxonDescription description
,
99 Map
<PresenceAbsenceTermBase
<?
>,Color
> presenceAbsenceTermColors
,
104 List
<Language
> langs
);
107 public String
getOccurrenceServiceRequestParameterString(
108 List
<SpecimenOrObservationBase
> specimensOrObersvations
,
109 Map
<Class
<?
extends SpecimenOrObservationBase
>,Color
> specimenOrObservationTypeColors
,
110 Boolean doReturnImage
,
117 * Adds an area mapping (CDM area -> geo service area). It is recommended to set the mapping
118 * in a persistent way, so it is available after restarting the application.
120 * @param geoServiceArea
121 * @throws XMLStreamException
123 public void setMapping(NamedArea area
, GeoServiceArea geoServiceArea
);