View Javadoc

1   /*
2    * TouchGraph LLC. Apache-Style Software License
3    *
4    *
5    * Copyright (c) 2001-2002 Alexander Shapiro. All rights reserved.
6    *
7    * Redistribution and use in source and binary forms, with or without
8    * modification, are permitted provided that the following conditions
9    * are met:
10   *
11   * 1. Redistributions of source code must retain the above copyright
12   *    notice, this list of conditions and the following disclaimer. 
13   *
14   * 2. Redistributions in binary form must reproduce the above copyright
15   *    notice, this list of conditions and the following disclaimer in
16   *    the documentation and/or other materials provided with the
17   *    distribution.
18   *
19   * 3. The end-user documentation included with the redistribution,
20   *    if any, must include the following acknowledgment:  
21   *       "This product includes software developed by 
22   *        TouchGraph LLC (http://www.touchgraph.com/)."
23   *    Alternately, this acknowledgment may appear in the software itself,
24   *    if and wherever such third-party acknowledgments normally appear.
25   *
26   * 4. The names "TouchGraph" or "TouchGraph LLC" must not be used to endorse 
27   *    or promote products derived from this software without prior written 
28   *    permission.  For written permission, please contact 
29   *    alex@touchgraph.com
30   *
31   * 5. Products derived from this software may not be called "TouchGraph",
32   *    nor may "TouchGraph" appear in their name, without prior written
33   *    permission of alex@touchgraph.com.
34   *
35   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38   * DISCLAIMED.  IN NO EVENT SHALL TOUCHGRAPH OR ITS CONTRIBUTORS BE 
39   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
40   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
41   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 
42   * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
43   * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
44   * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
45   * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
46   * ====================================================================
47   *
48   */
49  
50  package com.touchgraph.graphlayout.graphelements;
51  
52  import java.util.Vector;
53  
54  import com.touchgraph.graphlayout.*;
55  
56  /***  Locality:  A way of representing a subset of a larger set of nodes.
57    *  Allows for both manipulation of the subset, and manipulation of the
58    *  larger set.  For instance, one can call removeNode to delete it from
59    *  the subset, or deleteNode to remove it from the larger set.
60    *
61    *  Locality is used in conjunction with LocalityUtils, which handle
62    *  locality shift animations.
63    *
64    *  More synchronization will almost definitely be required.
65    *
66    * @author   Alexander Shapiro
67    * @version  1.21  $Id: Locality.java,v 1.1.1.1 2004/02/06 08:44:07 keesj Exp $
68    */
69  public class Locality extends GraphEltSet {
70  
71      protected GraphEltSet completeEltSet;
72  
73    // ............
74  
75    /*** Constructor with GraphEltSet <tt>ges</tt>.
76      */
77      public Locality(GraphEltSet ges) {
78          super();
79          completeEltSet = ges;
80      }
81  
82      public GraphEltSet getCompleteEltSet() {
83          return completeEltSet;
84      }
85  
86      public void addNode( Node n ) throws TGException {
87          if (!contains(n)) {
88              super.addNode(n);
89              //If a new Node is created, and then added to Locality, then add the new edge
90              //to completeEltSet as well.
91              if (!completeEltSet.contains(n)) completeEltSet.addNode(n);
92          }
93      }
94  
95      public void addEdge( Edge e ) {
96          if(!contains(e)) {
97              edges.addElement(e);
98              //If a new Edge is created, and then added to Locality, then add the new edge
99              //to completeEltSet as well.
100             if (!completeEltSet.contains(e)) completeEltSet.addEdge(e);
101         }
102     }
103 
104     public void addNodeWithEdges( Node n ) throws TGException {
105         addNode(n);
106         for (int i = 0 ; i < n.edgeCount(); i++) {
107             Edge e=n.edgeAt(i);
108             if(contains(e.getOtherEndpt(n))) addEdge(e);
109         }
110 
111     }
112     
113     public synchronized void addAll() throws TGException {
114         synchronized (completeEltSet) {
115             for (int i = 0 ; i<completeEltSet.nodeCount(); i++) {
116                 addNode(completeEltSet.nodeAt(i));            
117             }
118             for (int i = 0 ; i<completeEltSet.edgeCount(); i++) {
119                 addEdge(completeEltSet.edgeAt(i));            
120             }
121         }
122     }
123 
124     public Edge findEdge( Node from, Node to ) {
125         Edge foundEdge=super.findEdge(from,to);
126         if (foundEdge!=null && edges.contains(foundEdge)) return foundEdge;
127         else return null;
128     }
129 
130     public boolean deleteEdge( Edge e ) {
131         if (e == null) return false;
132         else {
133             removeEdge(e);
134             return completeEltSet.deleteEdge(e);
135         }
136     }
137 
138     public synchronized void deleteEdges( Vector edgesToDelete ) {
139         removeEdges(edgesToDelete);
140         completeEltSet.deleteEdges(edgesToDelete);
141     }
142 
143     public boolean removeEdge( Edge e ) {
144         if (e == null) return false;
145             else {
146                 if(edges.removeElement(e)) {
147                     return true;
148                 }
149             return false;
150         }
151     }
152 
153     public synchronized void removeEdges( Vector edgesToRemove ) {
154         for (int i=0;i<edgesToRemove.size();i++) {
155             removeEdge((Edge) edgesToRemove.elementAt(i));
156         }
157     }
158 
159     public boolean deleteNode( Node node ) {
160         if ( node == null ) return false;
161         else {
162             removeNode(node);
163             return completeEltSet.deleteNode(node);
164         }
165     }
166 
167     public synchronized void deleteNodes( Vector nodesToDelete ) {
168         removeNodes(nodesToDelete);
169         completeEltSet.deleteNodes(nodesToDelete);
170     }
171 
172     public boolean removeNode( Node node ) {
173           if (node == null) return false;
174           if (!nodes.removeElement(node)) return false;
175 		  
176 		  String id = node.getID();
177           if ( id != null ) nodeIDRegistry.remove(id); // remove from registry
178 	
179           for (int i = 0 ; i < node.edgeCount(); i++) {
180              removeEdge(node.edgeAt(i));
181          }
182 
183          return true;
184     }
185 
186     public synchronized void removeNodes( Vector nodesToRemove ) {
187         for (int i=0;i<nodesToRemove.size();i++) {
188             removeNode((Node) nodesToRemove.elementAt(i));
189         }
190     }
191 
192     public synchronized void removeAll() {
193         super.clearAll();        
194     }
195 
196     public synchronized void clearAll() {
197         removeAll();
198         completeEltSet.clearAll();
199     }
200 
201 } // end com.touchgraph.graphlayout.graphelements.Locality