org.cytoscape.task.read

Interface OpenSessionTaskFactory

All Superinterfaces:

TaskFactory

public interface OpenSessionTaskFactory
extends TaskFactory

This interface provides a task iterator for loading a session.

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 session from a file.
TaskIterator	createTaskIterator(File file, boolean confirm) Creates a task iterator for loading a session from a file, with an option to let the user confirm it before disposing the current session if it is not empty.

Methods inherited from interface org.cytoscape.work.TaskFactory

createTaskIterator, isReady

Method Detail

createTaskIterator

TaskIterator createTaskIterator(File file)

Creates a task iterator for loading a session from a file. The task created here will not ask the user to confirm it, even if there is currently a non-empty session. This is the same as calling createTaskIterator(file, false).

Parameters:

file - The input file for loading the session from.

Returns:

a task iterator of type TaskIterator.

createTaskIterator

TaskIterator createTaskIterator(File file,
                                boolean confirm)

Creates a task iterator for loading a session from a file, with an option to let the user confirm it before disposing the current session if it is not empty.

Parameters:

file - The input file for loading the session from.

confirm - Whether or not Cytoscape should ask the user to confirm this action.

Returns:

a task iterator of type TaskIterator.