Cytoscape 3.0.1 API

org.cytoscape.io.write
Interface VizmapWriterManager

All Superinterfaces:
CyWriterManager<VizmapWriterFactory>

public interface VizmapWriterManager
extends CyWriterManager<VizmapWriterFactory>

A CyWriterManager specific to writing VisualStyle objects.


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 Summary
 CyWriter getWriter(Set<VisualStyle> styles, CyFileFilter filter, File file)
          Returns the CyWriter Task that will attempt to write the specified vizmap to the specified file of the specified file type.
 CyWriter getWriter(Set<VisualStyle> styles, CyFileFilter filter, OutputStream os)
          Returns the CyWriter Task that will attempt to write the specified vizmap to the specified output stream of the specified file type.
 
Methods inherited from interface org.cytoscape.io.write.CyWriterManager
getAvailableWriterFilters, getMatchingFactory
 

Method Detail

getWriter

CyWriter getWriter(Set<VisualStyle> styles,
                   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:
styles - The list of 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> styles,
                   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:
styles - 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

Cytoscape 3.0.1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.