Interface SelectFromFileListTaskFactory

  • All Superinterfaces:
    NetworkTaskFactory

    public interface SelectFromFileListTaskFactory
    extends NetworkTaskFactory
    This interface provides a task iterator for selecting items based on a file. The file should be a simple text file with one identifier per line.

    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>

    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.
    • Method Detail

      • createTaskIterator

        TaskIterator createTaskIterator​(CyNetwork network,
                                        File file)
        Creates a task iterator for selecting items of a network based on a file.
        Parameters:
        network - The target network to select nodes and edges from.
        file - The file that has the selection list in. The file should be a simple text file with one identifier per line.
        Returns:
        a task iterator of type TaskIterator.