org.cytoscape.io.read

Interface CyNetworkReader

All Superinterfaces:

Task

All Known Implementing Classes:

AbstractCyNetworkReader

public interface CyNetworkReader
extends Task

An extension of the Task interface that returns an array of CyNetwork objects that are read as part of the Task. An additional method provides an option for readers to create CyNetworkViews from the networks it has read as well. 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

Modifier and Type	Method and Description
CyNetworkView	buildCyNetworkView(CyNetwork network) A method to build a CyNetworkView from one of the networks just read.
CyNetwork[]	getNetworks() Returns an array of networks read after executing the run() method of Task.

Methods inherited from interface org.cytoscape.work.Task

cancel, run

Method Detail

getNetworks

CyNetwork[] getNetworks()

Returns an array of networks read after executing the run() method of Task.

Returns:

an array of networks read after executing the run() method of Task.

buildCyNetworkView

CyNetworkView buildCyNetworkView(CyNetwork network)

A method to build a CyNetworkView from one of the networks just read.

Parameters:

network - A network just read by the task and part of the getCyNetworks() array.

Returns:

A CyNetworkView created by the reader for the network specified.