KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > enhydra > barracuda > plankton > data > PData


1 /*
2  * Copyright (C) 2003 Christian Cryder [christianc@granitepeaks.com]
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * $Id: PData.java,v 1.2 2004/02/01 05:16:28 christianc Exp $
19  */
20 package org.enhydra.barracuda.plankton.data;
21
22 import java.io.*;
23 import java.util.*;
24
25 /**
26  * This interface defines the methods required to establish
27  * a heirarchical relationship between objects.
28  */
29 public interface PData extends StateMap, Cloneable JavaDoc, Serializable {
30
31     /**
32      * set the object's parent
33      *
34      * @param p
35      */
36     public void setParent(PData p);
37
38     /**
39      * get the objects parent (null if root)
40      *
41      * @return the PData object
42      */
43     public PData getParent();
44
45     /**
46      * get the root parent by chaining back up the heirarchy until we find
47      * the highest PData object in the heirarchy.
48      *
49      * @return the root PData object
50      */
51     public PData getRootParent();
52     
53     /**
54      * Do we want to inherit parents. Defaults to true. This indicates that
55      * when an object is added to this data collection, if it implements
56      * PData, it should automatically inherit the current object as its
57      * parent. You would typically set this to false if you were going
58      * to be storing PData "mini-hierarchies" within a larger PData
59      * hierarchy
60      *
61      * @param val true if we should inherit parents
62      */
63     public void setInheritParents(boolean val);
64     
65     /**
66      * Return true if we are inheriting parents.
67      *
68      * @return true if we are inheriting parents
69      */
70     public boolean isInheritParents();
71 }
72
Popular Tags