Author: ruschein
Date: 2010-10-25 10:19:48 -0700 (Mon, 25 Oct 2010)
New Revision: 22354
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractRowTask.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractRowTaskFactory.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/DataTableTaskFactory.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/EdgeViewTaskFactory.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/NetworkCollectionTaskFactory.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/NetworkTaskFactory.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/NetworkViewCollectionTaskFactory.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/NetworkViewTaskFactory.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/NodeViewTaskFactory.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/RowTaskFactory.java
Log:
Added missing JavaDoc comments.
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractRowTask.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractRowTask.java
2010-10-25 17:01:35 UTC (rev 22353)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractRowTask.java
2010-10-25 17:19:48 UTC (rev 22354)
@@ -32,12 +32,16 @@
import org.cytoscape.work.AbstractTask;
+/** Base class for all tasks that need to operate on a {...@link CyRow}. */
public abstract class AbstractRowTask extends AbstractTask {
-
+ /** The row that descendents will operate on. */
final protected CyRow row;
+ /** Base class constructor for all tasks that need to be provisioned
with a CyRow.
+ * @param row a non-null CyRow that descendents will operate on
+ */
public AbstractRowTask(final CyRow row) {
- if ( row == null )
+ if (row == null)
throw new NullPointerException("CyRow is null");
this.row = row;
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractRowTaskFactory.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractRowTaskFactory.java
2010-10-25 17:01:35 UTC (rev 22353)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractRowTaskFactory.java
2010-10-25 17:19:48 UTC (rev 22354)
@@ -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,20 +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.model.CyRow;
-public abstract class AbstractRowTaskFactory implements RowTaskFactory {
+/** Base class for all task factories that need to create tasks that have been
provisioned with a {...@link CyRow}. */
+public abstract class AbstractRowTaskFactory implements RowTaskFactory {
+ /** The CyRow that will be passed into any task that will be created by
descendents of this class. */
protected CyRow row;
+ /** Used to provision this class with a {...@link CyRow} that will be
passed into any task
+ * constructed by this factory.
+ * @param row a non-null CyRow
+ */
public void setRow(CyRow row) {
- if ( row == null )
+ if (row == null)
throw new NullPointerException("CyRow is null");
this.row = row;
}
-
}
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/DataTableTaskFactory.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/DataTableTaskFactory.java
2010-10-25 17:01:35 UTC (rev 22353)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/DataTableTaskFactory.java
2010-10-25 17:19:48 UTC (rev 22354)
@@ -1,13 +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
@@ -34,6 +27,7 @@
*/
package org.cytoscape.task;
+
import org.cytoscape.work.TaskFactory;
import org.cytoscape.model.CyTable;
@@ -44,6 +38,8 @@
* specified CyNetwork.
*/
public interface DataTableTaskFactory extends TaskFactory {
-
+ /** Used to provision this factory with a {...@param CyTable} that will
be used to create tasks.
+ * @param table a non-null CyTable
+ */
void setDataTable(CyTable table);
}
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/EdgeViewTaskFactory.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/EdgeViewTaskFactory.java
2010-10-25 17:01:35 UTC (rev 22353)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/EdgeViewTaskFactory.java
2010-10-25 17:19:48 UTC (rev 22354)
@@ -1,13 +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
@@ -34,6 +27,7 @@
*/
package org.cytoscape.task;
+
import org.cytoscape.work.TaskFactory;
import org.cytoscape.model.CyEdge;
import org.cytoscape.view.model.CyNetworkView;
@@ -46,6 +40,10 @@
* specified View<CyEdge>.
*/
public interface EdgeViewTaskFactory extends TaskFactory {
-
+ /** Used to provision this factory with the edge view and associated
network view that will
+ * be used to create tasks.
+ * @param edgeView a non-null edge view
+ * @param netView a non-null network view associated with the edge
view
+ */
void setEdgeView(View<CyEdge> edgeView, CyNetworkView netView);
}
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/NetworkCollectionTaskFactory.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/NetworkCollectionTaskFactory.java
2010-10-25 17:01:35 UTC (rev 22353)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/NetworkCollectionTaskFactory.java
2010-10-25 17:19:48 UTC (rev 22354)
@@ -1,13 +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
@@ -34,6 +27,7 @@
*/
package org.cytoscape.task;
+
import org.cytoscape.work.TaskFactory;
import org.cytoscape.model.CyNetwork;
import java.util.Collection;
@@ -45,6 +39,9 @@
* specified CyNetworks.
*/
public interface NetworkCollectionTaskFactory extends TaskFactory {
-
+ /** Provisions this factory with the collection of networks that will
be passed into any task
+ * created by it.
+ * @param nets a non-null collection of {...@link CyNetwork}s
+ */
void setNetworkCollection(Collection<CyNetwork> nets);
}
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/NetworkTaskFactory.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/NetworkTaskFactory.java
2010-10-25 17:01:35 UTC (rev 22353)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/NetworkTaskFactory.java
2010-10-25 17:19:48 UTC (rev 22354)
@@ -1,13 +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
@@ -34,6 +27,7 @@
*/
package org.cytoscape.task;
+
import org.cytoscape.work.TaskFactory;
import org.cytoscape.model.CyNetwork;
@@ -44,6 +38,9 @@
* specified CyNetwork.
*/
public interface NetworkTaskFactory extends TaskFactory {
-
+ /** Provisions this factory with the {...@link CyNetwork} that will be
passed into any task
+ * created by it.
+ * @param net a non-null {...@link CyNetwork}
+ */
void setNetwork(CyNetwork net);
}
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/NetworkViewCollectionTaskFactory.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/NetworkViewCollectionTaskFactory.java
2010-10-25 17:01:35 UTC (rev 22353)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/NetworkViewCollectionTaskFactory.java
2010-10-25 17:19:48 UTC (rev 22354)
@@ -1,13 +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
@@ -34,6 +27,7 @@
*/
package org.cytoscape.task;
+
import org.cytoscape.work.TaskFactory;
import org.cytoscape.view.model.CyNetworkView;
import java.util.Collection;
@@ -45,6 +39,9 @@
* specified CyNetworks.
*/
public interface NetworkViewCollectionTaskFactory extends TaskFactory {
-
+ /** Provisions this factory with the collection of network views that
will be passed into
+ * any task created by it.
+ * @param nets a non-null collection of {...@link CyNetworkView}s
+ */
void setNetworkViewCollection(Collection<CyNetworkView> nets);
}
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/NetworkViewTaskFactory.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/NetworkViewTaskFactory.java
2010-10-25 17:01:35 UTC (rev 22353)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/NetworkViewTaskFactory.java
2010-10-25 17:19:48 UTC (rev 22354)
@@ -1,13 +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
@@ -34,6 +27,7 @@
*/
package org.cytoscape.task;
+
import org.cytoscape.work.TaskFactory;
import org.cytoscape.view.model.CyNetworkView;
@@ -44,6 +38,9 @@
* specified CyNetworkView.
*/
public interface NetworkViewTaskFactory extends TaskFactory {
-
+ /** Provisions this factory with a {...@link CyNetworkView} that will
be passed into any tasks
+ * created by it.
+ * @param netView a non-null network view
+ */
void setNetworkView(CyNetworkView netView);
}
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/NodeViewTaskFactory.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/NodeViewTaskFactory.java
2010-10-25 17:01:35 UTC (rev 22353)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/NodeViewTaskFactory.java
2010-10-25 17:19:48 UTC (rev 22354)
@@ -1,13 +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
@@ -34,6 +27,7 @@
*/
package org.cytoscape.task;
+
import org.cytoscape.work.TaskFactory;
import org.cytoscape.model.CyNode;
import org.cytoscape.view.model.CyNetworkView;
@@ -46,6 +40,10 @@
* specified View<CyNode>.
*/
public interface NodeViewTaskFactory extends TaskFactory {
-
+ /** Provisions this factory with the node view and its associated
network view, both of
+ * which will be passed into any task that will be created by this
factory.
+ * @param nodeView a non-null node view
+ * @param netView the non-null network view associated with the node
view
+ */
void setNodeView(View<CyNode> nodeView, CyNetworkView netView);
}
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/RowTaskFactory.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/RowTaskFactory.java
2010-10-25 17:01:35 UTC (rev 22353)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/RowTaskFactory.java
2010-10-25 17:19:48 UTC (rev 22354)
@@ -1,13 +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
@@ -34,6 +27,7 @@
*/
package org.cytoscape.task;
+
import org.cytoscape.work.TaskFactory;
import org.cytoscape.model.CyRow;
@@ -44,6 +38,9 @@
* specified CyNetwork.
*/
public interface RowTaskFactory extends TaskFactory {
-
+ /** Provisions this factory with the {...@link CyRow} that will be
passed into any task created
+ * by it.
+ * @param row a non-null CyRow
+ */
void setRow(CyRow row);
}
--
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.
