org.cytoscape.task.create

Interface NewNetworkSelectedNodesOnlyTaskFactory

All Superinterfaces:

NetworkTaskFactory

public interface NewNetworkSelectedNodesOnlyTaskFactory
extends NetworkTaskFactory

This interface provides a task iterator for creating networks from selected nodes only.

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.

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>

Method Summary

Modifier and Type	Method and Description
TaskIterator	createTaskIterator(CyNetwork network) Returns a TaskIterator that creates a new network from the selected nodes in the given network.

Methods inherited from interface org.cytoscape.task.NetworkTaskFactory

isReady

Method Detail

createTaskIterator

TaskIterator createTaskIterator(CyNetwork network)

Returns a TaskIterator that creates a new network from the selected nodes in the given network. The given observer will be notified once the new network is complete.

Specified by:

createTaskIterator in interface NetworkTaskFactory

Parameters:

network - The network whose selected nodes should be used in the new network.

Returns:

a TaskIterator that creates a new network from the selected nodes in the given network.