org.cytoscape.io.read
Interface CySessionReader

All Superinterfaces:

Task

public interface CySessionReader
extends Task

An extension of the Task interface that returns a org.cytoscape.property.session.Cysession object. The reader does nothing beyond create the org.cytoscape.property.session.Cysession object and does NOT use the org.cytoscape.property.session.Cysession object to define the state of Cytoscape - that is managed by the CySessionManager. Instances of this interface are created by InputStreamTaskFactory objects registered as OSGi services, which are in turn processed by associated reader manager objects that distinguish InputStreamTaskFactories based on the DataCategory associated with the CyFileFilter.

Module: io-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>io-api</artifactId>
</dependency>

Cytoscape Backwards Compatibility (SPI Interface): We expect that this interface will be implemented. Therefore to maintain backwards compatibility this interface will only be modified for major version updates.

Method Summary

CySession

getSession() Returns a CySession object

Methods inherited from interface org.cytoscape.work.Task

cancel, run

Method Detail

getSession

CySession getSession()

Returns a CySession object

Returns:

A CySession object.