Cytoscape 2.8.0 API

cytoscape.data.writers
Class InteractionWriter

java.lang.Object
  extended by cytoscape.data.writers.InteractionWriter

public class InteractionWriter
extends Object

A few utility methods to assist in writing SIF files.


Constructor Summary
InteractionWriter()
           
 
Method Summary
static String getInteractionString(CyNetwork network)
          Returns a SIF formatted string of the specified network.
static String getInteractionString(CyNetwork network, TaskMonitor taskMonitor)
          Returns a SIF formatted string of the specified network.
static void writeInteractions(CyNetwork network, Writer writer)
          Writes a SIF formatted string of the specified network to the specified writer.
static void writeInteractions(CyNetwork network, Writer writer, TaskMonitor taskMonitor)
          Writes a SIF formatted string of the specified network to the specified writer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InteractionWriter

public InteractionWriter()
Method Detail

writeInteractions

public static void writeInteractions(CyNetwork network,
                                     Writer writer,
                                     TaskMonitor taskMonitor)
                              throws IOException
Writes a SIF formatted string of the specified network to the specified writer.

Parameters:
network - The network to be written.
writer - The writer the network should be written to.
taskMonitor - An optional task monitor.
Throws:
IOException

writeInteractions

public static void writeInteractions(CyNetwork network,
                                     Writer writer)
                              throws IOException
Writes a SIF formatted string of the specified network to the specified writer.

Parameters:
network - The network to be written.
writer - The writer the network should be written to.
Throws:
IOException

getInteractionString

public static String getInteractionString(CyNetwork network)
Returns a SIF formatted string of the specified network.

Parameters:
network - The network to be formatted as a SIF string.
Returns:
A string of a CyNetwork in SIF format.

getInteractionString

public static String getInteractionString(CyNetwork network,
                                          TaskMonitor taskMonitor)
Returns a SIF formatted string of the specified network.

Parameters:
network - The network to be formatted as a SIF string.
taskMonitor - An optional taskMonitor in case you want to use one. Use null otherwise.
Returns:
A string of a CyNetwork in SIF format.

Cytoscape 2.8.0 API

Copyright 2010 Cytoscape Consortium. All rights reserved.