1 /*
2 * Copyright (c) 2002-2025, 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
35 package fr.paris.lutece.plugins.pluginwizard.service.generator;
36
37 import fr.paris.lutece.plugins.pluginwizard.business.model.PluginModel;
38
39 import java.util.HashMap;
40 import java.util.Map;
41
42 /**
43 *
44 * This class generates Web component class (naming convention: [TaskName]Component, Located in the web directory.)
45 * that handles the integration between task forms (configuration and execution) and the TaskConfig object in a Lutece workflow plugin.
46 * It serves as a bridge between the web interface and the task configuration business logic.
47 *
48 */
49 public class TaskComponentGenerator extends AbstractGenerator
50 {
51
52 private static final String PATH = "src/java/fr/paris/lutece/plugins/workflow/modules/{plugin_name}/web/";
53 private static final String EXT = "Component.java";
54
55 /**
56 * {@inheritDoc }
57 */
58 @Override
59 public Map<String, String> generate( PluginModel pm, String generationSchemeName )
60 {
61
62 HashMap<String, String> map = new HashMap<>( );
63
64 String strFileName = pm.getConfiguration( ).getWorkflowTaskName( ) + EXT;
65 String strPath = getFilePath( pm, PATH, strFileName );
66
67 String strSourceCode = getCode( pm );
68 strSourceCode = strSourceCode.replace( "<", "<" );
69 strSourceCode = strSourceCode.replace( ">", ">" );
70
71 map.put( strPath, strSourceCode );
72
73 return map;
74 }
75
76 /**
77 * Produces the file code in a string
78 *
79 * @param pm
80 *
81 * @return the string
82 */
83 protected String getCode( PluginModel pm )
84 {
85 Map<String, Object> model = new HashMap<>( );
86 model.put( Markers.MARK_PLUGIN, pm );
87 model.put( Markers.MARK_RADICAL_PACKAGE, pm.getPluginNameAsRadicalPackage( ) );
88 model.put( Markers.MARK_TASK_NAME, pm.getConfiguration( ).getWorkflowTaskName( ) );
89 model.put( Markers.MARK_CONFIGURATION, pm.getConfiguration( ) );
90
91 return build( model );
92 }
93 }