org.cytoscape.task.edit

Interface RenameColumnTaskFactory

All Superinterfaces:

TableColumnTaskFactory

public interface RenameColumnTaskFactory
extends TableColumnTaskFactory

This interface provides a task iterator for renaming a column.

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(CyColumn column, String newColumnName) Create a task iterator for renaming a selected column.

Methods inherited from interface org.cytoscape.task.TableColumnTaskFactory

createTaskIterator, isReady

Method Detail

createTaskIterator

TaskIterator createTaskIterator(CyColumn column,
                                String newColumnName)

Create a task iterator for renaming a selected column. The created task will run synchronously in the current thread and will not create a task monitor.

Parameters:

column - The selected column for renaming.

newColumnName - The new name for the selected column.

Returns:

a task iterator of type TaskIterator.