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