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