Cytoscape 3.0.0-alpha8-SNAPSHOT API

org.cytoscape.io.write
Interface CyWriterFactory

All Superinterfaces:
CyFileFilterProvider
All Known Subinterfaces:
CyNetworkViewWriterFactory, CyPropertyWriterFactory, CySessionWriterFactory, CyTableWriterFactory, PresentationWriterFactory, VizmapWriterFactory

public interface CyWriterFactory
extends CyFileFilterProvider

CyWriterFactory defines the base methods for specifying output and for generating a Task to write the actual output. Instantiations of CyWriterFactories are meant to be singleton objects registered as OSGi services.


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
 CyWriter getWriterTask()
          Returns a CyWriter Task suitable for writing to the specified output stream.
 void setOutputStream(OutputStream os)
          This method defines where the generated CyWriter Task should write its data to.
 
Methods inherited from interface org.cytoscape.io.CyFileFilterProvider
getFileFilter
 

Method Detail

setOutputStream

void setOutputStream(OutputStream os)
This method defines where the generated CyWriter Task should write its data to. This method is meant to be called prior to calling getWriter().

Parameters:
os - The OutputStream to be written to.

getWriterTask

CyWriter getWriterTask()
Returns a CyWriter Task suitable for writing to the specified output stream.

Returns:
A CyWriter Task suitable for writing to the specified output stream.

Cytoscape 3.0.0-alpha8-SNAPSHOT API

Copyright 2011 Cytoscape Consortium. All rights reserved.