Author: mes
Date: 2012-04-20 16:48:09 -0700 (Fri, 20 Apr 2012)
New Revision: 28937
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractEdgeViewTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkCollectionTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkViewCollectionTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkViewLocationTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkViewTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNodeViewTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableCellTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableColumnTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/EdgeViewTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkCollectionTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkViewCollectionTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkViewLocationTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkViewTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NodeViewTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/RowTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/TableCellTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/TableColumnTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/TableTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/session/NewSessionTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/table/MapNetworkAttrTaskFactory.java
Log:
updated a ton of javadoc
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractEdgeViewTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractEdgeViewTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractEdgeViewTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -8,8 +8,14 @@
* An EdgeViewTaskFactory that is always ready to produce a TaskIterator.
*/
public abstract class AbstractEdgeViewTaskFactory implements
EdgeViewTaskFactory {
+ /**
+ * By default always returns true.
+ * @param edgeView The edge view.
+ * @param networkView The network view.
+ * @return always returns true.
+ */
@Override
- public boolean isReady(View<CyEdge> EdgeView, CyNetworkView
networkView) {
+ public boolean isReady(View<CyEdge> edgeView, CyNetworkView
networkView) {
return true;
}
}
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkCollectionTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkCollectionTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkCollectionTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -8,6 +8,11 @@
* An NetworkCollectionTaskFactory that is always ready to produce a
TaskIterator.
*/
public abstract class AbstractNetworkCollectionTaskFactory implements
NetworkCollectionTaskFactory {
+ /**
+ * Always returns true.
+ * @param networks The collection of networks.
+ * @return always returns true.
+ */
@Override
public boolean isReady(Collection<CyNetwork> networks) {
return true;
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -7,6 +7,11 @@
* @CyAPI.Abstract.Class
*/
public abstract class AbstractNetworkTaskFactory implements NetworkTaskFactory
{
+ /**
+ * Always returns true.
+ * @param network The network.
+ * @return always returns true.
+ */
@Override
public boolean isReady(CyNetwork network) {
return true;
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkViewCollectionTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkViewCollectionTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkViewCollectionTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -9,6 +9,11 @@
* @CyAPI.Abstract.Class
*/
public abstract class AbstractNetworkViewCollectionTaskFactory implements
NetworkViewCollectionTaskFactory {
+ /**
+ * Always returns true.
+ * @param networkViews The collection of network views.
+ * @return always returns true.
+ */
@Override
public boolean isReady(Collection<CyNetworkView> networkViews) {
return true;
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkViewLocationTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkViewLocationTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkViewLocationTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -10,13 +10,18 @@
import org.cytoscape.work.TaskIterator;
/**
- * The base class for all of the task factories that need to add a
functionality to the network view
- * considering a give location (e.g. adding the node in the mouse clicked
location).
- * @author rozagh
- *
+ * A base class for task factories that need to add a functionality to the
network view
+ * considering a given location (for example adding a node where a mouse was
clicked).
*/
public abstract class AbstractNetworkViewLocationTaskFactory implements
NetworkViewLocationTaskFactory{
+ /**
+ * Always returns true.
+ * @param networkView The network view
+ * @param javaPt the point on the network view in java coordinates
+ * @param xformPt the point on the network view transformed into
Cytoscape coordinates
+ * @return always returns true.
+ */
@Override
public boolean isReady(CyNetworkView networkView, Point2D javaPt,
Point2D xformPt) {
return true;
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkViewTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkViewTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkViewTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -7,6 +7,11 @@
* @CyAPI.Abstract.Class
*/
public abstract class AbstractNetworkViewTaskFactory implements
NetworkViewTaskFactory {
+ /**
+ * Always returns true.
+ * @param networkView The network view
+ * @return always returns true.
+ */
@Override
public boolean isReady(CyNetworkView networkView) {
return true;
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNodeViewTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNodeViewTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNodeViewTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -9,6 +9,12 @@
* @CyAPI.Abstract.Class
*/
public abstract class AbstractNodeViewTaskFactory implements
NodeViewTaskFactory {
+ /**
+ * Always returns true.
+ * @param nodeView The node view
+ * @param networkView The network view
+ * @return always returns true.
+ */
@Override
public boolean isReady(View<CyNode> nodeView, CyNetworkView
networkView) {
return true;
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableCellTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableCellTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableCellTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -7,6 +7,12 @@
* @CyAPI.Abstract.Class
*/
public abstract class AbstractTableCellTaskFactory implements
TableCellTaskFactory {
+ /**
+ * Always returns true.
+ * @param column The table column.
+ * @param primaryKeyValue the value of the primary key
+ * @return always returns true.
+ */
@Override
public boolean isReady(CyColumn column, Object primaryKeyValue) {
return true;
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableColumnTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableColumnTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableColumnTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -34,6 +34,11 @@
* @CyAPI.Abstract.Class
*/
abstract public class AbstractTableColumnTaskFactory implements
TableColumnTaskFactory {
+ /**
+ * Always returns true.
+ * @param column The table column.
+ * @return always returns true.
+ */
@Override
public boolean isReady(CyColumn column) {
return true;
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -7,6 +7,11 @@
* @CyAPI.Abstract.Class
*/
public abstract class AbstractTableTaskFactory implements TableTaskFactory {
+ /**
+ * Always returns true.
+ * @param table The table.
+ * @return always returns true.
+ */
@Override
public boolean isReady(CyTable table) {
return true;
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/EdgeViewTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/EdgeViewTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/EdgeViewTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -33,8 +33,9 @@
import org.cytoscape.view.model.View;
import org.cytoscape.work.TaskIterator;
-
/**
+ * A task factory that creates one or more tasks that operate on the specified
View<CyEdge> within
+ * the specified CyNetworkView.
* @CyAPI.Spi.Interface
*/
public interface EdgeViewTaskFactory {
@@ -42,6 +43,7 @@
* Creates a new TaskIterator using the given edge view and network
view.
* @param edgeView a non-null edge view
* @param networkView a non-null network view
+ * @return A TaskIterator object containing one or more {@link
org.cytoscape.work.Task} objects to execute.
*/
TaskIterator createTaskIterator(View<CyEdge> edgeView, CyNetworkView
networkView);
@@ -49,7 +51,7 @@
* Returns true if this task factory is ready to produce a TaskIterator.
* @param edgeView a non-null edge view
* @param networkView a non-null network view
- * @return
+ * @return true if this task factory is ready to produce a TaskIterator.
*/
boolean isReady(View<CyEdge> edgeView, CyNetworkView networkView);
}
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkCollectionTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkCollectionTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkCollectionTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -35,17 +35,22 @@
/**
- * The assumption is that setNetworkCollection() will be called before
- * getTask() and that the Task in question operates on the
- * specified CyNetworks.
+ * Produces a task iterator for the specified collection of networks.
* @CyAPI.Spi.Interface
*/
public interface NetworkCollectionTaskFactory {
- /** 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
+ /**
+ * Provisions this factory with the collection of networks that will be
passed into any task
+ * created by it.
+ * @param networks a non-null collection of {@link CyNetwork}s
+ * @return A TaskIterator object containing one or more {@link
org.cytoscape.work.Task} objects to execute.
*/
TaskIterator createTaskIterator(Collection<CyNetwork> networks);
+ /**
+ * Returns true if this task factory is ready to produce a task
iterator.
+ * @param networks a non-null collection of {@link CyNetwork}s
+ * @return true if this task factory is ready to produce a task
iterator.
+ */
boolean isReady(Collection<CyNetwork> networks);
}
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -31,8 +31,7 @@
import org.cytoscape.work.TaskIterator;
/**
- * The assumption is that setNetwork() will be called before getTask() and that
- * the Task in question operates on the specified CyNetwork.
+ * A task factory that creates one or more tasks that operate on the specified
CyNetwork.
* @CyAPI.Spi.Interface
*/
public interface NetworkTaskFactory {
@@ -40,11 +39,15 @@
/**
* Provisions this factory with the {@link CyNetwork} that will be passed
* into any task created by it.
- *
- * @param network
- * a non-null {@link CyNetwork}
+ * @param network a non-null {@link CyNetwork}
+ * @return A TaskIterator object containing one or more {@link
org.cytoscape.work.Task} objects to execute.
*/
TaskIterator createTaskIterator(CyNetwork network);
-
+
+ /**
+ * Returns true if this task factory is ready to produce a TaskIterator.
+ * @param network a non-null {@link CyNetwork}
+ * @return true if this task factory is ready to produce a TaskIterator.
+ */
boolean isReady(CyNetwork network);
}
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkViewCollectionTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkViewCollectionTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkViewCollectionTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -35,17 +35,24 @@
/**
- * The assumption is that setNetworkViewCollection() will be called before
- * getTask() and that the Task in question operates on the
- * specified CyNetworks.
+ * A task factory that creates one or more tasks that operate on the specified
+ * collection of network views.
* @CyAPI.Spi.Interface
*/
public interface NetworkViewCollectionTaskFactory {
- /** 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
+
+ /**
+ * Provisions this factory with the collection of network views that will
be passed into
+ * any task created by it.
+ * @param networkViews a non-null collection of {@link CyNetworkView}s
+ * @return A TaskIterator object containing one or more {@link
org.cytoscape.work.Task} objects to execute.
*/
TaskIterator createTaskIterator(Collection<CyNetworkView> networkViews);
-
+
+ /**
+ * Returns true if this task factory is ready to produce a TaskIterator.
+ * @param networkViews a non-null collection of {@link CyNetworkView}s
+ * @return true if this task factory is ready to produce a TaskIterator.
+ */
boolean isReady(Collection<CyNetworkView> networkViews);
}
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkViewLocationTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkViewLocationTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkViewLocationTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -9,18 +9,28 @@
/**
* An extension of TaskFactory that provides support for
- * tasks to deal with adding node and edge by right click menu.
+ * tasks that need to know the a location within a CyNetworkView to
+ * perform their task. An example would be task that adds a
+ * node to a network in a specific location.
* @CyAPI.Spi.Interface
*/
public interface NetworkViewLocationTaskFactory{
/**
- * Sets the drop information for a TaskFactory.
- * @param t The transferable object that was dropped.
- * @param javaPt The raw Java point at which the object was dropped.
- * @param xformPt The drop point transformed into Cytoscape coordinates.
+ * Creates a task iterator using the specified network view and points.
+ * @param networkView The network view.
+ * @param javaPt The raw Java point within the network view.
+ * @param xformPt The raw Java point transformed into Cytoscape
coordinates.
+ * @return A TaskIterator object containing one or more {@link
org.cytoscape.work.Task} objects to execute.
*/
TaskIterator createTaskIterator(CyNetworkView networkView, Point2D
javaPt, Point2D xformPt);
+ /**
+ * Returns true if this task factory is ready to produce a TaskIterator.
+ * @param networkView The network view.
+ * @param javaPt The raw Java point within the network view.
+ * @param xformPt The raw Java point transformed into Cytoscape
coordinates.
+ * @return true if this task factory is ready to produce a TaskIterator.
+ */
boolean isReady(CyNetworkView networkView, Point2D javaPt, Point2D
xformPt);
-}
\ No newline at end of file
+}
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkViewTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkViewTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkViewTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -33,19 +33,21 @@
/**
+ * A task factory that creates one or more tasks that operate on the specified
CyNetworkView.
* @CyAPI.Spi.Interface
*/
public interface NetworkViewTaskFactory {
/**
* Creates a new TaskIterator using the given {@link CyNetworkView}
* @param networkView a non-null network view
+ * @return A TaskIterator object containing one or more {@link
org.cytoscape.work.Task} objects to execute.
*/
TaskIterator createTaskIterator(CyNetworkView networkView);
/**
* Returns true if this task factory is ready to produce a TaskIterator.
* @param networkView
- * @return
+ * @return true if this task factory is ready to produce a TaskIterator.
*/
boolean isReady(CyNetworkView networkView);
}
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NodeViewTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NodeViewTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NodeViewTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -35,18 +35,27 @@
/**
- * The assumption is that setNodeView() will be called before
- * getTask() and that the Task in question operates on the
- * specified View<CyNode>.
+ * A task factory that creates a task that operates on the specified
View<CyNode> within
+ * the specified CyNetworkView.
* @CyAPI.Spi.Interface
*/
public interface NodeViewTaskFactory {
- /** 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
+ /**
+ * 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 networkView the non-null network view associated with the
node view
+ * @return A TaskIterator object containing one or more {@link
org.cytoscape.work.Task} objects to execute.
*/
TaskIterator createTaskIterator(View<CyNode> nodeView, CyNetworkView
networkView);
+ /**
+ * Returns true if the node view and network view are in a state that is
+ * ready to be processed by the generated tasks and false otherwise.
+ * @param nodeView a non-null node view
+ * @param networkView the non-null network view associated with the
node view
+ * @return true if the node view and network view are in a state that is
+ * ready to be processed by the generated tasks and false otherwise.
+ */
boolean isReady(View<CyNode> nodeView, CyNetworkView networkView);
}
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/RowTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/RowTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/RowTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -33,17 +33,21 @@
/**
- * The assumption is that setRow() will be called before
- * getTask() and that the Task in question operates on the
- * specified CyNetwork.
+ * A task factory that creates one or more tasks that operate on the specified
CyRow.
* @CyAPI.Spi.Interface
*/
public interface RowTaskFactory {
- /** Provisions this factory with the {@link CyRow} that will be passed
into any task created
- * by it.
- * @param row a non-null CyRow
+ /**
+ * Provisions this factory with the {@link CyRow} that will be passed
into any task created by it.
+ * @param row a non-null CyRow
+ * @return A TaskIterator object containing one or more {@link
org.cytoscape.work.Task} objects to execute.
*/
TaskIterator createTaskIterator(CyRow row);
+ /**
+ * Returns true if this task factory is ready to produce a TaskIterator.
+ * @param row a non-null CyRow
+ * @return true if this task factory is ready to produce a TaskIterator.
+ */
boolean isReady(CyRow row);
}
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/TableCellTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/TableCellTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/TableCellTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -33,17 +33,25 @@
/**
- * The assumption is that setColumnAndPrimaryKey() will be called before
getTask() and that the Task
- * in question operates on the specified table entry identified by the column
and primary key value.
+ * A task factory that creates one or more tasks that operate on the specified
CyColumn
+ * along with primary key.
* @CyAPI.Spi.Interface
*/
public interface TableCellTaskFactory {
- /** Used to provision this factory with a {@link CyColumn} and a
primary key that will be
- * used to create tasks.
- * @param column a non-null CyColumn
- * @param primaryKeyValue a non-null primary key value
+ /**
+ * Used to provision this factory with a {@link CyColumn} and a primary
key that will be
+ * used to create tasks.
+ * @param column a non-null CyColumn
+ * @param primaryKeyValue a non-null primary key value
+ * @return A TaskIterator object containing one or more {@link
org.cytoscape.work.Task} objects to execute.
*/
TaskIterator createTaskIterator(final CyColumn column, final Object
primaryKeyValue);
-
+
+ /**
+ * Returns true if this task factory is ready to produce a TaskIterator.
+ * @param column a non-null CyColumn
+ * @param primaryKeyValue a non-null primary key value
+ * @return true if this task factory is ready to produce a TaskIterator.
+ */
boolean isReady(final CyColumn column, final Object primaryKeyValue);
}
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/TableColumnTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/TableColumnTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/TableColumnTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -33,15 +33,21 @@
/**
- * The assumption is that setColumn() will be called before getTask() and that
the Task in question
- * operates on the specified CyColumn.
+ * A task factory that creates one or more tasks that operate on the
specified CyColumn.
* @CyAPI.Spi.Interface
*/
public interface TableColumnTaskFactory {
- /** Used to provision this factory with a {@link CyColumn} that will be
used to create tasks.
- * @param column a non-null CyColumn.
+ /**
+ * Used to provision this factory with a {@link CyColumn} that will be
used to create tasks.
+ * @param column a non-null CyColumn.
+ * @return A TaskIterator object containing one or more {@link
org.cytoscape.work.Task} objects to execute.
*/
TaskIterator createTaskIterator(final CyColumn column);
-
+
+ /**
+ * Returns true if this task factory is ready to produce a TaskIterator.
+ * @param column a non-null CyColumn.
+ * @return true if this task factory is ready to produce a TaskIterator.
+ */
boolean isReady(final CyColumn column);
}
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/TableTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/TableTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/TableTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -33,15 +33,22 @@
/**
- * The assumption is that setTable() will be called before getTask() and that
the Task in question
- * operates on the specified CyTable.
+ * A task factory that creates one or more tasks that operate on the specified
CyTable.
* @CyAPI.Spi.Interface
*/
public interface TableTaskFactory {
- /** Used to provision this factory with a {@link CyTable} that will be
used to create tasks.
- * @param table a non-null CyTable
+
+ /**
+ * Used to provision this factory with a {@link CyTable} that will be
used to create tasks.
+ * @param table a non-null CyTable
+ * @return A TaskIterator object containing one or more {@link
org.cytoscape.work.Task} objects to execute.
*/
TaskIterator createTaskIterator(CyTable table);
-
+
+ /**
+ * Returns true if this task factory is ready to produce a TaskIterator.
+ * @param table a non-null CyTable
+ * @return true if this task factory is ready to produce a TaskIterator.
+ */
boolean isReady(CyTable table);
}
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/session/NewSessionTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/session/NewSessionTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/session/NewSessionTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -6,20 +6,14 @@
/**
* This interface provides a task iterator for creating a new session.
- * @author rozagh
- *
*/
public interface NewSessionTaskFactory extends TaskFactory {
-
/**
- * Creates a task iterator for creating anew session and
- * destroying the current session based on the input.The created
- * task runs synchronously in the current thread and it will not
- * create a task monitor.
- * @param destroyCurrentSession
- * @return
+ * Creates a task iterator for creating a new session and
+ * destroying the current session based on the input.
+ * @param destroyCurrentSession Whether or not to destroy the current
session.
+ * @return A TaskIterator object containing one or more {@link
org.cytoscape.work.Task} objects to execute.
*/
- TaskIterator createTaskIterator(final boolean destroyCurrentSession);
-
+ TaskIterator createTaskIterator(boolean destroyCurrentSession);
}
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/table/MapNetworkAttrTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/table/MapNetworkAttrTaskFactory.java
2012-04-20 23:47:27 UTC (rev 28936)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/table/MapNetworkAttrTaskFactory.java
2012-04-20 23:48:09 UTC (rev 28937)
@@ -50,7 +50,6 @@
* @param type The type of table to map to, either CyNode.class or
CyEdge.class.
* @param newGlobalTable The table to be mapped.
* @param mappingKey The column name in the existing table used to join
with the primary key in the new table.
- * @param mappingType The type of mapping to be performed.
*/
TaskIterator createTaskIterator(final Class<? extends CyIdentifiable>
type,
final CyTable newGlobalTable,
--
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.
