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
;
25 import eu
.etaxonomy
.cdm
.model
.occurrence
.SpecimenOrObservationType
;
28 * @author a.kohlbecker
33 public interface IEditGeoService
{
36 * Retrieve a parameter string to pass to an EditGeoService endpoint
37 * The endpoint will deliver a a map generated by the Edit Geo Service for the given
38 * <code>TaxonDescription</code>
40 * @param taxonDescriptions
41 * A List of <code>TaxonDescription</code> holding the distribution data
42 * @param presenceAbsenceTermColors
43 * A map that classifies which <code>PresenceAbsenceTermBase</code> should
44 * be assigned which <code>Color</code>
46 * The width of the map image
48 * The height of the map image
55 public String
getDistributionServiceRequestParameterString(
56 List
<TaxonDescription
> taxonDescriptions
,
57 Map
<PresenceAbsenceTermBase
<?
>, Color
> presenceAbsenceTermColors
,
58 int width
, int height
, String bbox
, String backLayer
,
59 List
<Language
> langs
);
64 * @param distributions
65 * @param presenceAbsenceTermColors
73 public String
getDistributionServiceRequestParameterString(Set
<Distribution
> distributions
, Map
<PresenceAbsenceTermBase
<?
>, Color
> presenceAbsenceTermColors
, int width
,
74 int height
, String bbox
, String backLayer
, List
<Language
> langs
);
78 * Retrieve a parameter string to pass to an EditGeoService endpoint
79 * The endpoint will deliver a a map generated by the Edit Geo Service for the given
80 * <code>TaxonDescription</code>
83 * The <code>TaxonDescription</code> holding the distribution data
84 * @param presenceAbsenceTermColors
85 * A map that classifies which <code>PresenceAbsenceTermBase</code> should
86 * be assigned which <code>Color</code>
88 * The width of the map image
90 * The height of the map image
96 * @deprecated use {@link #getDistributionServiceRequestParameterString(List, Map, int, int, String, String, List)} instead
99 public String
getDistributionServiceRequestParameterString(TaxonDescription description
,
100 Map
<PresenceAbsenceTermBase
<?
>,Color
> presenceAbsenceTermColors
,
105 List
<Language
> langs
);
108 public String
getOccurrenceServiceRequestParameterString(
109 List
<SpecimenOrObservationBase
> specimensOrObersvations
,
110 Map
<SpecimenOrObservationType
,Color
> specimenOrObservationTypeColors
,
111 Boolean doReturnImage
,
118 * Adds an area mapping (CDM area -> geo service area). It is recommended to set the mapping
119 * in a persistent way, so it is available after restarting the application.
121 * @param geoServiceArea
122 * @throws XMLStreamException
124 public void setMapping(NamedArea area
, GeoServiceArea geoServiceArea
);