org.cytoscape.task.write

Interface ExportNetworkViewTaskFactory

All Superinterfaces:

NetworkViewTaskFactory

public interface ExportNetworkViewTaskFactory
extends NetworkViewTaskFactory

This interface provides a task iterator for exporting network views.

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(CyNetworkView view, File file) Creates the task iterator for exporting network views.

Methods inherited from interface org.cytoscape.task.NetworkViewTaskFactory

createTaskIterator, isReady

Method Detail

createTaskIterator

TaskIterator createTaskIterator(CyNetworkView view,
                                File file)

Creates the task iterator for exporting network views. Notice that this task will be synced with the current thread and it will not create a new thread or a new task monitor.

Parameters:

view - Selected view for export.

file - The file to store the exported view.

Returns:

Task iterator for running the task.