Author: mkirby
Date: 2011-11-03 23:24:47 -0700 (Thu, 03 Nov 2011)
New Revision: 27399
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractEdgeViewTask.java
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/AbstractNetworkCollectionTask.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/AbstractNetworkTask.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/AbstractNetworkViewCollectionTask.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/AbstractNetworkViewTask.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/AbstractNodeViewTask.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/AbstractRowTask.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractRowTaskFactory.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableCellTask.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/AbstractTableColumnTask.java
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableTask.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/MapNetworkAttrTask.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/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/creation/NewEmptyNetworkViewFactory.java
Log:
Fixed Javadoc.
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractEdgeViewTask.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractEdgeViewTask.java
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractEdgeViewTask.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -35,6 +35,7 @@
/**
* The base class for all tasks that need to operate on an edge view and
possibly its associated network view.
+ * @CyAPI.Abstract.Class
*/
public abstract class AbstractEdgeViewTask extends AbstractTask {
/** The edge view that descendant tasks will operate on. */
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
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractEdgeViewTaskFactory.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -35,6 +35,7 @@
/**
* Base class for all task factories that create tasks that need to be
provisioned with an edge view
* and its associated network view.
+ * @CyAPI.Abstract.Class
*/
public abstract class AbstractEdgeViewTaskFactory implements
EdgeViewTaskFactory {
/** The network view passed into any task constructed by this factory.
*/
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkCollectionTask.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkCollectionTask.java
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkCollectionTask.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -37,6 +37,7 @@
/**
* The base class for all tasks that need to operate on a Collection of {@link
CyNetwork}s.
+ * @CyAPI.Abstract.Class
*/
public abstract class AbstractNetworkCollectionTask extends AbstractTask {
/** The collection of networks that descendants will operate on. */
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
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkCollectionTaskFactory.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -38,6 +38,7 @@
/**
* Base class for all task factories that create tasks that need to be
provisioned with a Collection
* of {@link CyNetwork}s.
+ * @CyAPI.Abstract.Class
*/
public abstract class AbstractNetworkCollectionTaskFactory implements
NetworkCollectionTaskFactory {
/** The collection of networks that will be passed to any task
constructed by descendants of this factory. */
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkTask.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkTask.java
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkTask.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -33,7 +33,9 @@
import org.cytoscape.model.CyRow;
import org.cytoscape.work.AbstractTask;
-/** Base class for all tasks that need to operate on a {@link CyNetwork}. */
+/** Base class for all tasks that need to operate on a {@link CyNetwork}.
+ * @CyAPI.Abstract.Class
+ */
public abstract class AbstractNetworkTask extends AbstractTask {
/**
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
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkTaskFactory.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -33,6 +33,7 @@
/**
* Base class for all task factories that create tasks that need to be
provisioned with a network view.
+ * @CyAPI.Abstract.Class
*/
public abstract class AbstractNetworkTaskFactory implements NetworkTaskFactory
{
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkViewCollectionTask.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkViewCollectionTask.java
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkViewCollectionTask.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -35,6 +35,7 @@
/**
* The base class for all tasks that need to operate on a Collection of {@link
CyNetworkView}s.
+ * @CyAPI.Abstract.Class
*/
public abstract class AbstractNetworkViewCollectionTask extends AbstractTask {
/** A collection of network views to operate on for any descendants of
this class. */
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
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkViewCollectionTaskFactory.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -34,6 +34,7 @@
/**
* Base class for all task factories that create tasks that need to be
provisioned with a Collection
* of {@link CyNetworkView}s.
+ * @CyAPI.Abstract.Class
*/
public abstract class AbstractNetworkViewCollectionTaskFactory implements
NetworkViewCollectionTaskFactory {
/** The collection of network views to be passed into any tasks
constructed by descendants of this class. */
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkViewTask.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkViewTask.java
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkViewTask.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -34,6 +34,7 @@
import org.cytoscape.work.AbstractTask;
/** The base class for all tasks that need to operate on a network view.
+ * @CyAPI.Abstract.Class
*/
public abstract class AbstractNetworkViewTask extends AbstractTask {
/** The network view that descendants of this class will operate on. */
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
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNetworkViewTaskFactory.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -33,13 +33,15 @@
import org.cytoscape.view.model.CyNetworkView;
-/** Base class for all task factories that need to create tasks that will be
provisioned with a network view. */
+/** Base class for all task factories that need to create tasks that will be
provisioned with a network view.
+ * @CyAPI.Abstract.Class
+ */
public abstract class AbstractNetworkViewTaskFactory implements
NetworkViewTaskFactory {
- /** The newtork view that will be passed into any tasks are are being
created by descendents of this class. */
+ /** The network view that will be passed into any tasks are are being
created by descendants of this class. */
protected CyNetworkView view; // TODO: should be renamed to networkView
- /** Provides this class and its descendents with the network view that
will be passed into
- * any tasks created by descendents of this class.
+ /** Provides this class and its descendants with the network view that
will be passed into
+ * any tasks created by descendants of this class.
* @param view must be a non-null network view
*/
public void setNetworkView(final CyNetworkView view) {
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNodeViewTask.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNodeViewTask.java
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNodeViewTask.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -35,16 +35,17 @@
/** The base class for all tasks that need to operate on a node view and
possibly its associated network view.
+ * @CyAPI.Abstract.Class
*/
public abstract class AbstractNodeViewTask extends AbstractTask {
- /** The node view that descendents of this class will operate on. */
+ /** The node view that descendants of this class will operate on. */
final protected View<CyNode> nodeView;
- /** The network view that descendents of this class will operate on. */
+ /** The network view that descendants of this class will operate on. */
final protected CyNetworkView netView;
/** Base class constructor for all tasks that need to operate on a node
view and possibly its associated network view.
- * @param nodeView a non-null node view that descendents of this
class will operate on
+ * @param nodeView a non-null node view that descendants of this
class will operate on
* @param netView the non-null network that is associated with
{@link #nodeView}
*/
public AbstractNodeViewTask(final View<CyNode> nodeView, final
CyNetworkView netView) {
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
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractNodeViewTaskFactory.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -35,15 +35,16 @@
/** Base class for all task factories that create tasks that need to be
provisioned with a node view
* and its associated network view.
+ * @CyAPI.Abstract.Class
*/
public abstract class AbstractNodeViewTaskFactory implements
NodeViewTaskFactory {
- /** The network view that will be used to provision tasks that are
being created by descendents of this class. */
+ /** The network view that will be used to provision tasks that are
being created by descendants of this class. */
protected CyNetworkView netView; // TODO: should be renamed to
networkView
- /** The node view that will be used to provision tasks that are being
created by descendents of this class. */
+ /** The node view that will be used to provision tasks that are being
created by descendants of this class. */
protected View<CyNode> nodeView;
- /** Provisions descendents of this class with a node view and its
associated network view
+ /** Provisions descendants of this class with a node view and its
associated network view
* that will be used to pass to created tasks.
* @param nodeView a non-null node view
* @param netView the non-null network view associated with {@link
#nodeView}
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractRowTask.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractRowTask.java
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractRowTask.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -32,7 +32,9 @@
import org.cytoscape.work.AbstractTask;
-/** Base class for all tasks that need to operate on a {@link CyRow}. */
+/** Base class for all tasks that need to operate on a {@link CyRow}.
+ * @CyAPI.Abstract.Class
+ */
public abstract class AbstractRowTask extends AbstractTask {
/** The row that descendants will operate on. */
final protected CyRow row;
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractRowTaskFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractRowTaskFactory.java
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractRowTaskFactory.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -31,9 +31,11 @@
import org.cytoscape.model.CyRow;
-/** Base class for all task factories that need to create tasks that have been
provisioned with a {@link CyRow}. */
+/** Base class for all task factories that need to create tasks that have been
provisioned with a {@link CyRow}.
+ * @CyAPI.Abstract.Class
+ */
public abstract class AbstractRowTaskFactory implements RowTaskFactory {
- /** The CyRow that will be passed into any task that will be created by
descendents of this class. */
+ /** The CyRow that will be passed into any task that will be created by
descendants of this class. */
protected CyRow row;
/** Used to provision this class with a {@link CyRow} that will be
passed into any task
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableCellTask.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableCellTask.java
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableCellTask.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -32,7 +32,9 @@
import org.cytoscape.work.AbstractTask;
-/** A base class for Tasks that need to operate on a single CyTable cell. */
+/** A base class for Tasks that need to operate on a single CyTable cell.
+ * @CyAPI.Abstract.Class
+ */
public abstract class AbstractTableCellTask extends AbstractTask {
/** The {@link CyColumn} of the {@link org.cytoscape.model.CyTable}
cell */
protected final CyColumn column;
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
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableCellTaskFactory.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -35,6 +35,7 @@
/**
* 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.'
+ * @CyAPI.Abstract.Class
*/
abstract public class AbstractTableCellTaskFactory implements
TableCellTaskFactory {
/** The {@link CyColumn} of the cell that will be used to provision
tasks that are being created by descendants
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableColumnTask.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableColumnTask.java
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableColumnTask.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -32,7 +32,9 @@
import org.cytoscape.work.AbstractTask;
-/** A base class for Tasks that need to operate on an entire CyTable column. */
+/** A base class for Tasks that need to operate on an entire CyTable column.
+ * @CyAPI.Abstract.Class
+ */
public abstract class AbstractTableColumnTask extends AbstractTask {
/** The {@link CyColumn} that descendants will operate on. */
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableTask.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableTask.java
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableTask.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -32,13 +32,15 @@
import org.cytoscape.work.AbstractTask;
-/** A base class for Tasks that need to operate on an entire CyTable. */
+/** A base class for Tasks that need to operate on an entire {@link CyTable}.
+ * @CyAPI.Abstract.Class
+ */
public abstract class AbstractTableTask extends AbstractTask {
/** The table that descendants of this class will operate on. */
protected final CyTable table;
- /** Initializes a Task that needs to operate on a CyTable.
+ /** Initializes a Task that needs to operate on a {@link CyTable}.
* @param table a non-null CyTable
*/
public AbstractTableTask(CyTable table) {
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
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/AbstractTableTaskFactory.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -32,6 +32,7 @@
/**
* Base class for all task factories that create tasks that need to be
provisioned with a {@link CyTable}.
+ * @CyAPI.Abstract.Class
*/
public abstract class AbstractTableTaskFactory implements TableTaskFactory {
/** The table that will be passed into any Task constructor.
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
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/EdgeViewTaskFactory.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -38,6 +38,7 @@
* The assumption is that setEdgeView() will be called before
* getTask() and that the Task in question operates on the
* specified View<CyEdge>.
+ * @CyAPI.Spi.Interface
*/
public interface EdgeViewTaskFactory extends TaskFactory {
/** Used to provision this factory with the edge view and associated
network view that will
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/MapNetworkAttrTask.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/MapNetworkAttrTask.java
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/MapNetworkAttrTask.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -15,13 +15,17 @@
import org.cytoscape.work.AbstractTask;
import org.cytoscape.work.TaskMonitor;
import org.cytoscape.work.Tunable;
-
+
/**
- * This is a simple {@link Task} that will take a loaded table and ask whether
+ * This is a simple {@link org.cytoscape.work.Task} that will take a loaded
table and ask whether
* the columns in the new table should become virtual columns in the node or
* edge table of the current network, all networks, or no networks.
- */
+ * @CyAPI.Final.Class
+ */
public final class MapNetworkAttrTask extends AbstractTask {
+ /**
+ * If true map to current network only.
+ */
@Tunable(description="Map to current network only")
public boolean currentNetworkOnly = true;
@@ -57,7 +61,7 @@
/**
- * Constructor. Will attempt to map existing tables based on the {@link
CyTableEntry.NAME}
+ * Constructor. Will attempt to map existing tables based on the {@link
CyTableEntry#NAME}
* column.
* @param type The type of table to map to, either CyNode.class or
CyEdge.class.
* @param newGlobalTable The table to be mapped.
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
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkCollectionTaskFactory.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -37,6 +37,7 @@
* The assumption is that setNetworkCollection() will be called before
* getTask() and that the Task in question operates on the
* specified CyNetworks.
+ * @CyAPI.Spi.Interface
*/
public interface NetworkCollectionTaskFactory extends TaskFactory {
/** Provisions this factory with the collection of networks that will
be passed into any task
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
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkTaskFactory.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -33,6 +33,7 @@
/**
* The assumption is that setNetwork() will be called before getTask() and that
* the Task in question operates on the specified CyNetwork.
+ * @CyAPI.Spi.Interface
*/
public interface NetworkTaskFactory extends TaskFactory {
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
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkViewCollectionTaskFactory.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -37,6 +37,7 @@
* The assumption is that setNetworkViewCollection() will be called before
* getTask() and that the Task in question operates on the
* specified CyNetworks.
+ * @CyAPI.Spi.Interface
*/
public interface NetworkViewCollectionTaskFactory extends TaskFactory {
/** Provisions this factory with the collection of network views that
will be passed into
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
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NetworkViewTaskFactory.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -36,6 +36,7 @@
* The assumption is that setNetworkView() will be called before
* getTask() and that the Task in question operates on the
* specified CyNetworkView.
+ * @CyAPI.Spi.Interface
*/
public interface NetworkViewTaskFactory extends TaskFactory {
/** Provisions this factory with a {@link CyNetworkView} that will be
passed into any tasks
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
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/NodeViewTaskFactory.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -38,6 +38,7 @@
* The assumption is that setNodeView() will be called before
* getTask() and that the Task in question operates on the
* specified View<CyNode>.
+ * @CyAPI.Spi.Interface
*/
public interface NodeViewTaskFactory extends TaskFactory {
/** Provisions this factory with the node view and its associated
network view, both of
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
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/RowTaskFactory.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -36,6 +36,7 @@
* The assumption is that setRow() will be called before
* getTask() and that the Task in question operates on the
* specified CyNetwork.
+ * @CyAPI.Spi.Interface
*/
public interface RowTaskFactory extends TaskFactory {
/** Provisions this factory with the {@link CyRow} that will be passed
into any task created
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
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/TableCellTaskFactory.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -34,7 +34,8 @@
/**
* 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.'
+ * in question operates on the specified table entry identified by the column
and primary key value.
+ * @CyAPI.Spi.Interface
*/
public interface TableCellTaskFactory extends TaskFactory {
/** Used to provision this factory with a {@link CyColumn} and a
primary key that will be
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
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/TableColumnTaskFactory.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -35,6 +35,7 @@
/**
* The assumption is that setColumn() will be called before getTask() and that
the Task in question
* operates on the specified CyColumn.
+ * @CyAPI.Spi.Interface
*/
public interface TableColumnTaskFactory extends TaskFactory {
/** Used to provision this factory with a {@link CyColumn} that will be
used to create tasks.
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
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/TableTaskFactory.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -35,6 +35,7 @@
/**
* The assumption is that setTable() will be called before getTask() and that
the Task in question
* operates on the specified CyTable.
+ * @CyAPI.Spi.Interface
*/
public interface TableTaskFactory extends TaskFactory {
/** Used to provision this factory with a {@link CyTable} that will be
used to create tasks.
Modified:
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/creation/NewEmptyNetworkViewFactory.java
===================================================================
---
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/creation/NewEmptyNetworkViewFactory.java
2011-11-03 22:15:22 UTC (rev 27398)
+++
core3/api/trunk/core-task-api/src/main/java/org/cytoscape/task/creation/NewEmptyNetworkViewFactory.java
2011-11-04 06:24:47 UTC (rev 27399)
@@ -4,6 +4,7 @@
/**
* An interface for creating new, empty network views.
+ * @CyAPI.Spi.Interface
*/
public interface NewEmptyNetworkViewFactory {
--
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.