View Javadoc

1   /*
2    *  File: IHierarchyIdService.java 
3    *  Copyright (c) 2004-2007  Peter Kliem (Peter.Kliem@jaret.de)
4    *  A commercial license is available, see http://www.jaret.de.
5    *
6    *  This program is free software; you can redistribute it and/or modify
7    *  it under the terms of the GNU General Public License as published by
8    *  the Free Software Foundation; either version 2 of the License, or
9    *  (at your option) any later version.
10   *
11   *  This program is distributed in the hope that it will be useful,
12   *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   *  GNU General Public License for more details.
15   *
16   *  You should have received a copy of the GNU General Public License
17   *  along with this program; if not, write to the Free Software
18   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19   */
20  package de.jaret.util.ui.timebars.addon;
21  
22  import de.jaret.util.ui.timebars.model.HierarchicalTimeBarModel;
23  import de.jaret.util.ui.timebars.model.TimeBarNode;
24  
25  /***
26   * For saving the viewstate nodes must be identified by an id and have to be found by the id. This interface describes a
27   * service to do this for hierarchical models of the timebarviewer.
28   * 
29   * @author kliem
30   * @version $Id: IHierarchyIdService.java 340 2007-04-02 21:52:03Z olk $
31   */
32  public interface IHierarchyIdService {
33      /***
34       * Retrieve an id for a node.
35       * 
36       * @param model hierarchical model
37       * @param node node
38       * @return id for the node
39       */
40      String getId(HierarchicalTimeBarModel model, TimeBarNode node);
41  
42      /***
43       * Get the node for a given id from the model.
44       * 
45       * @param model hierarchical model
46       * @param id id
47       * @return the node for the id or <code>null</code> if no node could be found
48       */
49      TimeBarNode getNode(HierarchicalTimeBarModel model, String id);
50  }