Author: mes
Date: 2010-10-28 15:13:34 -0700 (Thu, 28 Oct 2010)
New Revision: 22588
Added:
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/package-info.java
core3/session-api/trunk/src/main/java/org/cytoscape/session/package-info.java
Modified:
core3/session-api/trunk/pom.xml
core3/session-api/trunk/src/main/java/org/cytoscape/session/CyApplicationManager.java
core3/session-api/trunk/src/main/java/org/cytoscape/session/CyNetworkNaming.java
core3/session-api/trunk/src/main/java/org/cytoscape/session/CySession.java
core3/session-api/trunk/src/main/java/org/cytoscape/session/CySessionManager.java
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/AbstractNetworkEvent.java
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/AbstractNetworkViewEvent.java
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SessionAboutToBeSavedEvent.java
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SessionAboutToBeSavedListener.java
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SessionLoadedEvent.java
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SessionLoadedListener.java
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetCurrentNetworkEvent.java
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetCurrentNetworkListener.java
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetCurrentNetworkViewEvent.java
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetCurrentNetworkViewListener.java
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetSelectedNetworkViewsEvent.java
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetSelectedNetworkViewsListener.java
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetSelectedNetworksEvent.java
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetSelectedNetworksListener.java
Log:
lots of javadoc update and preparation for release
Modified: core3/session-api/trunk/pom.xml
===================================================================
--- core3/session-api/trunk/pom.xml 2010-10-28 21:55:18 UTC (rev 22587)
+++ core3/session-api/trunk/pom.xml 2010-10-28 22:13:34 UTC (rev 22588)
@@ -4,7 +4,7 @@
<parent>
<artifactId>parent</artifactId>
<groupId>org.cytoscape</groupId>
- <version>1.0-SNAPSHOT</version>
+ <version>3.0.0-alpha3</version>
</parent>
<properties>
@@ -21,6 +21,12 @@
<packaging>bundle</packaging>
+ <scm>
+
<connection>scm:svn:http://chianti.ucsd.edu/svn/core3/session-api/trunk</connection>
+
<developerConnection>scm:svn:svn+ssh://grenache.ucsd.edu/cellar/common/svn/core3/session-api/trunk</developerConnection>
+ <url>http://chianti.ucsd.edu/svn/core3/session-api/trunk</url>
+ </scm>
+
<repositories>
<!-- bootstrap for cytoscape dependencies, namely the parent POM
snapshots -->
<repository>
@@ -110,44 +116,44 @@
<dependency>
<groupId>org.cytoscape</groupId>
<artifactId>event-api</artifactId>
- <version>1.0-SNAPSHOT</version>
+ <version>3.0.0-alpha1</version>
</dependency>
<dependency>
<groupId>org.cytoscape</groupId>
<artifactId>model-api</artifactId>
- <version>1.0-SNAPSHOT</version>
+ <version>3.0.0-alpha1</version>
</dependency>
<dependency>
<groupId>org.cytoscape</groupId>
<artifactId>viewmodel-api</artifactId>
- <version>1.0-SNAPSHOT</version>
+ <version>3.0.0-alpha1</version>
</dependency>
<dependency>
<groupId>org.cytoscape</groupId>
<artifactId>vizmap-api</artifactId>
- <version>1.0-SNAPSHOT</version>
+ <version>3.0.0-alpha1</version>
</dependency>
<dependency>
<groupId>org.cytoscape</groupId>
<artifactId>presentation-api</artifactId>
- <version>1.0-SNAPSHOT</version>
+ <version>3.0.0-alpha1</version>
</dependency>
<dependency>
<groupId>org.cytoscape</groupId>
<artifactId>property-api</artifactId>
- <version>1.0-SNAPSHOT</version>
+ <version>3.0.0-alpha1</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>${junit.version}</version>
</dependency>
- <dependency>
- <groupId>org.mockito</groupId>
- <artifactId>mockito-all</artifactId>
- <version>1.8.1</version>
- <scope>test</scope>
- </dependency>
+ <dependency>
+ <groupId>org.mockito</groupId>
+ <artifactId>mockito-all</artifactId>
+ <version>1.8.1</version>
+ <scope>test</scope>
+ </dependency>
</dependencies>
</project>
Modified:
core3/session-api/trunk/src/main/java/org/cytoscape/session/CyApplicationManager.java
===================================================================
---
core3/session-api/trunk/src/main/java/org/cytoscape/session/CyApplicationManager.java
2010-10-28 21:55:18 UTC (rev 22587)
+++
core3/session-api/trunk/src/main/java/org/cytoscape/session/CyApplicationManager.java
2010-10-28 22:13:34 UTC (rev 22588)
@@ -39,70 +39,71 @@
/**
- * Basic access to current and/or currently selected networks, views and
rendering engines in an
- * instance of Cytoscape.
+ * Basic access to current and/or currently selected networks,
+ * views and rendering engines in an instance of Cytoscape.
*/
public interface CyApplicationManager {
/**
* Provides access to the current network.
- *
* @return the current network or null if there is no current network
*/
public CyNetwork getCurrentNetwork();
/**
* Sets the current network to the one with the provided network SUID.
- *
* @param network_id must be the SUID of a network
*/
public void setCurrentNetwork(final long network_id);
/**
- * Provides access to the current network view.
- *
- * @return the current network view of null if no network is currently
being visualised
+ * Returns the current network view.
+ * @return the current network view or null if no network
+ * is currently being visualised
*/
public CyNetworkView getCurrentNetworkView();
/**
- * DOCUMENT ME!
- *
- * @param view_id
- * DOCUMENT ME!
+ * Sets the current network view based on the specified id.
+ * @param view_id The <i>network</i> SUID of the network view to
+ * be made current.
*/
public void setCurrentNetworkView(final long view_id);
/**
- * DOCUMENT ME!
- *
- * @return DOCUMENT ME!
+ * Returns the list of selected networks.
+ * @return The list of selected networks.
*/
public List<CyNetwork> getSelectedNetworks();
/**
- * DOCUMENT ME!
- *
- * @return DOCUMENT ME!
+ * Returns the list of selected network views.
+ * @return The list of selected network views.
*/
public List<CyNetworkView> getSelectedNetworkViews();
/**
- * DOCUMENT ME!
- *
- * @param modelIDs
- * DOCUMENT ME!
+ * Sets the network views associated with the specified network
+ * ids as selected.
+ * @param modelIDs The <i>model</i> SUIDs of the networks that have
+ * been selected.
*/
public void setSelectedNetworkViews(final List<Long> modelIDs);
/**
- * DOCUMENT ME!
- *
- * @param ids
- * DOCUMENT ME!
+ * Sets the networks associated with the specified ids as selected.
+ * @param ids The SUIDs of the networks that have been selected.
*/
public void setSelectedNetworks(final List<Long> ids);
-
+
+ /**
+ * Returns the rendering engine associated with the current network
view.
+ * @return The rendering engine associated with the current network
view.
+ */
public RenderingEngine<CyNetwork> getCurrentRenderingEngine();
+ /**
+ * Sets the current rendering engine.
+ * @param engine The rendering engine that should be made current.
+ */
public void setCurrentRenderingEngine(final RenderingEngine<CyNetwork>
engine);
}
Modified:
core3/session-api/trunk/src/main/java/org/cytoscape/session/CyNetworkNaming.java
===================================================================
---
core3/session-api/trunk/src/main/java/org/cytoscape/session/CyNetworkNaming.java
2010-10-28 21:55:18 UTC (rev 22587)
+++
core3/session-api/trunk/src/main/java/org/cytoscape/session/CyNetworkNaming.java
2010-10-28 22:13:34 UTC (rev 22588)
@@ -4,22 +4,22 @@
import org.cytoscape.model.CyNetwork;
+/**
+ * A utility that helps with the creation of unique network names.
+ */
public interface CyNetworkNaming {
/**
* Generates a unique title for a subnetwork based on a parent network
- *
* @param parentNetwork a non-null reference to a parent network
- *
* @return a unique title somehow based on the title of the parent
network
*/
String getSuggestedSubnetworkTitle(CyNetwork parentNetwork);
/**
* Generates a unique network title based on a provided suggestion.
- *
* @param desiredTitle the "ideal" title that we would like
- *
- * @return "desiredTitle" if this title is not yet in use, o/w a title
that is unique and uses "desiredTitle" as a prefix
+ * @return "desiredTitle" if this title is not yet in use, or
+ * with a title that is unique and uses "desiredTitle" as a prefix
*/
String getSuggestedNetworkTitle(String desiredTitle);
}
Modified:
core3/session-api/trunk/src/main/java/org/cytoscape/session/CySession.java
===================================================================
--- core3/session-api/trunk/src/main/java/org/cytoscape/session/CySession.java
2010-10-28 21:55:18 UTC (rev 22587)
+++ core3/session-api/trunk/src/main/java/org/cytoscape/session/CySession.java
2010-10-28 22:13:34 UTC (rev 22588)
@@ -143,6 +143,8 @@
public CySession build() { return new CySession(this); }
/**
+ * Returns an instance of Builder that has at least been
configured
+ * with the specified network views.
* @param views A Set of CyNetworkView objects, presumably all
networks
* that exist in this instance of Cytoscape.
* @return An instance of Builder that has at least been
configured
@@ -154,6 +156,8 @@
}
/**
+ * Returns an instance of Builder that has at least been
configured
+ * with the specified tables.
* @param t A Set of CyTable objects, presumably all tables
* that exist in this instance of Cytoscape.
* @return An instance of Builder that has at least been
configured
@@ -165,6 +169,8 @@
}
/**
+ * Returns an instance of Builder that has at least been
configured
+ * with the specified network view visual style name map.
* @param vs A map of CyNetworkViews to the names of the
VisualStyle
* currently applied to that network view, for presumably all
network views
* that exist in this instance of Cytoscape.
@@ -177,6 +183,8 @@
}
/**
+ * Returns an instance of Builder that has at least been
configured
+ * with the specified properties.
* @param p A Properties object that contains the current
Cytoscape
* properties.
* @return An instance of Builder that has at least been
configured
@@ -188,6 +196,8 @@
}
/**
+ * Returns an instance of Builder that has at least been
configured
+ * with the specified properties.
* @param p A Properties object that contains the current
VizMap
* properties for all VisualStyles in this instance of
Cytoscape.
* @return An instance of Builder that has at least been
configured
@@ -199,6 +209,8 @@
}
/**
+ * Returns an instance of Builder that has at least been
configured
+ * with the specified plugin file list map.
* @param p A map of plugin names to a list of File objects
that the
* given plugin wants stored in the session file.
* @return An instance of Builder that has at least been
configured
@@ -210,6 +222,8 @@
}
/**
+ * Returns an instance of Builder that has at least been
configured
+ * with the specified bookmarks.
* @param b A Bookmarks object containing all bookmarks defined
* for this session.
* @return An instance of Builder that has at least been
configured
@@ -221,6 +235,8 @@
}
/**
+ * Returns an instance of Builder that has at least been
configured
+ * with the specified session descriptor.
* @param s A {...@link Cysession} object containing the
session descriptor
* for this session.
* @return An instance of Builder that has at least been
configured
@@ -233,44 +249,56 @@
}
/**
+ * Returns a set of all CyNetworkView objects contained in this
Session.
* @return A set of all CyNetworkView objects contained in this
Session.
*/
public Set<CyNetworkView> getNetworkViews() { return netViews; }
/**
+ * Returns a set of all CyTable objects contained in this Session.
* @return A set of all CyTable objects contained in this Session.
*/
public Set<CyTable> getTables() { return tables; }
/**
+ * Returns a map of CyNetworkViews to the names of the VisualStyle
+ * applied to that network view in this session.
* @return A map of CyNetworkViews to the names of the VisualStyle
* applied to that network view in this session.
*/
public Map<CyNetworkView,String> getViewVisualStyleMap() { return vsMap; }
/**
+ * Returns a Propeties object containing all Cytoscape properties
+ * defined for this session.
* @return A Propeties object containing all Cytoscape properties
* defined for this session.
*/
public Properties getCytoscapeProperties() { return cyProps; }
/**
+ * Returns a Propeties object containing all VisualStyles defined
+ * for this session.
* @return A Propeties object containing all VisualStyles defined
* for this session.
*/
public Properties getVizmapProperties() { return vProps; }
/**
+ * Returns a {...@link Bookmarks} object containing all bookmarks for
this session.
* @return A {...@link Bookmarks} object containing all bookmarks for
this session.
*/
public Bookmarks getBookmarks() { return bookmarks; }
/**
+ * Returns a {...@link Cysession} object containing a description of
this session.
* @return A {...@link Cysession} object containing a description of
this session.
*/
public Cysession getCysession() { return cysession; }
/**
+ * Returns a map of plugin names to lists of File objects that are
stored
+ * as part of the session for the specified plugin.
* @return A map of plugin names to lists of File objects that are
stored
* as part of the session for the specified plugin.
*/
Modified:
core3/session-api/trunk/src/main/java/org/cytoscape/session/CySessionManager.java
===================================================================
---
core3/session-api/trunk/src/main/java/org/cytoscape/session/CySessionManager.java
2010-10-28 21:55:18 UTC (rev 22587)
+++
core3/session-api/trunk/src/main/java/org/cytoscape/session/CySessionManager.java
2010-10-28 22:13:34 UTC (rev 22588)
@@ -28,6 +28,7 @@
void setCurrentSession(CySession session, String fileName);
/**
+ * Returns the name of the current session file.
* @return The name of the current session file.
*/
String getCurrentSessionFileName();
Modified:
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/AbstractNetworkEvent.java
===================================================================
---
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/AbstractNetworkEvent.java
2010-10-28 21:55:18 UTC (rev 22587)
+++
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/AbstractNetworkEvent.java
2010-10-28 22:13:34 UTC (rev 22588)
@@ -20,6 +20,10 @@
this.net = net;
}
+ /**
+ * Returns the network associated with this event.
+ * @return the network associated with this event.
+ */
public final CyNetwork getNetwork() {
return net;
}
Modified:
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/AbstractNetworkViewEvent.java
===================================================================
---
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/AbstractNetworkViewEvent.java
2010-10-28 21:55:18 UTC (rev 22587)
+++
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/AbstractNetworkViewEvent.java
2010-10-28 22:13:34 UTC (rev 22588)
@@ -20,6 +20,10 @@
this.view = view;
}
+ /**
+ * Returns the network view associated with this event.
+ * @return the network view associated with this event.
+ */
final public CyNetworkView getNetworkView() {
return view;
}
Modified:
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SessionAboutToBeSavedEvent.java
===================================================================
---
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SessionAboutToBeSavedEvent.java
2010-10-28 21:55:18 UTC (rev 22587)
+++
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SessionAboutToBeSavedEvent.java
2010-10-28 22:13:34 UTC (rev 22588)
@@ -22,7 +22,11 @@
public final class SessionAboutToBeSavedEvent extends
AbstractCyEvent<CySessionManager> {
final Map<String,List<File>> pluginFileListMap;
- // TODO should the source be the session manager
+ // TODO should the source be the session manager??
+ /**
+ * Constructor.
+ * @param source The CySessionManager that will be saving the session.
+ */
public SessionAboutToBeSavedEvent(final CySessionManager source) {
super(source, SessionAboutToBeSavedListener.class);
@@ -30,6 +34,8 @@
}
/**
+ * A method that allows plugins to specify a list of files that should
be
+ * stored in the session.
* @param pluginName The name of the plugin that these files should be
stored for.
* @param files The list of File objects to be stored in the session
file.
*/
@@ -55,7 +61,9 @@
/**
* This method is not meant to be used by listeners for this event,
- * although you can and no harm should come to you.
+ * although you can and no harm should come to you. This method is
+ * used by the CySessionManager to retrieve the list of files from
+ * plugins.
* @return A map of plugin names to lists of files to be stored in the
* session for that plugin.
*/
Modified:
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SessionAboutToBeSavedListener.java
===================================================================
---
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SessionAboutToBeSavedListener.java
2010-10-28 21:55:18 UTC (rev 22587)
+++
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SessionAboutToBeSavedListener.java
2010-10-28 22:13:34 UTC (rev 22588)
@@ -12,6 +12,7 @@
public interface SessionAboutToBeSavedListener extends CyListener {
/**
+ * Processes the specified event when fired.
* @param e The event that the listener is listening for.
*/
public void handleEvent(SessionAboutToBeSavedEvent e);
Modified:
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SessionLoadedEvent.java
===================================================================
---
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SessionLoadedEvent.java
2010-10-28 21:55:18 UTC (rev 22587)
+++
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SessionLoadedEvent.java
2010-10-28 22:13:34 UTC (rev 22588)
@@ -18,6 +18,7 @@
private final String fileName;
/**
+ * Constructor.
* @param source The CySessionManager that is the source of this event.
* @param session The CySession object that was just loaded.
*/
@@ -28,6 +29,7 @@
}
/**
+ * Returns the session that was just loaded.
* @return The session that was just loaded.
*/
public CySession getLoadedSession() {
@@ -35,6 +37,7 @@
}
/**
+ * Returns the file name of the session just loaded.
* @return The file name of the session just loaded.
*/
public String getLoadedFileName() {
Modified:
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SessionLoadedListener.java
===================================================================
---
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SessionLoadedListener.java
2010-10-28 21:55:18 UTC (rev 22587)
+++
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SessionLoadedListener.java
2010-10-28 22:13:34 UTC (rev 22588)
@@ -4,8 +4,12 @@
import org.cytoscape.event.CyListener;
/**
- *
+ * A listener for {...@link SessionLoadedEvent}s.
*/
public interface SessionLoadedListener extends CyListener {
+ /**
+ * Processes the specified event when fired.
+ * @param e The event that the listener is listening for.
+ */
public void handleEvent(SessionLoadedEvent e);
}
Modified:
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetCurrentNetworkEvent.java
===================================================================
---
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetCurrentNetworkEvent.java
2010-10-28 21:55:18 UTC (rev 22587)
+++
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetCurrentNetworkEvent.java
2010-10-28 22:13:34 UTC (rev 22588)
@@ -6,9 +6,15 @@
/**
- *
+ * An event signaling that the a network has been set to current.
*/
public final class SetCurrentNetworkEvent extends AbstractNetworkEvent {
+
+ /**
+ * Constructor.
+ * @param source The application manager that is the source of the
event.
+ * @param net The network that has been set to the current network.
+ */
public SetCurrentNetworkEvent(final CyApplicationManager source, final
CyNetwork net) {
super(source, SetCurrentNetworkListener.class, net);
}
Modified:
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetCurrentNetworkListener.java
===================================================================
---
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetCurrentNetworkListener.java
2010-10-28 21:55:18 UTC (rev 22587)
+++
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetCurrentNetworkListener.java
2010-10-28 22:13:34 UTC (rev 22588)
@@ -4,8 +4,12 @@
import org.cytoscape.event.CyListener;
/**
- *
+ * A listener for {...@link SetCurrentNetworkEvent}s.
*/
public interface SetCurrentNetworkListener extends CyListener {
+ /**
+ * Processes the specified event when fired.
+ * @param e The event that the listener is listening for.
+ */
public void handleEvent(SetCurrentNetworkEvent e);
}
Modified:
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetCurrentNetworkViewEvent.java
===================================================================
---
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetCurrentNetworkViewEvent.java
2010-10-28 21:55:18 UTC (rev 22587)
+++
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetCurrentNetworkViewEvent.java
2010-10-28 22:13:34 UTC (rev 22588)
@@ -6,9 +6,15 @@
/**
- *
+ * An event indicating that a network view has been set to current.
*/
public final class SetCurrentNetworkViewEvent extends AbstractNetworkViewEvent
{
+
+ /**
+ * Constructor.
+ * @param source The application manager firing this event.
+ * @param view The network view that has been set as current.
+ */
public SetCurrentNetworkViewEvent(final CyApplicationManager source,
final CyNetworkView view) {
super(source, SetCurrentNetworkViewListener.class, view);
}
Modified:
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetCurrentNetworkViewListener.java
===================================================================
---
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetCurrentNetworkViewListener.java
2010-10-28 21:55:18 UTC (rev 22587)
+++
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetCurrentNetworkViewListener.java
2010-10-28 22:13:34 UTC (rev 22588)
@@ -4,8 +4,12 @@
import org.cytoscape.event.CyListener;
/**
- *
+ * A listener for {...@link SetCurrentNetworkViewEvent}s.
*/
public interface SetCurrentNetworkViewListener extends CyListener {
+ /**
+ * Processes the specified event when fired.
+ * @param e The event that the listener is listening for.
+ */
public void handleEvent(SetCurrentNetworkViewEvent e);
}
Modified:
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetSelectedNetworkViewsEvent.java
===================================================================
---
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetSelectedNetworkViewsEvent.java
2010-10-28 21:55:18 UTC (rev 22587)
+++
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetSelectedNetworkViewsEvent.java
2010-10-28 22:13:34 UTC (rev 22588)
@@ -9,14 +9,25 @@
/**
- *
+ * An event that indicates that a collection of network views has been
selected.
*/
public final class SetSelectedNetworkViewsEvent extends
AbstractCyEvent<CyApplicationManager> {
private final List<CyNetworkView> views;
+
+ /**
+ * Constructor.
+ * @param source The application manager firing the event.
+ * @param views A list of CyNetworkViews that have been selected.
+ */
public SetSelectedNetworkViewsEvent(final CyApplicationManager source,
final List<CyNetworkView> views) {
super(source, SetSelectedNetworkViewsListener.class);
this.views = views;
}
+
+ /**
+ * Returns the list of network views that have been selected.
+ * @return The list of network views that have been selected.
+ */
public List<CyNetworkView> getNetworkViews() {
return views;
}
Modified:
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetSelectedNetworkViewsListener.java
===================================================================
---
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetSelectedNetworkViewsListener.java
2010-10-28 21:55:18 UTC (rev 22587)
+++
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetSelectedNetworkViewsListener.java
2010-10-28 22:13:34 UTC (rev 22588)
@@ -4,8 +4,12 @@
import org.cytoscape.event.CyListener;
/**
- *
+ * A listener for {...@link SetSelectedNetworkViewsEvent}s.
*/
public interface SetSelectedNetworkViewsListener extends CyListener {
+ /**
+ * Processes the specified event when fired.
+ * @param e The event that the listener is listening for.
+ */
public void handleEvent(SetSelectedNetworkViewsEvent e);
}
Modified:
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetSelectedNetworksEvent.java
===================================================================
---
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetSelectedNetworksEvent.java
2010-10-28 21:55:18 UTC (rev 22587)
+++
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetSelectedNetworksEvent.java
2010-10-28 22:13:34 UTC (rev 22588)
@@ -9,15 +9,25 @@
import java.util.List;
/**
- *
+ * An event indicating the a collection of networks has been selected.
*/
public final class SetSelectedNetworksEvent extends
AbstractCyEvent<CyApplicationManager> {
private final List<CyNetwork> networks;
+
+ /**
+ * Constructor.
+ * @param source the application manager firing the event.
+ * @param networks the collection of networks that has been selected.
+ */
public SetSelectedNetworksEvent(final CyApplicationManager source,
final List<CyNetwork> networks) {
super(source,SetSelectedNetworksListener.class);
this.networks = networks;
}
+ /**
+ * Returns the list of networks selected.
+ * @return The list of networks selected.
+ */
public List<CyNetwork> getNetworks() {
return networks;
}
Modified:
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetSelectedNetworksListener.java
===================================================================
---
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetSelectedNetworksListener.java
2010-10-28 21:55:18 UTC (rev 22587)
+++
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/SetSelectedNetworksListener.java
2010-10-28 22:13:34 UTC (rev 22588)
@@ -4,8 +4,12 @@
import org.cytoscape.event.CyListener;
/**
- *
+ * A listener for {...@link SetSelectedNetworksEvent}s.
*/
public interface SetSelectedNetworksListener extends CyListener {
+ /**
+ * Processes the specified event when fired.
+ * @param e The event that the listener is listening for.
+ */
public void handleEvent(SetSelectedNetworksEvent e);
}
Added:
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/package-info.java
===================================================================
---
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/package-info.java
(rev 0)
+++
core3/session-api/trunk/src/main/java/org/cytoscape/session/events/package-info.java
2010-10-28 22:13:34 UTC (rev 22588)
@@ -0,0 +1,6 @@
+
+/**
+ * This package contains the interfaces and classes necessary to capturing,
+ * session change events.
+ */
+package org.cytoscape.session.events;
Added:
core3/session-api/trunk/src/main/java/org/cytoscape/session/package-info.java
===================================================================
---
core3/session-api/trunk/src/main/java/org/cytoscape/session/package-info.java
(rev 0)
+++
core3/session-api/trunk/src/main/java/org/cytoscape/session/package-info.java
2010-10-28 22:13:34 UTC (rev 22588)
@@ -0,0 +1,8 @@
+
+/**
+ * This package contains the interfaces and classes necessary to capturing,
+ * storing, and retrieving the state of a Cytoscape session. The package
+ * contains additional utility interfaces relating to actitivities
+ * relevant to the session.
+ */
+package org.cytoscape.session;
--
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.
