1 /*
2 * Copyright (c) 2002-2022, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.plugins.genericattributes.business;
35
36 import java.io.Serializable;
37
38 import fr.paris.lutece.util.ReferenceItem;
39 import fr.paris.lutece.util.ReferenceList;
40
41 /**
42 *
43 * IMapProvider : map provider for Geolocation <br >
44 * <ul>
45 * <li><code>getKey( )</code> must return the unique key.</li>
46 * <li><code>getDisplayedName( )</code> will be displayed in reference lists.</li>
47 * </ul>
48 */
49 public interface ICartoProvider extends Serializable
50 {
51 /**
52 * Gets the key. This key <b>must be unique</b>.
53 *
54 * @return the key;
55 */
56 String getKey( );
57
58 /**
59 * Gets the displayed name
60 *
61 * @return the displayed name
62 */
63 String getDisplayedName( );
64
65 /**
66 * Gets the html template
67 *
68 * @return the html template
69 */
70 String getHtmlCode( );
71
72 /**
73 * Builds a new {@link ReferenceItem} for the map provider.<br >
74 * <code>key == getKey( )</code>, <code>value == getDisplayedName( )</code>
75 *
76 * @return the item created.
77 */
78 ReferenceItem toRefItem( );
79
80 /**
81 * returns the Parameter class contains all the parameters of the map
82 *
83 * @return the Parameter
84 */
85 Object getParameter( int nKey );
86
87 /**
88 * returns the reference list contains all the map
89 *
90 * @return the referencelist
91 */
92 ReferenceList getMapProvidersRefList( );
93
94 /**
95 * returns the json of the geolocitemPoint
96 *
97 * @return the json of the geolocitemPoint
98 */
99 String getGeolocItemPoint( Double x, Double y, String adresse );
100
101 /**
102 * returns the json of the geolocitemPolygon
103 *
104 * @return the json of the geolocitemPolygon
105 */
106 String getGeolocItemPolygon( String coordinate );
107
108 /**
109 * returns the json of the geolocitemPolyline
110 *
111 * @return the json of the geolocitemPolyline
112 */
113 String getGeolocItemPolyline( String coordinate );
114
115 /**
116 * returns the solr tag
117 *
118 * @return the solr tag
119 */
120 String getSolrTag( String strIdLayer );
121 }