Package org.cytoscape.task

Interface NodeViewTaskFactory

  • All Known Subinterfaces:
    CollapseGroupTaskFactory, ExpandGroupTaskFactory, SelectFirstNeighborsNodeViewTaskFactory, UnGroupNodesTaskFactory
    All Known Implementing Classes:
    AbstractNodeViewTaskFactory
    public interface NodeViewTaskFactory
    A task factory that creates a task that operates on the specified View<CyNode> within the specified CyNetworkView.

    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 (SPI Interface): We expect that this interface will be implemented. Therefore to maintain backwards compatibility this interface will only be modified for major version updates.

    • Method Detail

      • createTaskIterator

        TaskIterator createTaskIterator​(View<CyNode> nodeView,
                                CyNetworkView networkView)
        Provisions this factory with the node view and its associated network view, both of which will be passed into any task that will be created by this factory.
        Parameters:
        nodeView - a non-null node view
        networkView - the non-null network view associated with the node view
        Returns:
        A TaskIterator object containing one or more Task objects to execute.

      • isReady

        boolean isReady​(View<CyNode> nodeView,
                CyNetworkView networkView)
        Returns true if the node view and network view are in a state that is ready to be processed by the generated tasks and false otherwise.
        Parameters:
        nodeView - a non-null node view
        networkView - the non-null network view associated with the node view
        Returns:
        true if the node view and network view are in a state that is ready to be processed by the generated tasks and false otherwise.