Cytoscape 3.0.0-alpha8-SNAPSHOT API

org.cytoscape.task
Class MapNetworkAttrTask

java.lang.Object
  extended by org.cytoscape.work.AbstractTask
      extended by org.cytoscape.task.MapNetworkAttrTask
All Implemented Interfaces:
Task

public final class MapNetworkAttrTask
extends AbstractTask

This is a simple Task that will take a loaded table and ask whether the columns in the new table should become virtual columns in the node or edge table of the current network, all networks, or no networks.


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.

Field Summary
static ListSingleSelection<String> whichTable
           
 
Fields inherited from class org.cytoscape.work.AbstractTask
cancelled
 
Constructor Summary
MapNetworkAttrTask(Class<? extends CyIdentifiable> type, CyTable newGlobalTable, CyNetworkManager networkManager, CyApplicationManager applicationManager, CyRootNetworkManager rootNetworkManager)
          Constructor.
MapNetworkAttrTask(Class<? extends CyIdentifiable> type, CyTable newGlobalTable, String mappingKey, CyNetworkManager networkManager, CyApplicationManager applicationManager, CyRootNetworkManager rootNetworkManager)
          Constructor.
 
Method Summary
 String getTitle()
           
 void run(TaskMonitor taskMonitor)
          Executes the task.
 
Methods inherited from class org.cytoscape.work.AbstractTask
cancel, insertTasksAfterCurrentTask, insertTasksAfterCurrentTask, setTaskIterator
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

whichTable

public static ListSingleSelection<String> whichTable
Constructor Detail

MapNetworkAttrTask

public MapNetworkAttrTask(Class<? extends CyIdentifiable> type,
                          CyTable newGlobalTable,
                          String mappingKey,
                          CyNetworkManager networkManager,
                          CyApplicationManager applicationManager,
                          CyRootNetworkManager rootNetworkManager)
Constructor.

Parameters:
type - The type of table to map to, either CyNode.class or CyEdge.class.
newGlobalTable - The table to be mapped.
mappingKey - The column name in the existing table used to join with the primary key in the new table.
networkManager - The network manager used to access the list of all networks.
applicationManager - The application manager used to access the current network.

MapNetworkAttrTask

public MapNetworkAttrTask(Class<? extends CyIdentifiable> type,
                          CyTable newGlobalTable,
                          CyNetworkManager networkManager,
                          CyApplicationManager applicationManager,
                          CyRootNetworkManager rootNetworkManager)
Constructor. Will attempt to map existing tables based on the CyIdentifiable#NAME column.

Parameters:
type - The type of table to map to, either CyNode.class or CyEdge.class.
newGlobalTable - The table to be mapped.
networkManager - The network manager used to access the list of all networks.
applicationManager - The application manager used to access the current network.
Method Detail

getTitle

public String getTitle()

run

public void run(TaskMonitor taskMonitor)
         throws Exception
Executes the task.

Specified by:
run in interface Task
Specified by:
run in class AbstractTask
Parameters:
taskMonitor - The TaskMonitor used to track the state of the task execution.
Throws:
Exception - All Exceptions throw will be caught and handled by the TaskManager executing the task.

Cytoscape 3.0.0-alpha8-SNAPSHOT API

Copyright 2011 Cytoscape Consortium. All rights reserved.