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.category;
35  
36  import fr.paris.lutece.portal.service.image.ImageResource;
37  import fr.paris.lutece.portal.service.spring.SpringContextService;
38  
39  import java.util.Collection;
40  
41  
42  /**
43   * This class provides instances management methods (create, find, ...) for Category objects
44   */
45  public final class CategoryHome
46  {
47      // Static variable pointed at the DAO instance
48      private static ICategoryDAO _dao = SpringContextService.getBean( "document.categoryDAO" );
49  
50      /**
51       * Private constructor - this class need not be instantiated
52       */
53      private CategoryHome(  )
54      {
55      }
56  
57      /**
58       * Returns the category list
59       *
60       * @return Collection of Category (empty collection is no result)
61       */
62      public static Collection<Category> findAll(  )
63      {
64          Collection<Category> categoryList = _dao.selectAll(  );
65  
66          return categoryList;
67      }
68  
69      /**
70       * Create a new Category
71       * @param category The new Category
72       *
73       */
74      public static void create( Category category )
75      {
76          _dao.insert( category );
77      }
78  
79      /**
80       * Find the data of Category from the table
81       * @param nIdCategory The id of the category
82       * @return The Instance of the object Category of null if no category match
83       */
84      public static Category find( int nIdCategory )
85      {
86          return _dao.load( nIdCategory );
87      }
88  
89      /**
90       * Find the data of Category from the table
91       * @param strCategoryName The id of the category
92       * @return The Collection of Category (empty collection is no result)
93       */
94      public static Collection<Category> findByName( String strCategoryName )
95      {
96          return _dao.selectByName( strCategoryName );
97      }
98  
99      /**
100      * Remove a record from the table
101      * @param nIdCategory The identifier of the object Category
102      */
103     public static void remove( int nIdCategory )
104     {
105         _dao.delete( nIdCategory );
106     }
107 
108     /**
109      * Update the record in the table
110      * @param category The instance of the Category to update
111      */
112     public static void update( Category category )
113     {
114         _dao.store( category );
115     }
116 
117     /**
118      * Find the number of documents linked to a category
119      * @param nIdCategory The category id
120      * @return count of id document
121      */
122     public static int findCountIdDocuments( int nIdCategory )
123     {
124         return _dao.selectCountIdDocuments( nIdCategory );
125     }
126 
127     /**
128     * Return the image resource for the specified category id
129     * @param nCategoryId The identifier of Category object
130     * @return ImageResource
131     */
132     public static ImageResource getImageResource( int nCategoryId )
133     {
134         return _dao.loadImageResource( nCategoryId );
135     }
136 }