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.*;
53
54 import com.touchgraph.graphlayout.*;
55
56 /*** ImmutableGraphEltSet provides access to the elements of GraphElementSet
57 * that does not allow for addition or deletion of nodes or edges.
58 *
59 * @author Alexander Shapiro
60 * @version 1.21 $Id: ImmutableGraphEltSet.java,v 1.1.1.1 2004/02/06 08:44:07 keesj Exp $
61 */
62 public interface ImmutableGraphEltSet {
63
64 /*** Return the number of Nodes in the cumulative Vector. */
65 public int nodeCount();
66
67 /*** Return the current Node count.
68 * @deprecated this method has been replaced by the <tt>nodeCount()</tt> method.
69 */
70 public int nodeNum();
71
72 /*** Return an iterator over the Nodes in the cumulative Vector, null if it is empty. */
73 public Iterator getNodes();
74
75 /*** Return the number of Edges in the cumulative Vector. */
76 public int edgeCount();
77
78 /*** Return the current Edge count.
79 * @deprecated this method has been replaced by the <tt>edgeCount()</tt> method.
80 */
81 public int edgeNum();
82
83 /*** Return an iterator over the Edges in the cumulative Vector, null if it is empty. */
84 public Iterator getEdges();
85
86 /*** Return the Node whose ID matches the String <tt>id</tt>, null if no match is found. */
87 public Node findNode( String id );
88
89 /*** Return a Collection of all Nodes whose label matches the String <tt>label</tt>,
90 * null if no match is found. */
91 public Collection findNodesByLabel( String label );
92
93 /*** Return the first Nodes whose label contains the String <tt>substring</tt>,
94 * null if no match is found. */
95 public Node findNodeLabelContaining( String substring );
96
97 /*** Return an Edge spanning Node <tt>from</tt> to Node <tt>to</tt>. */
98 public Edge findEdge( Node from, Node to );
99
100 /*** Returns a random node, or null if none exist (for making random graphs). */
101 public Node getRandomNode();
102
103 /*** Return the first Node, null if none exist. */
104 public Node getFirstNode();
105
106 /*** iterates through all the nodes. */
107 public void forAllNodes( TGForEachNode fen );
108
109 /*** iterates through pairs of Nodes. */
110 public void forAllNodePairs( TGForEachNodePair fenp );
111
112 /*** iterates through Edges. */
113 public void forAllEdges( TGForEachEdge fee );
114
115 } // end com.touchgraph.graphlayout.graphelements.ImmutableGraphEltSet