Cytoscape 3.1.1 API

org.cytoscape.io.write
Interface CyPropertyWriterFactory

All Superinterfaces:
CyFileFilterProvider, CyWriterFactory

public interface CyPropertyWriterFactory
extends CyWriterFactory

A specialization of CyWriterFactory that allows a property Object to be specified and written. See CyProperty for details on the type of Object.


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
 CyWriter createWriter(OutputStream os, Object property)
          Creates a single Task that will write the specified property object to the specified OutputStream.
 
Methods inherited from interface org.cytoscape.io.CyFileFilterProvider
getFileFilter
 

Method Detail

createWriter

CyWriter createWriter(OutputStream os,
                      Object property)
Creates a single Task that will write the specified property object to the specified OutputStream.

Parameters:
os - The stream to which the data will be written.
property - The property object to be written. In general this object should be of types described in CyProperty.

Cytoscape 3.1.1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.