View Javadoc
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.BusinessClass;
37  import fr.paris.lutece.plugins.pluginwizard.business.model.PluginModel;
38  import java.util.ArrayList;
39  import java.util.Collection;
40  import java.util.HashMap;
41  import java.util.List;
42  import java.util.Map;
43  
44  /**
45   *
46   * The business classes representing the business layer of the plugin is generated
47   *
48   */
49  public class BusinessClassGenerator extends AbstractGenerator
50  {
51      private static final String PATH = "SOURCE/java/fr/paris/lutece/plugins/";
52      private static final String PATH_SUFFIX = "/business/";
53      private List<BusinessFileConfig> _listFiles;
54  
55      /**
56       * Set the list of files config
57       * 
58       * @param listFiles
59       *            The list of files
60       */
61      public void setFiles( List<BusinessFileConfig> listFiles )
62      {
63          if ( listFiles != null )
64          {
65              _listFiles = (List<BusinessFileConfig>) ( ( (ArrayList<BusinessFileConfig>) listFiles ).clone( ) );
66          }
67          else
68          {
69              _listFiles = null;
70          }
71      }
72  
73      /**
74       * {@inheritDoc }
75       */
76      @Override
77      public Map<String, String> generate( PluginModel pm, String generationSchemeName )
78      {
79          HashMap<String, String> map = new HashMap<>( );
80          Collection<BusinessClass> listAllBusinessClasses = pm.getBusinessClasses( );
81  
82          String strPluginName = pm.getPluginNameAsPackage( );
83          String strRadicalPackage = pm.getPluginNameAsRadicalPackage( );
84          String strRadicalPath = pm.getPluginNameAsRadicalPath( );
85  
86          for ( BusinessClass businessClass : listAllBusinessClasses )
87          {
88              for ( BusinessFileConfig file : _listFiles )
89              {
90                  String strClassName = file.getPrefix( ) + businessClass.getBusinessClass( ) + file.getSuffix( );
91                  String strFilename = strClassName + ".java";
92                  String strSourceCode = getSourceCode( strPluginName, businessClass, file.getTemplate( ), strRadicalPackage, pm.getPluginName( ) );
93                  strSourceCode = strSourceCode.replace( "&lt;", "<" );
94                  strSourceCode = strSourceCode.replace( "&gt;", ">" );
95                  strSourceCode = strSourceCode.replace( "@i18n", "#i18n" );
96  
97                  String strPath = PATH.replace( "SOURCE", file.getSourcePath( ) ) + strRadicalPath + PATH_SUFFIX;
98  
99                  map.put( getFilePath( pm, strPath, strFilename ), strSourceCode );
100             }
101         }
102 
103         return map;
104     }
105 
106     /**
107      * Returns the source code of a business object
108      * 
109      * @param strPluginName
110      *            The plugin name
111      * @param businessClass
112      *            The business class
113      * @param strTemplate
114      *            The type of generation(DAO,Home,etc)
115      * @return The java source code of the business object
116      */
117     private String getSourceCode( String strPluginName, BusinessClass businessClass, String strTemplate, String strRadicalPackage, String strBeanName )
118     {
119         Map<String, Object> model = new HashMap<>( );
120         model.put( Markers.MARK_BUSINESS_CLASS, businessClass );
121         model.put( Markers.MARK_PLUGIN_NAME, strPluginName );
122         model.put( Markers.MARK_RADICAL_PACKAGE, strRadicalPackage );
123         model.put( Markers.MARK_BEAN_NAME, strBeanName );
124 
125         return build( strTemplate, model );
126     }
127 }