Package org.cytoscape.io.write

Interface VizmapWriterManager

All Superinterfaces:
CyWriterManager<VizmapWriterFactory>
public interface VizmapWriterManager extends CyWriterManager<VizmapWriterFactory>
A CyWriterManager specific to writing VisualStyle 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​(Set<VisualStyle> networkStyles, CyFileFilter filter, File file) throws Exception
      Returns the CyWriter Task that will attempt to write the specified vizmap to the specified file of the specified file type.
      Parameters:
      networkStyles - The list of network VisualStyle objects 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 vizmap to the specified file of the specified file type.
      Throws:
      Exception

    • getWriter

      CyWriter getWriter​(Set<VisualStyle> networkStyles, CyFileFilter filter, OutputStream os) throws Exception
      Returns the CyWriter Task that will attempt to write the specified vizmap to the specified output stream of the specified file type.
      Parameters:
      networkStyles - The list of VisualStyle objects 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 vizmap to the specified output stream of the specified file type.
      Throws:
      Exception

    • getWriter

      CyWriter getWriter​(Set<VisualStyle> networkStyles, Set<VisualStyle> tableStyles, CyFileFilter filter, File file) throws Exception
      Returns the CyWriter Task that will attempt to write the specified vizmap to the specified file of the specified file type.
      Parameters:
      networkStyles - The list of network VisualStyle objects to be written.
      tableStyles - The list of table VisualStyle objects 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 vizmap to the specified file of the specified file type.
      Throws:
      Exception

    • getWriter

      CyWriter getWriter​(Set<VisualStyle> networkStyles, Set<VisualStyle> tableStyles, CyFileFilter filter, OutputStream os) throws Exception
      Returns the CyWriter Task that will attempt to write the specified vizmap to the specified output stream of the specified file type.
      Parameters:
      networkStyles - The list of VisualStyle objects to be written.
      tableStyles - The list of VisualStyle objects 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 vizmap to the specified output stream of the specified file type.
      Throws:
      Exception