org.cytoscape.io.write
Class CySessionWriter
java.lang.Object
org.cytoscape.work.AbstractTask
org.cytoscape.io.write.CySessionWriter
- All Implemented Interfaces:
- CyWriter, Task
public final class CySessionWriter
- extends AbstractTask
- implements CyWriter
A utility Task implementation that writes a CySession to a file.
Cytoscape Backwards Compatibility (Final Class): This class is final and therefore can't be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.
|
Method Summary |
void |
run(TaskMonitor tm)
The method that will actually write the specified session to the specified
file. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.cytoscape.work.Task |
cancel |
CySessionWriter
public CySessionWriter(CySessionWriterManager writerMgr,
CySession session,
File outputFile)
- Constructs this CySessionWriter.
- Parameters:
writerMgr - The CySessionWriterManager contains single expected
CySessionWriterFactory to use to write the file.session - The CySession to be written out.outputFile - The file the CySession should be written to.
run
public final void run(TaskMonitor tm)
throws Exception
- The method that will actually write the specified session to the specified
file.
- Specified by:
run in interface Task- Specified by:
run in class AbstractTask
- Parameters:
tm - The TaskMonitor provided by the TaskManager execution environment.
- Throws:
Exception - The Task is at liberty to
throw an exception in run. The exception is
caught by TaskManager and is displayed in the interface.
If a Task does not throw an exception,
the Task implementation does not
need to specify the throws Exception clause
for the run method. Moreover, exceptions
should be the way the Task communicates
the occurrence of a fatal error, like a low-level exception or an invalid parameter,
to the TaskManager.
Copyright 2011 Cytoscape Consortium. All rights reserved.