001: /*
002: * <copyright>
003: *
004: * Copyright 1997-2004 BBNT Solutions, LLC
005: * under sponsorship of the Defense Advanced Research Projects
006: * Agency (DARPA).
007: *
008: * You can redistribute this software and/or modify it under the
009: * terms of the Cougaar Open Source License as published on the
010: * Cougaar Open Source Website (www.cougaar.org).
011: *
012: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
013: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
014: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
015: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
016: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
017: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
018: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
019: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
020: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
021: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
022: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
023: *
024: * </copyright>
025: */
026:
027: package org.cougaar.mlm.debug.ui;
028:
029: import java.io.FileOutputStream;
030: import java.io.PrintWriter;
031: import java.util.Enumeration;
032:
033: import javax.swing.tree.DefaultMutableTreeNode;
034: import javax.swing.tree.DefaultTreeModel;
035:
036: /** Support a dynamically expanded and updated tree node.
037: This overrides methods defined in DefaultMutableTreeNode (swing class)
038: to provide dynamic loading of child nodes. This also defines
039: object listener methods to listen for changes to the data, and
040: update the tree model which updates the display.
041: This class is extended by numerous classes which display the various
042: cluster objects (plans, plan elements, tasks, allocations, etc.)
043: as nodes in a tree.
044: */
045:
046: public class UITreeNode extends DefaultMutableTreeNode {
047: private boolean hasLoaded;
048: DefaultTreeModel treeModel;
049: protected final Object childGuard = new Object();
050:
051: /** Construct a new tree node. Should subsequently call setUserObject
052: to set the object associated with this tree node.
053: */
054:
055: public UITreeNode() {
056: hasLoaded = false;
057: }
058:
059: /** Construct a new tree node for the specified object.
060: @param userObject object for which to create tree node
061: */
062:
063: public UITreeNode(Object userObject) {
064: super (userObject);
065: hasLoaded = false;
066: }
067:
068: /** Set the object associated with this tree node; typically used
069: in conjunction with the zero-arg constructor.
070: @param userObject object to associate with tree node
071: */
072:
073: public void setUserObject(Object userObject) {
074: super .setUserObject(userObject);
075: }
076:
077: /** Methods called by TreeModel; overidden here to provide
078: dynamic expansion of the tree - only get node values
079: when the user "opens" the parent node.
080: */
081:
082: /** Override this in subclasses to return whether or not
083: the user object is a leaf.
084: @return false
085: */
086:
087: public boolean isLeaf() {
088: return false;
089: }
090:
091: /** Called by TreeModel prior to displaying children.
092: Load children if they're not already loaded.
093: @return number of children from DefaultMutableTreeNode.getChildCount
094: */
095:
096: public int getChildCount() {
097: synchronized (childGuard) {
098: if (!hasLoaded) {
099: hasLoaded = true;
100: loadChildren();
101: }
102: }
103: return super .getChildCount();
104: }
105:
106: /** Called by TreeModel prior to displaying children.
107: Load children if they're not already loaded.
108: @return true if allows children, from DefaultMutableTreeNode.getAllowsChildren
109: */
110:
111: public boolean getAllowsChildren() {
112: synchronized (childGuard) {
113: if (!hasLoaded) {
114: hasLoaded = true;
115: loadChildren();
116: }
117: }
118: return super .getAllowsChildren();
119: }
120:
121: /** Called when node has changed to invalidate its children.
122: First, removeAllChildren, then set the hasLoaded flag to false,
123: because otherwise removeAllChildren will first try to load the children!
124: */
125:
126: public void invalidateChildren() {
127: synchronized (childGuard) {
128: removeAllChildren();
129: hasLoaded = false;
130: }
131: }
132:
133: /** Override this in subclasses to load children.
134: */
135:
136: public void loadChildren() {
137: }
138:
139: /** Find the node for the user object in the children nodes of the tree.
140: */
141:
142: public DefaultMutableTreeNode findUserObject(Object o) {
143: if (children != null) {
144: for (int i = 0; i < children.size(); i++) {
145: DefaultMutableTreeNode node = (DefaultMutableTreeNode) children
146: .elementAt(i);
147: if (node.getUserObject().equals(o))
148: return node;
149: }
150: }
151: return null;
152: }
153:
154: /** Used by subclasses to remove objects from the tree,
155: when the objects are removed from their containers.
156: */
157:
158: public void removeObjectFromTree(Object o) {
159: DefaultMutableTreeNode node = findUserObject(o);
160: if (node != null)
161: treeModel.removeNodeFromParent(node);
162: }
163:
164: /** Called by UITreeDisplay to set the tree model
165: associated with the tree that this node is in.
166: The tree model is used to insert and delete nodes in the tree.
167: @param treeModel the tree model associated with this tree
168: */
169:
170: public void setTreeModel(DefaultTreeModel treeModel) {
171: this .treeModel = treeModel;
172: }
173:
174: /** Save the string representations of the objects in the tree.
175: Called from UITreeDisplay when the user selects the "Save" menu item.
176: */
177:
178: void saveTree(String pathname) {
179: FileOutputStream fileOutStream = null;
180:
181: try {
182: fileOutStream = new FileOutputStream(pathname);
183: } catch (Exception e) {
184: new UIDisplayError("Error writing file: " + pathname + " "
185: + e);
186: }
187: PrintWriter printWriter = new PrintWriter(fileOutStream);
188: Enumeration nodes = preorderEnumeration();
189: while (nodes.hasMoreElements())
190: printWriter.println(nodes.nextElement().toString());
191: if (printWriter.checkError())
192: new UIDisplayError("Error writing file: " + pathname);
193: printWriter.close();
194: }
195: }
|