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.portal.business.style;
35
36 import fr.paris.lutece.portal.service.spring.SpringContextService;
37 import fr.paris.lutece.util.ReferenceList;
38
39 import java.util.Collection;
40 import java.util.Properties;
41
42 import javax.xml.transform.OutputKeys;
43
44 /**
45 * This class provides instances management methods (create, find, ...) for Mode objects
46 */
47 public final class ModeHome
48 {
49 // Static variable pointed at the DAO instance
50 private static IModeDAO _dao = SpringContextService.getBean( "modeDAO" );
51
52 /**
53 * Creates a new ModeHome object.
54 */
55 private ModeHome( )
56 {
57 }
58
59 /**
60 * Creation of an instance of a mode
61 *
62 * @param mode
63 * An instance of a mode which contains the informations to store
64 * @return The instance of a mode which has been created with its primary key.
65 */
66 public static Modeef="../../../../../../fr/paris/lutece/portal/business/style/Mode.html#Mode">Mode create( Mode mode )
67 {
68 _dao.insert( mode );
69
70 return mode;
71 }
72
73 /**
74 * Update of the mode which is specified
75 *
76 * @param mode
77 * The instance of the mode which contains the data to store
78 * @return The instance of the mode which has been updated
79 */
80 public static Modeef="../../../../../../fr/paris/lutece/portal/business/style/Mode.html#Mode">Mode update( Mode mode )
81 {
82 _dao.store( mode );
83
84 return mode;
85 }
86
87 /**
88 * Remove the mode whose identifier is specified in parameter
89 *
90 * @param nId
91 * The identifier of the mode to remove
92 */
93 public static void remove( int nId )
94 {
95 _dao.delete( nId );
96 }
97
98 // /////////////////////////////////////////////////////////////////////////
99 // Finders
100
101 /**
102 * Returns an instance of an mode whose identifier is specified in parameter
103 *
104 * @param nKey
105 * The mode primary key
106 * @return an instance of a mode
107 */
108 public static Mode findByPrimaryKey( int nKey )
109 {
110 return _dao.load( nKey );
111 }
112
113 /**
114 * Return the list of all the modes
115 *
116 * @return A collection of modes objects
117 */
118 public static Collection<Mode> getModesList( )
119 {
120 return _dao.selectModesList( );
121 }
122
123 /**
124 * Returns a reference list which contains all the modes
125 *
126 * @return a reference list
127 */
128 public static ReferenceList getModes( )
129 {
130 return _dao.getModesList( );
131 }
132
133 /**
134 * Returns a set of properties used for xsl output
135 *
136 * @param nKey
137 * The mode primary key
138 * @return the output properties to use for xsl transformation
139 */
140 public static Properties getOuputXslProperties( int nKey )
141 {
142 Mode mode = _dao.load( nKey );
143 Properties ouputProperties = new Properties( );
144
145 String strMethod = mode.getOutputXslPropertyMethod( );
146
147 if ( ( strMethod != null ) && ( !strMethod.trim( ).equals( "" ) ) )
148 {
149 ouputProperties.setProperty( OutputKeys.METHOD, strMethod );
150 }
151
152 String strVersion = mode.getOutputXslPropertyVersion( );
153
154 if ( ( strVersion != null ) && ( !strVersion.trim( ).equals( "" ) ) )
155 {
156 ouputProperties.setProperty( OutputKeys.VERSION, strVersion );
157 }
158
159 String strEncoding = mode.getOutputXslPropertyEncoding( );
160
161 if ( ( strEncoding != null ) && ( !strEncoding.trim( ).equals( "" ) ) )
162 {
163 ouputProperties.setProperty( OutputKeys.ENCODING, strEncoding );
164 }
165
166 String strIndent = mode.getOutputXslPropertyIndent( );
167
168 if ( ( strIndent != null ) && ( !strIndent.trim( ).equals( "" ) ) )
169 {
170 ouputProperties.setProperty( OutputKeys.INDENT, strIndent );
171 }
172
173 String strOmitXmlDeclaration = mode.getOutputXslPropertyOmitXmlDeclaration( );
174
175 if ( ( strOmitXmlDeclaration != null ) && ( !strOmitXmlDeclaration.trim( ).equals( "" ) ) )
176 {
177 ouputProperties.setProperty( OutputKeys.OMIT_XML_DECLARATION, strOmitXmlDeclaration );
178 }
179
180 String strMediaType = mode.getOutputXslPropertyMediaType( );
181
182 if ( ( strMediaType != null ) && ( !strMediaType.trim( ).equals( "" ) ) )
183 {
184 ouputProperties.setProperty( OutputKeys.MEDIA_TYPE, strMediaType );
185 }
186
187 String strStandalone = mode.getOutputXslPropertyStandalone( );
188
189 if ( ( strStandalone != null ) && ( !strStandalone.trim( ).equals( "" ) ) )
190 {
191 ouputProperties.setProperty( OutputKeys.STANDALONE, strStandalone );
192 }
193
194 return ouputProperties;
195 }
196 }