Class AbstractParallelPartitionLayoutTask

All Implemented Interfaces:

public abstract class AbstractParallelPartitionLayoutTask extends AbstractPartitionLayoutTask
This is an even more helpful implementation of a LayoutAlgorithm Task that extends AbstractPartitionLayoutTask and does the work of partitioning the CyNetworkView so that partitions may be laid out individually. The layout is applied to multiple partitions in parallel. Extensions of this class are meant to implement the layoutPartition() method and operate on the LayoutParition object that is passed to that method as an argument. Extensions should also make sure everything is thread-safe.

Cytoscape Backwards Compatibility (Abstract Class): This class is abstract and meant to be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Module: layout-api

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

  • Constructor Details

    • AbstractParallelPartitionLayoutTask

      public AbstractParallelPartitionLayoutTask(String displayName, boolean singlePartition, CyNetworkView networkView, Set<View<CyNode>> nodesToLayOut, String layoutAttribute, UndoSupport undo)
      Creates a new AbstractPartitionLayoutTask object.
      name - The name of the layout algorithm.
      singlePartition - Whether this layout algorithm should execute on a single partition instead of multiple partitions.
      networkView - the CyNetworkView being partitioned.
      nodesToLayOut - the set of nodes to layout.
      layoutAttribute - the name of the attribute to use for this layout. Allowed to be empty or null.
  • Method Details

    • doLayout

      public void doLayout(TaskMonitor taskMonitor)
      AbstractGraphPartitionLayout implements the doLayout method of AbstractBasicLayout in which it calls the layoutParition method on each LayoutPartition object created for the network.
      doLayout in class AbstractPartitionLayoutTask
      taskMonitor - the TaskMonitor provided by the run() method of the Task.