1 /*
2 * Copyright (c) 2002-2017, Mairie de 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.directory.modules.gis.service;
35
36 import fr.paris.lutece.plugins.directory.business.IMapProvider;
37 import fr.paris.lutece.portal.service.util.AppPropertiesService;
38 import fr.paris.lutece.util.ReferenceItem;
39
40
41 /**
42 *
43 * GisProvider : provides Gis support for Directory
44 *
45 */
46 public class GisProvider implements IMapProvider
47 {
48 private static final String PROPERTY_KEY = "directory-gis.key";
49 private static final String PROPERTY_DISPLAYED_NAME = "directory-gis.displayName";
50 private static final String TEMPLATE_HTML = "../modules/gis/GisTemplate.html";
51 private static final String TEMPLATE_FRONT_HTML = "modules/gis/GisTemplate.html";
52 private static final String TEMPLATE_FRONT_LIST_HTML = "modules/gis/GisListTemplate.html";
53 private static final String TEMPLATE_BACK_LIST_HTML = "modules/gis/GisListTemplate.html";
54
55 private static final boolean CONSTANT_MAP_LIST_SUPPORTED = true;
56
57 /**
58 * {@inheritDoc}
59 */
60 public String getKey( )
61 {
62 return AppPropertiesService.getProperty( PROPERTY_KEY );
63 }
64
65 /**
66 * {@inheritDoc}
67 */
68 public String getDisplayedName( )
69 {
70 return AppPropertiesService.getProperty( PROPERTY_DISPLAYED_NAME );
71 }
72
73 /**
74 * {@inheritDoc}
75 */
76 public String getHtmlCode( )
77 {
78 return TEMPLATE_HTML;
79 }
80
81 /**
82 * {@inheritDoc}
83 */
84 public ReferenceItem toRefItem( )
85 {
86 ReferenceItem refItem = new ReferenceItem( );
87
88 refItem.setCode( getKey( ) );
89 refItem.setName( getDisplayedName( ) );
90
91 return refItem;
92 }
93
94 /**
95 * {@inheritDoc}
96 */
97 @Override
98 public String toString( )
99 {
100 return "Directory Provider";
101 }
102
103 /**
104 * {@inheritDoc}
105 */
106 public String getFrontHtmlCode( )
107 {
108 return TEMPLATE_FRONT_HTML;
109 }
110
111 /**
112 * {@inheritDoc}
113 */
114 public String getFrontListHtmlCode( )
115 {
116 return TEMPLATE_FRONT_LIST_HTML;
117 }
118
119 /**
120 * {@inheritDoc}
121 */
122 public String getBackListHtmlCode( )
123 {
124 return TEMPLATE_BACK_LIST_HTML;
125 }
126
127 /**
128 * {@inheritDoc}
129 */
130 public boolean isMapListSupported( )
131 {
132 return CONSTANT_MAP_LIST_SUPPORTED;
133 }
134
135 /**
136 * {@inheritDoc}
137 */
138 public Object getParameter( int nKey )
139 {
140 return null;
141 }
142 }