Interface VizmapWriterFactory

All Superinterfaces:
CyFileFilterProvider, CyWriterFactory

public interface VizmapWriterFactory extends CyWriterFactory
A specialization of CyWriterFactory that allows a VisualStyle to be specified and written.

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.

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>
  • Method Details

    • createWriter

      CyWriter createWriter(OutputStream os, Set<VisualStyle> networkStyles)
      Creates a single Task that will write the specified set of VisualStyle objects to the specified OutputStream.
      Parameters:
      os - The stream to which the data will be written.
      networkStyles - A list of network VisualStyle objects to be written.
    • createWriter

      default CyWriter createWriter(OutputStream os, Set<VisualStyle> networkStyles, Set<VisualStyle> tableStyles)
      Creates a single Task that will write the specified set of VisualStyle objects to the specified OutputStream.
      Parameters:
      os - The stream to which the data will be written.
      networkStyles - A list of network VisualStyle objects to be written.
      tableStyles - A list of table VisualStyle objects to be written.
      Since:
      3.9
    • createWriter

      default CyWriter createWriter(OutputStream os, Set<VisualStyle> networkStyles, Set<VisualStyle> tableStyles, Set<StyleAssociation> columnStyleAssociations)
      Creates a single Task that will write the specified set of VisualStyle objects to the specified OutputStream.
      Parameters:
      os - The stream to which the data will be written.
      networkStyles - A list of network VisualStyle objects to be written.
      tableStyles - A list of table VisualStyle objects to be written.
      columnStyleAssociations - A list of StyleAssociation objects to be written.
      Since:
      3.9