org.cytoscape.io.write

Interface PresentationWriterFactory

All Superinterfaces:

CyFileFilterProvider, CyWriterFactory

public interface PresentationWriterFactory
extends CyWriterFactory

A specialization of CyWriterFactory that allows a View rendered by the specified RenderingEngine to be specified and written.

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

Methods

Modifier and Type	Method and Description
CyWriter	createWriter(OutputStream os, RenderingEngine<?> re) Creates a single Task that will write the contents of the specified RenderingEngine object to the specified OutputStream.

Methods inherited from interface org.cytoscape.io.CyFileFilterProvider

getFileFilter

Method Detail

createWriter

CyWriter createWriter(OutputStream os,
                    RenderingEngine<?> re)

Creates a single Task that will write the contents of the specified RenderingEngine object to the specified OutputStream.

Parameters:

os - The stream to which the data will be written.

re - The RenderingEngine used to generate the image of the View it contains.