org.cytoscape.task.edit
Interface MergeTablesTaskFactory

All Superinterfaces:

TaskFactory

public interface MergeTablesTaskFactory
extends TaskFactory

This interface provides a task iterator for merging two data tables.

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

TaskIterator

createTaskIterator(CyTable sourceTable, CyTable targetTable, List<String> sourceColumnsList, String sourceKeyColumn, boolean mergeColumnVirtual, boolean mapToNetworks, boolean selectedNetworksOnly, List<CyNetwork> networkList, CyRootNetwork rootNetwork, CyColumn targetJoinColumn, Class<? extends CyIdentifiable> tableType) Creates a task iterator for merging two data tables.

Methods inherited from interface org.cytoscape.work.TaskFactory

createTaskIterator, isReady

Method Detail

createTaskIterator

TaskIterator createTaskIterator(CyTable sourceTable,
                                CyTable targetTable,
                                List<String> sourceColumnsList,
                                String sourceKeyColumn,
                                boolean mergeColumnVirtual,
                                boolean mapToNetworks,
                                boolean selectedNetworksOnly,
                                List<CyNetwork> networkList,
                                CyRootNetwork rootNetwork,
                                CyColumn targetJoinColumn,
                                Class<? extends CyIdentifiable> tableType)

Creates a task iterator for merging two data tables.

Parameters:

sourceTable - The source table where the data to be be merged comes from

targetTable - The target table where the data will be merged to

sourceColumnsList - The list of columns in the source table that will be merged to the target table

sourceKeyColumn - The key column in the source table that will be used to merge the columns in that table to the target table

mergeColumnVirtual - Tells whether the new merged column will be virtual (true) or not

mapToNetworks - Tells if the target table will a network data table(true) or unassigned table(false)

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

networkList - The list of networks to merge the data if the selectedNetworksOnly and the mapToNetworks flags are true

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

targetJoinColumn - The key column in the target table data to be used for merging the data

tableType - The type of the table where the data will be merged, in case the source table is merged to a network data table

Returns:

a task iterator of type TaskIterator.