Author: ruschein
Date: 2010-10-21 16:32:45 -0700 (Thu, 21 Oct 2010)
New Revision: 22341
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractDataTableTask.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractDataTableTaskFactory.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractEdgeViewTask.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractEdgeViewTaskFactory.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkCollectionTask.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkCollectionTaskFactory.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkTask.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkTaskFactory.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkViewCollectionTask.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkViewCollectionTaskFactory.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkViewTask.java
Log:
Added missing Javadoc interface documentation.
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractDataTableTask.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractDataTableTask.java
2010-10-21 22:49:52 UTC (rev 22340)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractDataTableTask.java
2010-10-21 23:32:45 UTC (rev 22341)
@@ -34,8 +34,13 @@
public abstract class AbstractDataTableTask extends AbstractTask {
+ /** The table that this task operates on.
+ */
final protected CyTable table;
+ /** Initialises the Task with the table that it will operate on.
+ * @param table the reference to a CyTable that descendent tasks will
operate on
+ */
public AbstractDataTableTask(final CyTable table) {
if (table == null)
throw new NullPointerException("CyTable is null");
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractDataTableTaskFactory.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractDataTableTaskFactory.java
2010-10-21 22:49:52 UTC (rev 22340)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractDataTableTaskFactory.java
2010-10-21 23:32:45 UTC (rev 22341)
@@ -1,13 +1,6 @@
/*
- Copyright (c) 2006, The Cytoscape Consortium (www.cytoscape.org)
+ Copyright (c) 2006, 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
@@ -32,17 +25,22 @@
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.task;
+
import org.cytoscape.model.CyTable;
-public abstract class AbstractDataTableTaskFactory implements
DataTableTaskFactory {
+public abstract class AbstractDataTableTaskFactory implements
DataTableTaskFactory {
+ /** The table that will be passed into any Task constructor.
+ */
protected CyTable table;
+ /** Provisions this factory with a table that will be used to construct
tasks.
+ * @param table the {...@link CyTable} to be passed into
<code>Task</code> constructors; <b>must</b> not be null!
+ */
public void setDataTable(final CyTable table) {
- if ( table == null )
+ if (table == null)
throw new NullPointerException("CyTable is null");
this.table = table;
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractEdgeViewTask.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractEdgeViewTask.java
2010-10-21 22:49:52 UTC (rev 22340)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractEdgeViewTask.java
2010-10-21 23:32:45 UTC (rev 22341)
@@ -35,15 +35,21 @@
public abstract class AbstractEdgeViewTask extends AbstractTask {
+ /** The edge view that descendent tasks will operate on. */
+ final protected View<CyEdge> edgeView;
- final protected View<CyEdge> edgeView;
+ /** The network view associated with {...@link #edgeView}. */
final protected CyNetworkView netView;
+ /** Base constructor for all tasks that need an edge view to operate on.
+ * @param edgeView the edge view to work with for this task
+ * @param netView the network view that contains "edgeView"
+ */
public AbstractEdgeViewTask(final View<CyEdge> edgeView, final
CyNetworkView netView) {
super();
- if ( edgeView == null )
+ if (edgeView == null)
throw new NullPointerException("EdgeView is null");
- if ( netView == null )
+ if (netView == null)
throw new NullPointerException("CyNetworkView is null");
this.edgeView = edgeView;
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractEdgeViewTaskFactory.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractEdgeViewTaskFactory.java
2010-10-21 22:49:52 UTC (rev 22340)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractEdgeViewTaskFactory.java
2010-10-21 23:32:45 UTC (rev 22341)
@@ -1,13 +1,6 @@
/*
- Copyright (c) 2006, The Cytoscape Consortium (www.cytoscape.org)
+ Copyright (c) 2006, 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
@@ -32,18 +25,25 @@
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.task;
+
import org.cytoscape.view.model.CyNetworkView;
import org.cytoscape.view.model.View;
import org.cytoscape.model.CyEdge;
+
public abstract class AbstractEdgeViewTaskFactory implements
EdgeViewTaskFactory {
+ /** The network view passed into any task constructed by this factory.
*/
+ protected CyNetworkView netView;
- protected CyNetworkView netView;
+ /** The edge view passed into any task constructed by this factory. */
protected View<CyEdge> edgeView;
+ /** Provisions this task factory with the edge view and network view
that it needs to construct tasks.
+ * @param edgeView the edge view that will be passed into constructed
tasks
+ * @param netView the network view that will be passed into
constructed tasks
+ */
public void setEdgeView(final View<CyEdge> edgeView, final
CyNetworkView netView) {
if ( edgeView == null )
throw new NullPointerException("EdgeView is null");
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkCollectionTask.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkCollectionTask.java
2010-10-21 22:49:52 UTC (rev 22340)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkCollectionTask.java
2010-10-21 23:32:45 UTC (rev 22341)
@@ -36,8 +36,12 @@
public abstract class AbstractNetworkCollectionTask extends AbstractTask {
+ /** The collection of networks that descendents will operate on. */
final protected Collection<CyNetwork> networks;
+ /** Base Constructor for a task that will operate on a collection of
networks
+ * @param networks a collection of networks
+ */
public AbstractNetworkCollectionTask(final Collection<CyNetwork>
networks) {
if ( networks == null )
throw new NullPointerException("CyNetwork Collection is
null");
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkCollectionTaskFactory.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkCollectionTaskFactory.java
2010-10-21 22:49:52 UTC (rev 22340)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkCollectionTaskFactory.java
2010-10-21 23:32:45 UTC (rev 22341)
@@ -29,16 +29,20 @@
*/
package org.cytoscape.task;
+
import org.cytoscape.model.CyNetwork;
import java.util.Collection;
public abstract class AbstractNetworkCollectionTaskFactory implements
NetworkCollectionTaskFactory {
-
+ /** The collection of networks that will be passed to any task
constructed by descendents of this factory. */
protected Collection<CyNetwork> networks;
+ /** Provisions descendents of this factory with a collection of
networks to be passed into any constructed tasks.
+ * @param networks a collection of networks
+ */
public void setNetworkCollection(final Collection<CyNetwork> networks) {
- if ( networks == null )
+ if (networks == null)
throw new NullPointerException("CyNetwork Colleciton is
null");
this.networks = networks;
}
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkTask.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkTask.java
2010-10-21 22:49:52 UTC (rev 22340)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkTask.java
2010-10-21 23:32:45 UTC (rev 22341)
@@ -35,10 +35,14 @@
public abstract class AbstractNetworkTask extends AbstractTask {
+ /** The network that descendents of this class will operate on. */
final protected CyNetwork net;
+ /** Base class for tasks that need to operate on a {...@link CyNetwork}
+ * @param net must be a non-null CyNetwork
+ */
public AbstractNetworkTask(final CyNetwork net) {
- if ( net == null )
+ if (net == null)
throw new NullPointerException("CyNetwork is null");
this.net = net;
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkTaskFactory.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkTaskFactory.java
2010-10-21 22:49:52 UTC (rev 22340)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkTaskFactory.java
2010-10-21 23:32:45 UTC (rev 22341)
@@ -34,8 +34,12 @@
public abstract class AbstractNetworkTaskFactory implements NetworkTaskFactory
{
+ /** Network to be passed into any task constructed by descendents of
this class. */
protected CyNetwork net;
+ /** Provisions descendents of this factory class with the network for
any task to be constructed by them.
+ * @param net must be a non-null {...@link CyNetwork}
+ */
public void setNetwork(final CyNetwork net) {
if (net == null)
throw new NullPointerException("\"net\" is null!");
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkViewCollectionTask.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkViewCollectionTask.java
2010-10-21 22:49:52 UTC (rev 22340)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkViewCollectionTask.java
2010-10-21 23:32:45 UTC (rev 22341)
@@ -35,8 +35,12 @@
public abstract class AbstractNetworkViewCollectionTask extends AbstractTask {
+ /** A collection of network views to operate on for any descendents of
this class. */
final protected Collection<CyNetworkView> networkViews;
+ /** Base class for any tasks that need to operate on a collection of
network views.
+ * @param networkViews must be a non-null collection of network views
+ */
public AbstractNetworkViewCollectionTask(final
Collection<CyNetworkView> networkViews) {
if (networkViews == null)
throw new NullPointerException("CyNetworkView
Collection is null");
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkViewCollectionTaskFactory.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkViewCollectionTaskFactory.java
2010-10-21 22:49:52 UTC (rev 22340)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkViewCollectionTaskFactory.java
2010-10-21 23:32:45 UTC (rev 22341)
@@ -27,16 +27,20 @@
*/
package org.cytoscape.task;
+
import org.cytoscape.view.model.CyNetworkView;
import java.util.Collection;
public abstract class AbstractNetworkViewCollectionTaskFactory implements
NetworkViewCollectionTaskFactory {
-
+ /** The collection of network views to be passed into any tasks
constructed by descendents of this class. */
protected Collection<CyNetworkView> networkViews;
+ /** Provisions descendents of this class with a collection of network
views to pass into constructed tasks.
+ * @param networkViews must be a non-null collection of network views
+ */
public void setNetworkViewCollection(final Collection<CyNetworkView>
networkViews) {
- if ( networkViews == null )
+ if (networkViews == null)
throw new NullPointerException("CyNetworkView
Colleciton is null");
this.networkViews = networkViews;
}
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkViewTask.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkViewTask.java
2010-10-21 22:49:52 UTC (rev 22340)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkViewTask.java
2010-10-21 23:32:45 UTC (rev 22341)
@@ -35,8 +35,12 @@
public abstract class AbstractNetworkViewTask extends AbstractTask {
+ /** The network view that descendents of this class will operate on. */
final protected CyNetworkView view;
+ /** A base class for tasks that need to operate on a network view.
+ * @param view must be a non-empty network view for descendents to
operate on
+ */
public AbstractNetworkViewTask(final CyNetworkView view) {
if (view == null)
throw new NullPointerException("CyNetworkView is null");
--
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.
