Package org.cytoscape.io.write

Interface CySessionWriterManager

All Superinterfaces:
CyWriterManager<CySessionWriterFactory>
public interface CySessionWriterManager extends CyWriterManager<CySessionWriterFactory>
A CyWriterManager specific to writing CySession objects.

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 (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.

  • Method Details

    • getWriter

      CyWriter getWriter(CySession session, CyFileFilter filter, File file) throws Exception
      Returns the CyWriter Task that will attempt to write the specified session to the specified file of the specified file type.
      Parameters:
      session - The CySession to be written.
      filter - The CyFileFilter that defines the type of file to be written.
      file - The file to be written.
      Returns:
      The CyWriter Task that will attempt to write the specified session to the specified file of the specified file type.
      Throws:
      Exception

    • getWriter

      CyWriter getWriter(CySession session, CyFileFilter filter, OutputStream os) throws Exception
      Returns the CyWriter Task that will attempt to write the specified session to the specified output stream of the specified file type.
      Parameters:
      session - The CySession to be written.
      filter - The CyFileFilter that defines the type of file to be written.
      os - The output stream to be written.
      Returns:
      The CyWriter Task that will attempt to write the specified session to the specified output stream of the specified file type.
      Throws:
      Exception