Cytoscape 3.0.0-alpha8-SNAPSHOT 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.


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
 void setProperty(Object property)
          Specifies the property object to be written by the CyWriter Task generated by this factory.
 
Methods inherited from interface org.cytoscape.io.write.CyWriterFactory
getWriterTask, setOutputStream
 
Methods inherited from interface org.cytoscape.io.CyFileFilterProvider
getFileFilter
 

Method Detail

setProperty

void setProperty(Object property)
Specifies the property object to be written by the CyWriter Task generated by this factory. This method must be called prior to calling the getWriter() method.

Parameters:
property - The property object to be written. In general this object should be of types described in CyProperty.

Cytoscape 3.0.0-alpha8-SNAPSHOT API

Copyright 2011 Cytoscape Consortium. All rights reserved.