Package org.cytoscape.io.write
Interface VizmapWriterManager
- All Superinterfaces:
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 Summary
Modifier and TypeMethodDescriptiongetWriter
(Set<VisualStyle> networkStyles, Set<VisualStyle> tableStyles, Set<StyleAssociation> columnStyleAssociations, CyFileFilter filter, File file) Returns theCyWriter
Task that will attempt to write the specified vizmap to the specified file of the specified file type.getWriter
(Set<VisualStyle> networkStyles, Set<VisualStyle> tableStyles, Set<StyleAssociation> columnStyleAssociations, CyFileFilter filter, OutputStream os) Returns theCyWriter
Task that will attempt to write the specified vizmap to the specified output stream of the specified file type.getWriter
(Set<VisualStyle> networkStyles, Set<VisualStyle> tableStyles, CyFileFilter filter, File file) Returns theCyWriter
Task that will attempt to write the specified vizmap to the specified file of the specified file type.getWriter
(Set<VisualStyle> networkStyles, Set<VisualStyle> tableStyles, CyFileFilter filter, OutputStream os) Returns theCyWriter
Task that will attempt to write the specified vizmap to the specified output stream of the specified file type.getWriter
(Set<VisualStyle> networkStyles, CyFileFilter filter, File file) Returns theCyWriter
Task that will attempt to write the specified vizmap to the specified file of the specified file type.getWriter
(Set<VisualStyle> networkStyles, CyFileFilter filter, OutputStream os) Returns theCyWriter
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 Details
-
getWriter
Returns theCyWriter
Task that will attempt to write the specified vizmap to the specified file of the specified file type.- Parameters:
networkStyles
- The list of networkVisualStyle
objects to be written.filter
- TheCyFileFilter
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 theCyWriter
Task that will attempt to write the specified vizmap to the specified output stream of the specified file type.- Parameters:
networkStyles
- The list ofVisualStyle
objects to be written.filter
- TheCyFileFilter
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 theCyWriter
Task that will attempt to write the specified vizmap to the specified file of the specified file type.- Parameters:
networkStyles
- The list of networkVisualStyle
objects to be written.tableStyles
- The list of tableVisualStyle
objects to be written.filter
- TheCyFileFilter
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 theCyWriter
Task that will attempt to write the specified vizmap to the specified output stream of the specified file type.- Parameters:
networkStyles
- The list ofVisualStyle
objects to be written.tableStyles
- The list ofVisualStyle
objects to be written.filter
- TheCyFileFilter
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, Set<StyleAssociation> columnStyleAssociations, CyFileFilter filter, File file) throws Exception Returns theCyWriter
Task that will attempt to write the specified vizmap to the specified file of the specified file type.- Parameters:
networkStyles
- The list of networkVisualStyle
objects to be written.tableStyles
- The list of tableVisualStyle
objects to be written.filter
- TheCyFileFilter
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, Set<StyleAssociation> columnStyleAssociations, CyFileFilter filter, OutputStream os) throws Exception Returns theCyWriter
Task that will attempt to write the specified vizmap to the specified output stream of the specified file type.- Parameters:
networkStyles
- The list ofVisualStyle
objects to be written.tableStyles
- The list ofVisualStyle
objects to be written.filter
- TheCyFileFilter
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
-