View Javadoc
1   /*
2    * Copyright (c) 2002-2020, 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.document.business.attributes;
35  
36  import fr.paris.lutece.plugins.document.business.DocumentType;
37  import fr.paris.lutece.portal.service.i18n.I18nService;
38  import fr.paris.lutece.portal.service.spring.SpringContextService;
39  
40  import java.util.Collection;
41  import java.util.List;
42  import java.util.Locale;
43  
44  
45  /**
46   * This class provides instances management methods (create, find, ...) for DocumentAttribute objects
47   */
48  public final class DocumentAttributeHome
49  {
50      // Static variable pointed at the DAO instance
51      private static IDocumentAttributeDAO _dao = SpringContextService.getBean( "document.documentAttributeDAO" );
52  
53      /**
54       * Private constructor - this class need not be instantiated
55       */
56      private DocumentAttributeHome(  )
57      {
58      }
59  
60      /**
61       * Creation of an instance of documentAttribute
62       *
63       * @param documentAttribute The instance of the documentAttribute which contains the informations to store
64       * @return The  instance of documentAttribute which has been created with its primary key.
65       */
66      public static DocumentAttribute../../../../fr/paris/lutece/plugins/document/business/attributes/DocumentAttribute.html#DocumentAttribute">DocumentAttribute create( DocumentAttribute documentAttribute )
67      {
68          _dao.insert( documentAttribute );
69  
70          return documentAttribute;
71      }
72  
73      /**
74       * Update of the documentAttribute which is specified in parameter
75       *
76       * @param documentAttribute The instance of the documentAttribute which contains the data to store
77       * @return The instance of the  documentAttribute which has been updated
78       */
79      public static DocumentAttribute../../../../fr/paris/lutece/plugins/document/business/attributes/DocumentAttribute.html#DocumentAttribute">DocumentAttribute update( DocumentAttribute documentAttribute )
80      {
81          _dao.store( documentAttribute );
82  
83          return documentAttribute;
84      }
85  
86      /**
87       * Remove the DocumentAttribute whose identifier is specified in parameter
88       *
89       * @param nAttributeId The id of the attribute
90       */
91      public static void remove( int nAttributeId )
92      {
93          _dao.delete( nAttributeId );
94      }
95  
96      ///////////////////////////////////////////////////////////////////////////
97      // Finders
98  
99      /**
100      * Returns an instance of a documentAttribute whose identifier is specified in parameter
101      *
102      * @param nKey The Primary key of the documentAttribute
103      * @return An instance of documentAttribute
104      */
105     public static DocumentAttribute findByPrimaryKey( int nKey )
106     {
107         return _dao.load( nKey );
108     }
109 
110     /**
111      * Returns a collection of documentAttributes objects
112      * @param documentType The document type
113      */
114     public static void setDocumentTypeAttributes( DocumentType documentType )
115     {
116         _dao.selectAttributesByDocumentType( documentType );
117     }
118 
119     /**
120      * Get all attributes of document type
121      * @param codeDocumentType The code document Type
122      * @return listDocumentAttributes The list of all attributes of selected code document type
123      */
124     public static List<DocumentAttribute> selectAllAttributesOfDocumentType( String codeDocumentType )
125     {
126         return _dao.selectAllAttributesOfDocumentType( codeDocumentType );
127     }
128 
129     /**
130      * Get the attribute type parameters of an attribute
131      * @param nAttributeId The id of the attribute to get the parameter of
132      * @param locale The locale
133      * @return The list of parameters
134      */
135     public static Collection<AttributeTypeParameter> getAttributeParametersValues( int nAttributeId, Locale locale )
136     {
137         Collection<AttributeTypeParameter> listParametersValues = _dao.selectAttributeParametersValues( nAttributeId );
138 
139         return I18nService.localizeCollection( listParametersValues, locale );
140     }
141 
142     /**
143      * Get the list of values of a parameters of an attribute
144      * @param nAttributeId The id of the attribute
145      * @param strParameterName The name of the parameter
146      * @return The list of values of the parameter of the attribute
147      */
148     public static List<String> getAttributeParameterValues( int nAttributeId, String strParameterName )
149     {
150         return _dao.getAttributeParameterValues( nAttributeId, strParameterName );
151     }
152 
153     /**
154      * Inserts a regular expression in the attribute
155      *
156      * @param nIdAttribute The identifier of the document attribute
157      * @param nIdExpression The identifier of the regular expression
158      */
159     public static void insertRegularExpression( int nIdAttribute, int nIdExpression )
160     {
161         _dao.insertRegularExpression( nIdAttribute, nIdExpression );
162     }
163 
164     /**
165      * Deletes a regular expression in the attribute
166      *
167      * @param nIdAttribute The identifier of the document attribute
168      * @param nIdExpression The identifier of the regular expression
169      */
170     public static void deleteRegularExpression( int nIdAttribute, int nIdExpression )
171     {
172         _dao.deleteRegularExpression( nIdAttribute, nIdExpression );
173     }
174 
175     /**
176      * Loads all regular expression key associated to the attribute and returns them into a collection
177      *
178      * @param nIdAttribute The identifier of the document attribute
179      * @return A collection of regular expression key
180      */
181     public static Collection<Integer> getListRegularExpressionKeyByIdAttribute( int nIdAttribute )
182     {
183         return _dao.selectListRegularExpressionKeyByIdAttribute( nIdAttribute );
184     }
185 }