org.cytoscape.task.write

Interface SaveSessionAsTaskFactory

All Superinterfaces:

TaskFactory

public interface SaveSessionAsTaskFactory
extends TaskFactory

This interface provides a task iterator for saving a session in a specified 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

Methods

Modifier and Type	Method and Description
TaskIterator	createTaskIterator(File file) Creates a task iterator for saving the session in a specified file.

Methods inherited from interface org.cytoscape.work.TaskFactory

createTaskIterator, isReady

Method Detail

createTaskIterator

TaskIterator createTaskIterator(File file)

Creates a task iterator for saving the session in a specified file.

Parameters:

file - The file that the session is written on.

Returns:

a task iterator of type TaskIterator.