1 /*
2 * Copyright (c) 2002-2021, 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.regularexpression.business;
35
36 import fr.paris.lutece.portal.business.regularexpression.RegularExpression;
37 import fr.paris.lutece.portal.service.plugin.Plugin;
38 import fr.paris.lutece.portal.service.spring.SpringContextService;
39
40 import java.util.List;
41
42 /**
43 * This class provides instances management methods (create, find, ...) for RegularExpression objects
44 */
45 public final class RegularExpressionHome
46 {
47 // Static variable pointed at the DAO instance
48 private static IRegularExpressionDAO./../fr/paris/lutece/plugins/regularexpression/business/IRegularExpressionDAO.html#IRegularExpressionDAO">IRegularExpressionDAO _dao = (IRegularExpressionDAO) SpringContextService.getBean( "regularExpressionDAO" );
49
50 /**
51 * Private constructor - this class need not be instantiated
52 */
53 private RegularExpressionHome( )
54 {
55 }
56
57 /**
58 * Creation of an instance of regular expression
59 *
60 * @param regularExpression
61 * The instance of the RegularExpression which contains the informations to store
62 * @param plugin
63 * the Plugin
64 */
65 public static void create( RegularExpression regularExpression, Plugin plugin )
66 {
67 _dao.insert( regularExpression, plugin );
68 }
69
70 /**
71 * Update of the regular expression which is specified in parameter
72 *
73 * @param regularExpression
74 * The instance of the RegularExpression which contains the informations to update
75 * @param plugin
76 * the Plugin
77 *
78 */
79 public static void update( RegularExpression regularExpression, Plugin plugin )
80 {
81 _dao.store( regularExpression, plugin );
82 }
83
84 /**
85 * Remove the regular expression whose identifier is specified in parameter
86 *
87 * @param nIdExpression
88 * The reportingProject Id
89 * @param plugin
90 * the Plugin
91 */
92 public static void remove( int nIdExpression, Plugin plugin )
93 {
94 _dao.delete( nIdExpression, plugin );
95 }
96
97 ///////////////////////////////////////////////////////////////////////////
98 // Finders
99
100 /**
101 * Returns an instance of a regular expression whose identifier is specified in parameter
102 *
103 * @param nKey
104 * The regularExpression primary key
105 * @param plugin
106 * the Plugin
107 * @return an instance of RegularExpression
108 */
109 public static RegularExpression findByPrimaryKey( int nKey, Plugin plugin )
110 {
111 return _dao.load( nKey, plugin );
112 }
113
114 /**
115 * Load the data of all the regular expression and returns them in a list
116 *
117 * @param plugin
118 * the plugin
119 * @return the list of regularexpression
120 */
121 public static List<RegularExpression> getList( Plugin plugin )
122 {
123 return _dao.selectListRegularExpression( plugin );
124 }
125 }