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