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.pluginwizard.service.generator;
35
36 import fr.paris.lutece.plugins.pluginwizard.business.model.PluginModel;
37 import fr.paris.lutece.portal.service.template.AppTemplateService;
38 import fr.paris.lutece.util.html.HtmlTemplate;
39
40 import java.util.HashMap;
41 import java.util.Locale;
42 import java.util.Map;
43
44 /**
45 * Abstract Generator
46 */
47 public abstract class AbstractFileGenerator extends AbstractGenerator
48 {
49 // Variables declarations
50 private String _strPath;
51
52 /**
53 * Get the filename
54 *
55 * @param pm
56 * The plugin model
57 * @return The filename
58 */
59 protected abstract String getFilename( PluginModel pm );
60
61 /**
62 * Returns the Path
63 *
64 * @return The Path
65 */
66 public String getPath( )
67 {
68 return _strPath;
69 }
70
71 /**
72 * Sets the Path
73 *
74 * @param strPath
75 * The Path
76 */
77 public void setPath( String strPath )
78 {
79 _strPath = strPath;
80 }
81
82 /**
83 * Produces the code
84 *
85 * @param pm
86 * the plugin model
87 * @return the code
88 */
89 protected String getCode( PluginModel pm, String generationSchemeName )
90 {
91 Map<String, Object> model = new HashMap<>( );
92 model.put( Markers.MARK_PLUGIN, pm );
93 model.put( Markers.MARK_LIST_PORTLETS, pm.getPortlets( ) );
94 model.put( Markers.MARK_BUSINESS_CLASSES, pm.getBusinessClasses( ) );
95
96 HtmlTemplate template = AppTemplateService.getTemplate( getTemplate( ), Locale.getDefault( ), model );
97
98 return template.getHtml( );
99 }
100
101 /**
102 * Produces the code
103 *
104 * @param pm
105 * the plugin model
106 * @return the code
107 */
108 protected String getFilePath( PluginModel pm )
109 {
110 return getFilePath( pm, getPath( ), getFilename( pm ) );
111 }
112
113 /**
114 * Produces the file code in a map
115 *
116 * @param pm
117 * , generationSchemeName the plugin model and the generation scheme name
118 * @return the map
119 */
120 protected Map generateFile( PluginModel pm, String generationSchemeName )
121 {
122 HashMap map = new HashMap( );
123 map.put( getFilePath( pm ), getCode( pm, generationSchemeName ) );
124
125 return map;
126 }
127 }