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   
35  package fr.paris.lutece.plugins.graphite.business;
36  
37  import fr.paris.lutece.portal.service.plugin.Plugin;
38  import fr.paris.lutece.portal.service.plugin.PluginService;
39  import fr.paris.lutece.portal.service.spring.SpringContextService;
40  import java.util.Collection;
41  
42  /**
43   * This class provides instances management methods (create, find, ...) for Graph objects
44   */
45  
46  public final class GraphHome
47  {
48  
49  	// Static variable pointed at the DAO instance
50  
51  	private static IGraphDAO _dao = SpringContextService.getBean( "graphite.graphDAO" );
52  	private static Plugin _plugin = PluginService.getPlugin( "graphite" );
53  
54  	/**
55  	 * Private constructor - this class need not be instantiated
56  	 */
57  	private GraphHome(  )
58  	{
59  	}
60  
61  	/**
62  	 * Create an instance of the graph class
63  	 * @param graph The instance of the Graph which contains the informations to store
64  	 * @return The  instance of graph which has been created with its primary key.
65  	 */
66  	public static Graph create( Graph graph )
67  	{
68  		_dao.insert( graph, _plugin );
69  
70  		return graph;
71  	}
72  
73  
74  	/**
75  	 * Update of the graph which is specified in parameter
76  	 * @param graph The instance of the Graph which contains the data to store
77  	 * @return The instance of the  graph which has been updated
78  	 */
79  	public static Graph update( Graph graph )
80  	{
81  		_dao.store( graph, _plugin );
82  
83  		return graph;
84  	}
85  
86  
87  	/**
88  	 * Remove the graph whose identifier is specified in parameter
89  	 * @param nGraphId The graph Id
90  	 */
91  	public static void remove( int nGraphId )
92  	{
93  		_dao.delete( nGraphId, _plugin );
94  	}
95  
96  
97  	///////////////////////////////////////////////////////////////////////////
98  	// Finders
99  
100 	/**
101 	 * Returns an instance of a graph whose identifier is specified in parameter
102 	 * @param nKey The graph primary key
103 	 * @return an instance of Graph
104 	 */
105 	public static Graph findByPrimaryKey( int nKey )
106 	{
107 		return _dao.load( nKey, _plugin);
108 	}
109 
110 
111 	/**
112 	 * Load the data of all the graph objects and returns them in form of a collection
113 	 * @return the collection which contains the data of all the graph objects
114 	 */
115 	public static Collection<Graph> getGraphsList( )
116 	{
117 		return _dao.selectGraphsList( _plugin );
118 	}
119 }
120