org.cytoscape.task.edit

Interface ImportDataTableTaskFactory

All Superinterfaces:

TableTaskFactory

public interface ImportDataTableTaskFactory
extends TableTaskFactory

This interface provides a task iterator for importing a table data in a network data table.

Cytoscape Backwards Compatibility (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.

Module: core-task-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>core-task-api</artifactId>
</dependency>

Method Summary

Modifier and Type	Method and Description
TaskIterator	createTaskIterator(CyTable globalTable, boolean selectedNetworksOnly, boolean loadToUnassignedTable, List<CyNetwork> networkList, CyRootNetwork rootNetwork, CyColumn targetJoinColumn, Class<? extends CyIdentifiable> tableType) Creates a task iterator for importing a table data in a network data table.
TaskIterator	createTaskIterator(CyTableReader reader) Creates a task iterator for importing a table data in a network data table.

Methods inherited from interface org.cytoscape.task.TableTaskFactory

createTaskIterator, isReady

Method Detail

createTaskIterator

TaskIterator createTaskIterator(CyTable globalTable,
                                boolean selectedNetworksOnly,
                                boolean loadToUnassignedTable,
                                List<CyNetwork> networkList,
                                CyRootNetwork rootNetwork,
                                CyColumn targetJoinColumn,
                                Class<? extends CyIdentifiable> tableType)

Creates a task iterator for importing a table data in a network data table.

Parameters:

globalTable - The table where the data to be imported is stored

selectedNetworksOnly - Tells if the import is going to be on selected networks(true) or to a network collection (false)

loadToUnassignedTable - Tells if the import is going to be for loading an unassigned table(true) or to load data to one of network tables(Node, Edge or Network Tables) (false)

networkList - The list of networks to import the data if the selectedNetworksOnly flag is true

rootNetwork - The root network of the chosen network collection to import the data

targetJoinColumn - The key column in the network collection table data to import the data

tableType - The type of the table where the data will be imported

Returns:

a task iterator of type TaskIterator.

createTaskIterator

TaskIterator createTaskIterator(CyTableReader reader)

Creates a task iterator for importing a table data in a network data table.

Parameters:

reader - The table reader where the data to be imported is stored

Returns:

a task iterator of type TaskIterator.