Author: ruschein
Date: 2010-11-10 15:38:09 -0800 (Wed, 10 Nov 2010)
New Revision: 22817
Modified:
core3/model-api/trunk/src/main/java/org/cytoscape/model/CyNode.java
Log:
Documented required events fired by setNestedNetwork().
Modified: core3/model-api/trunk/src/main/java/org/cytoscape/model/CyNode.java
===================================================================
--- core3/model-api/trunk/src/main/java/org/cytoscape/model/CyNode.java
2010-11-10 23:19:35 UTC (rev 22816)
+++ core3/model-api/trunk/src/main/java/org/cytoscape/model/CyNode.java
2010-11-10 23:38:09 UTC (rev 22817)
@@ -1,14 +1,6 @@
-
/*
- Copyright (c) 2008, The Cytoscape Consortium (www.cytoscape.org)
+ Copyright (c) 2008, 2010, The Cytoscape Consortium (www.cytoscape.org)
- The Cytoscape Consortium is:
- - Institute for Systems Biology
- - University of California San Diego
- - Memorial Sloan-Kettering Cancer Center
- - Institut Pasteur
- - Agilent Technologies
-
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2.1 of the License, or
@@ -33,18 +25,20 @@
along with this library; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
*/
-
package org.cytoscape.model;
+
import java.util.List;
+import org.cytoscape.model.events.SetNestedNetworkEvent;
+import org.cytoscape.model.events.UnsetNestedNetworkEvent;
+
/**
* An object that represents a node (vertex) within a network
* of nodes and edges.
*/
public interface CyNode extends CyTableEntry {
-
/**
* An index of this node within this network. The index is guaranteed
to
* be between 0 and (the number of nodes in the network) - 1. This index
@@ -72,6 +66,10 @@
*
* @param nestedNetwork The network that is to be referenced by this
node. If
* this value is null, any existing reference will be removed.
+ *
+ * Note that this if a previous nested network is being replaced or
nulled out, an
+ * {...@link UnsetNestedNetworkEvent} will be fired and if a new nested
network will be set a
+ * {...@link SetNestedNetworkEvent} will be fired.
*/
void setNestedNetwork(CyNetwork nestedNetwork);
}
--
You received this message because you are subscribed to the Google Groups
"cytoscape-cvs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/cytoscape-cvs?hl=en.
