1 /*
2 * File: HierarchicalTimeBarModel.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.model;
21
22 /**
23 * Interface describing a hierarchical model. As of version 0.96 this is not an extension of the TimeBarModel since the
24 * extraction of the view state (expanded state) in the hierarchy did imply a stricter separation. Care should be taken
25 * if nodes should appear in several positions in the node. There is no restriction on this by the model itself. However
26 * the ViewState will not distinguish the state of equal nodes in different positions resulting in the same expanded
27 * state of all equal nodes.
28 *
29 * @author Peter Kliem
30 * @version $Id: HierarchicalTimeBarModel.java 800 2008-12-27 22:27:33Z kliem $
31 */
32 public interface HierarchicalTimeBarModel {
33 /**
34 * Retrieve the depth of the hierarchy.
35 *
36 * @return depth of the hierarchy
37 */
38 int getDepth();
39
40 /**
41 * Little helper. May be removed in future revisions.
42 *
43 * @param depth the depth to set
44 */
45 void setDepth(int depth);
46
47 /**
48 * Retrieve the root node of the hierarchy.
49 *
50 * @return the root node
51 */
52 TimeBarNode getRootNode();
53 }