Project

General

Profile

Download (3.26 KB) Statistics
| Branch: | Tag: | Revision:
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;
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.taxon.Taxon;
20

    
21
/**
22
 * @author a.kohlbecker
23
 * @date 18.06.2009
24
 * @author n.hoffmann
25
 *
26
 */
27
public interface IEditGeoService {
28
	
29
	/**
30
	 * Retrieve a parameter string to pass to an EditGeoService endpoint
31
	 * The endpoint will deliver a  a map generated by the Edit Geo Service for the given
32
	 * <code>TaxonDescription</code>
33
	 * 
34
	 * @param taxonDescriptions
35
	 * 			A List of <code>TaxonDescription</code> holding the distribution data
36
	 * @param presenceAbsenceTermColors
37
	 * 			A map that classifies which <code>PresenceAbsenceTermBase</code> should 
38
	 * 			be assigned which <code>Color</code>
39
	 * @param width
40
	 * 			The width of the map image
41
	 * @param height
42
	 * 			The height of the map image
43
	 * @param bbox
44
	 * 			
45
	 * @param backLayer
46
	 * @return
47
	 * 			
48
	 */
49
	public String getEditGeoServiceUrlParameterString(
50
			List<TaxonDescription> taxonDescriptions,
51
			Map<PresenceAbsenceTermBase<?>, Color> presenceAbsenceTermColors,
52
			int width, int height, String bbox, String backLayer,
53
			List<Language> langs);
54

    
55
	/**
56
	 * Retrieve a parameter string to pass to an EditGeoService endpoint
57
	 * The endpoint will deliver a  a map generated by the Edit Geo Service for the given
58
	 * <code>TaxonDescription</code>
59
	 * 
60
	 * @param description
61
	 * 			The <code>TaxonDescription</code> holding the distribution data
62
	 * @param presenceAbsenceTermColors
63
	 * 			A map that classifies which <code>PresenceAbsenceTermBase</code> should 
64
	 * 			be assigned which <code>Color</code>
65
	 * @param width
66
	 * 			The width of the map image
67
	 * @param height
68
	 * 			The height of the map image
69
	 * @param bbox
70
	 * 			
71
	 * @param backLayer
72
	 * @return
73
	 * 			
74
	 */
75
	public String getEditGeoServiceUrlParameterString(TaxonDescription description, 
76
			Map<PresenceAbsenceTermBase<?>,Color> presenceAbsenceTermColors, 
77
			int width, 
78
			int height, 
79
			String bbox, 
80
			String backLayer,
81
			List<Language> langs);
82
	
83
	/**
84
	 * 
85
	 * 
86
	 * @param taxon
87
	 * @param presenceAbsenceTermColors
88
	 * @param width
89
	 * @param height
90
	 * @param bbox
91
	 * @param backLayer
92
	 * @return
93
	 * @deprecated 
94
	 * 			this method throws all distribution data from all taxon descriptions in one big pot 
95
	 * 			and returns a map based on this data. However this might be useful for certain 
96
	 * 			use cases it does not really make sense to mix data from different taxon descriptions.
97
	 * 			Why have they been separated in the first place?
98
	 * 
99
	 */
100
	@Deprecated
101
	public String getEditGeoServiceUrlParameterString(Taxon taxon, 
102
			Map<PresenceAbsenceTermBase<?>,Color> presenceAbsenceTermColors, 
103
			int width, 
104
			int height, 
105
			String bbox, 
106
			String backLayer,
107
			List<Language> langs);
108
}
(3-3/3)