org.cytoscape.io.write

Interface CyPropertyWriterManager

All Superinterfaces:

CyWriterManager<CyPropertyWriterFactory>

public interface CyPropertyWriterManager
extends CyWriterManager<CyPropertyWriterFactory>

A CyWriterManager specific to writing property objects. See CyProperty for information on types of object expected.

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.

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 Summary

Modifier and Type	Method and Description
List<CyFileFilter>	getAvailableWriterFilters() Returns the CyFileFilters known to this CyWriter manager.
CyWriter	getWriter(Object property, CyFileFilter filter, File file) Returns the CyWriter Task that will attempt to write the specified property object to the specified file of the specified file type.
CyWriter	getWriter(Object property, CyFileFilter filter, OutputStream os) Returns the CyWriter Task that will attempt to write the specified property object to the specified output stream of the specified file type.

Methods inherited from interface org.cytoscape.io.write.CyWriterManager

getMatchingFactory

Method Detail

getAvailableWriterFilters

List<CyFileFilter> getAvailableWriterFilters()

Returns the CyFileFilters known to this CyWriter manager.

Specified by:

getAvailableWriterFilters in interface CyWriterManager<CyPropertyWriterFactory>

Returns:

the set of known file filters.

getWriter

CyWriter getWriter(Object property,
                   CyFileFilter filter,
                   File file)
            throws Exception

Returns the CyWriter Task that will attempt to write the specified property object to the specified file of the specified file type.

Parameters:

property - The property object 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 property object to the specified file of the specified file type.

Throws:

Exception

getWriter

CyWriter getWriter(Object property,
                   CyFileFilter filter,
                   OutputStream os)
            throws Exception

Returns the CyWriter Task that will attempt to write the specified property object to the specified output stream of the specified file type.

Parameters:

property - The property object 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 property object to the specified output stream of the specified file type.

Throws:

Exception