org.cytoscape.task

Class AbstractNetworkCollectionTask

java.lang.Object

org.cytoscape.work.AbstractTask

org.cytoscape.task.AbstractNetworkCollectionTask

All Implemented Interfaces:

Task

public abstract class AbstractNetworkCollectionTask
extends AbstractTask

The base class for all tasks that need to operate on a Collection of CyNetworks.

Cytoscape Backwards Compatibility (Abstract Class): This class is abstract and meant to be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Module: core-task-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>core-task-api</artifactId>
</dependency>

Field Summary

Fields

Modifier and Type	Field and Description
protected Collection<CyNetwork>	networks The collection of networks that descendants will operate on.

Fields inherited from class org.cytoscape.work.AbstractTask

cancelled

Constructor Summary

Constructors

Constructor and Description
AbstractNetworkCollectionTask(Collection<CyNetwork> networks) Base Constructor for a task that will operate on a collection of networks

Method Summary

Methods inherited from class org.cytoscape.work.AbstractTask

cancel, getTaskIterator, insertTasksAfterCurrentTask, insertTasksAfterCurrentTask, run, setTaskIterator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

networks

protected final Collection<CyNetwork> networks

The collection of networks that descendants will operate on.

Constructor Detail

AbstractNetworkCollectionTask

public AbstractNetworkCollectionTask(Collection<CyNetwork> networks)

Base Constructor for a task that will operate on a collection of networks

Parameters:

networks - a collection of networks