org.cytoscape.task.read

Interface LoadMultipleNetworkFilesTaskFactory

All Superinterfaces:

TaskFactory

public interface LoadMultipleNetworkFilesTaskFactory
extends TaskFactory

This interface provides a task iterator for loading networks from multiple files at once.

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(List<File> files, CyRootNetwork rootNetwork) Creates a task iterator for loading one or more networks from supported files (e.g.

Methods inherited from interface org.cytoscape.work.TaskFactory

createTaskIterator, isReady

Method Detail

createTaskIterator

TaskIterator createTaskIterator(List<File> files,
                                CyRootNetwork rootNetwork)

Creates a task iterator for loading one or more networks from supported files (e.g. xgmml, nnf, sif).

Parameters:

files - List of network files.

rootNetwork - Optional Network Collection into which the new networks must be loaded. If null, Cytoscape creates a new root-network for the loaded networks.

Returns:

a task iterator of type TaskIterator