org.cytoscape.task.read

Interface LoadNetworkFileTaskFactory

All Superinterfaces:

TaskFactory

public interface LoadNetworkFileTaskFactory
extends TaskFactory

This interface provides a task iterator for loading networks from a file.

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(File file) Creates a task iterator for loading a network from a file.
TaskIterator	createTaskIterator(File file, TaskObserver observer) Creates a task iterator for loading a network from a file.

Methods inherited from interface org.cytoscape.work.TaskFactory

createTaskIterator, isReady

Method Detail

createTaskIterator

TaskIterator createTaskIterator(File file)

Creates a task iterator for loading a network from a file. The created task runs synchronously in the current thread and does not create a task monitor.

Parameters:

file - The file for loading into a network

Returns:

a task iterator of type TaskIterator

createTaskIterator

TaskIterator createTaskIterator(File file,
                                TaskObserver observer)

Creates a task iterator for loading a network from a file. The created task runs synchronously in the current thread and does not create a task monitor.

Parameters:

file - The file for loading into a network

observer - A TaskObserver to notify when we're complete

Returns:

a task iterator of type TaskIterator