org.cytoscape.task

Class AbstractNetworkViewCollectionTask

java.lang.Object

org.cytoscape.work.AbstractTask

org.cytoscape.task.AbstractNetworkViewCollectionTask

All Implemented Interfaces:

Task

public abstract class AbstractNetworkViewCollectionTask
extends AbstractTask

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

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<CyNetworkView>	networkViews A collection of network views to operate on for any descendants of this class.

Fields inherited from class org.cytoscape.work.AbstractTask

cancelled

Constructor Summary

Constructors

Constructor and Description
AbstractNetworkViewCollectionTask(Collection<CyNetworkView> networkViews) Base class for any tasks that need to operate on a collection of network views.

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

networkViews

protected final Collection<CyNetworkView> networkViews

A collection of network views to operate on for any descendants of this class.

Constructor Detail

AbstractNetworkViewCollectionTask

public AbstractNetworkViewCollectionTask(Collection<CyNetworkView> networkViews)

Base class for any tasks that need to operate on a collection of network views.

Parameters:

networkViews - must be a non-null collection of network views