KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > sapia > regis > RWNode


1 package org.sapia.regis;
2
3 /**
4  * This insterface extends the <code>Node</code> interface in
5  * order to support write operations.
6  *
7  * @author yduchesne
8  *
9  */
10 public interface RWNode extends Node{
11   
12   /**
13    * @param key a property key.
14    * @param value a property value.
15    */
16   public void setProperty(String JavaDoc key, String JavaDoc value);
17   
18   /**
19    * @param key the key of the property to delete.
20    */
21   public void deleteProperty(String JavaDoc key);
22   
23   /**
24    * Deletes this instance's properties.
25    */
26   public void deleteProperties();
27   
28   /**
29    * @param type the type of this node.
30    *
31    * @see org.sapia.regis.forms.Form#getType()
32    */
33   public void setType(String JavaDoc type);
34   /**
35    * @param name the name under which the new child node should be bound under this instance.
36    * @return the newly created <code>Node</code>
37    * @throws DuplicateNodeException if a node already exists under this instance,
38    * for the given name.
39    */
40   public Node createChild(String JavaDoc name) throws DuplicateNodeException;
41   
42   /**
43    * @param name deletes the child <code>Node</code> with the given name from this instance.
44    */
45   public void deleteChild(String JavaDoc name);
46
47   /**
48    * Deletes the child <code>Node</code>s of this instance.
49    */
50   public void deleteChildren();
51   
52   /**
53    * Sets the inheritance mode of this instance.
54    *
55    * @param inheritsParent if <code>true</code>, indicates to this instance that it should
56    * inherit its parent's configuration properties.
57    */
58   public void setInheritsParent(boolean inheritsParent);
59   
60   /**
61    * @param node a linked <code>Node</code>.
62    */
63   public void prependLink(Node node);
64   
65   /**
66    * @param node a linked <code>Node</code>
67    */
68   public void removePrependedLink(Node node);
69   
70   /**
71    * @param node a linked <code>Node</code>.
72    */
73   public void appendLink(Node node);
74   
75   /**
76    * @param node a linked <code>Node</code>
77    */
78   public void removeAppendedLink(Node node);
79   
80   /**
81    * Removes all linked nodes from this instance.
82    */
83   public void deleteLinks();
84   
85   /**
86    * @param node a <code>Node</code> to included.
87    */
88   public void addInclude(Node node);
89   
90   /**
91    * @param node a <code>Node</code> to remove from
92    * this instance's included nodes.
93    */
94   public void removeInclude(Node node);
95   
96   /**
97    * Removes all included nodes from this instance.
98    */
99   public void deleteIncludes();
100
101   /**
102    * Moves this instance to the given parent.
103    * @param newParent a <code>Node</code>.
104    */
105   public void moveTo(Node newParent);
106
107 }
108
Popular Tags