org.cytoscape.task.create

Interface CreateNetworkViewTaskFactory

All Superinterfaces:

NetworkCollectionTaskFactory

public interface CreateNetworkViewTaskFactory
extends NetworkCollectionTaskFactory

This interface provides a task iterator for creating network views.

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>

Cytoscape Backwards Compatibility (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.

Method Summary

Modifier and Type	Method and Description
TaskIterator	createTaskIterator(Collection<CyNetwork> networks, CyNetworkViewFactory factory) Use this method to create a network view for each of the passed networks.

Methods inherited from interface org.cytoscape.task.NetworkCollectionTaskFactory

createTaskIterator, isReady

Method Detail

createTaskIterator

TaskIterator createTaskIterator(Collection<CyNetwork> networks,
                                CyNetworkViewFactory factory)

Use this method to create a network view for each of the passed networks. The CyNetworkView objects will actually be created by the passed CyNetworkViewFactory.

Parameters:

networks - a non-null collection of CyNetworks

factory - the network view factory which will be used to create the views.

Returns:

A TaskIterator object containing one or more Task objects to execute.