View Javadoc
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.file;
35  
36  import fr.paris.lutece.portal.business.physicalfile.PhysicalFileHome;
37  import fr.paris.lutece.portal.service.spring.SpringContextService;
38  
39  
40  /**
41   * This class provides instances management methods (create, find, ...) for file objects
42   */
43  public final class FileHome
44  {
45      // Static variable pointed at the DAO instance
46      private static IFileDAO _dao = (IFileDAO) SpringContextService.getBean( "fileDAO" );
47  
48      /**
49       * Private constructor - this class need not be instantiated
50       */
51      private FileHome(  )
52      {
53      }
54  
55      /**
56       * Creation of an instance of record file
57       *
58       * @param file The instance of the file which contains the informations to store
59       * @return the id of the file after creation
60       *
61       */
62      public static int create( File file )
63      {
64          if ( file.getPhysicalFile(  ) != null )
65          {
66              file.getPhysicalFile(  ).setIdPhysicalFile( PhysicalFileHome.create( file.getPhysicalFile(  ) ) );
67          }
68  
69          return _dao.insert( file );
70      }
71  
72      /**
73       * Update of file which is specified in parameter
74       *
75       * @param  file The instance of the  record file which contains the informations to update
76       */
77      public static void update( File file )
78      {
79          if ( file.getPhysicalFile(  ) != null )
80          {
81              PhysicalFileHome.update( file.getPhysicalFile(  ) );
82          }
83  
84          _dao.store( file );
85      }
86  
87      /**
88       *Delete the file whose identifier is specified in parameter
89       *
90       * @param nIdFile The identifier of the record file
91       */
92      public static void remove( int nIdFile )
93      {
94          File file = FileHome.findByPrimaryKey( nIdFile );
95  
96          if ( file.getPhysicalFile(  ) != null )
97          {
98              PhysicalFileHome.remove( file.getPhysicalFile(  ).getIdPhysicalFile(  ) );
99          }
100 
101         _dao.delete( nIdFile );
102     }
103 
104     ///////////////////////////////////////////////////////////////////////////
105     // Finders
106 
107     /**
108      * Returns an instance of a file whose identifier is specified in parameter
109      *
110      * @param nKey The file  primary key
111      * @return an instance of file
112      */
113     public static File findByPrimaryKey( int nKey )
114     {
115         return _dao.load( nKey );
116     }
117 }