LayoutGeneratorSmart (vworkflows-core 0.2.4.3)

java.lang.Object
- eu.mihosoft.vrl.workflow.incubating.LayoutGeneratorSmart

All Implemented Interfaces:

LayoutGenerator
```
public class LayoutGeneratorSmart
extends Object
implements LayoutGenerator
```
This class provides a sophisticated implementation for the LayoutGenerator interface based on layout algorithms implemented in the Java Universal Network/Graph Drawing Framework.

Author:

Tobias Mertz

Constructor Summary

Constructors
Constructor and Description

LayoutGeneratorSmart()
Default constructor.

LayoutGeneratorSmart(boolean pdebug)
Constructor with debug-functionality.

Constructors
Constructor and Description
`LayoutGeneratorSmart()` Default constructor.
`LayoutGeneratorSmart(boolean pdebug)` Constructor with debug-functionality.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`generateLayout()` Applies all steps of the layout, whose launch-parameters are set to true.
`double`	`getAlignmentThreshold()` Sets the alignment parameter used to align nodes with each other.
`double`	`getAspectratio()` Returns the aspect ratio of the initial drawing area of the graph.
`boolean`	`getAutoscaleNodes()` If set to true, subflow nodes in the given workflow are automatically scaled to fit their contents.
`boolean`	`getDebug()` If set to true, debugging output will be printed in the command line.
`double`	`getDirection()` Returns the desired average edge direction of the resulting graph as an angle to the abscissa in degrees.
`int`	`getGraphmode()` Returns the set input type.
`boolean`	`getLaunchAlignNodes()` If set to true, nodes will be aligned either with each other or on a global grid.
`boolean`	`getLaunchDisplaceIdents()` If set to true, nodes that are placed on the same coordinates will be displaced slightly, so the forcePush step can move them accordingly.
`boolean`	`getLaunchForcePush()` If set to true, all nodes will repel each other until no overlaps between nodes are left or the maximum amount of iterations has been reached.
`boolean`	`getLaunchJungLayout()` If set to true, the specified algorithm from the JUNG-library is applied to the graph.
`boolean`	`getLaunchOrigin()` If set to true, nodes with an in-degree of 0 will be placed at the leftmost edge of the drawing space.
`boolean`	`getLaunchPushBack()` If set to true, all nodes will be pushed past their predecessors, so no edges have a direction inverse to the specified direction.
`boolean`	`getLaunchRemoveCycles()` If set to true, a depth-first-search is performed and all back edges are removed from the model graph.
`boolean`	`getLaunchRotate()` If set to true, the graph is rotated to reach an average flow direction that is the direction specified.
`boolean`	`getLaunchSeparateDisjunctGraphs()` If set to true, disjunct parts of the model graph will be laid out separately and then arranged over each other to create the cumulative layout.
`boolean`	`getLaunchSeparateEdgeTypes()` If set to true, edge types will be separated and a layout generated that follows edge type priorities.
`int`	`getLayoutSelector()` Returns the Jung layout that is used in the first step of the algorithm.
`int`	`getMaxiterations()` Returns the maximum amount of iterations used by the force push step of the algorithm.
`edu.uci.ics.jung.graph.DirectedGraph<VNode,Connection>`	`getModelGraph()` Returns the model graph to be laid out.
`Collection<VNode>`	`getNodelist()` Returns a list of the nodes to be laid out.
`boolean`	`getRecursive()` If set to true, the layout is applied to all subflows of the given workflow recursively.
`double`	`getScaling()` Returns the scaling parameter of the algorithm.
`double`	`getSubflowscale()` Returns the scaling factor that is used to scale subflow-nodes in the autoscaleNodes procedure.
`VFlowModel`	`getWorkflow()` Returns the workflow to be laid out.
`void`	`setAlignmentThreshold(double palignmentThreshold)` Sets the alignment parameter used to align nodes with each other.
`void`	`setAspectratio(double paspectratio)` Sets the aspect ratio of the initial drawing area of the graph.
`void`	`setAutoscaleNodes(boolean pautoscaleNodes)` If set to true, subflow nodes in the given workflow are automatically scaled to fit their contents.
`void`	`setDebug(boolean pdebug)` If set to true, debugging output will be printed in the command line.
`void`	`setDirection(double pdirection)` Sets the desired average edge direction as an angle to the abscissa in degrees.
`void`	`setGraphmode(int pgraphmode)` Sets the input type.
`void`	`setLaunchAlignNodes(boolean plaunchAlignNodes)` If set to true, nodes will be aligned either with each other or on a global grid.
`void`	`setLaunchDisplaceIdents(boolean plaunchDisplaceIdents)` If set to true, nodes that are placed on the same coordinates will be displaced slightly, so the forcePush step can move them accordingly.
`void`	`setLaunchForcePush(boolean plaunchForcePush)` If set to true, all nodes will repel each other until no overlaps between nodes are left or the maximum amount of iterations has been reached.
`void`	`setLaunchJungLayout(boolean plaunchJungLayout)` If set to true, the specified algorithm from the JUNG-library is applied to the graph.
`void`	`setLaunchOrigin(boolean plaunchOrigin)` If set to true, nodes with an in-degree of 0 will be placed at the leftmost edge of the drawing space.
`void`	`setLaunchPushBack(boolean plaunchPushBack)` If set to true, all nodes will be pushed past their predecessors, so no edges have a direction inverse to the specified direction.
`void`	`setLaunchRemoveCycles(boolean plaunchRemoveCycles)` If set to true, a depth-first-search is performed and all back edges are removed from the model graph.
`void`	`setLaunchRotate(boolean plaunchRotate)` If set to true, the graph is rotated to reach an average flow direction that is the direction specified.
`void`	`setLaunchSeparateDisjunctGraphs(boolean plaunchSeparateDisjunctGraphs)` If set to true, disjunct parts of the model graph will be laid out separately and then arranged over each other to create the cumulative layout.
`void`	`setLaunchSeparateEdgeTypes(boolean plaunchSeparateEdgeTypes)` If set to true, edge types will be separated and a layout generated that follows edge type priorities.
`void`	`setLayoutSelector(int playoutSelector)` Select the Jung layout that is supposed to be used in the first step of the algorithm.
`void`	`setMaxiterations(int pmaxiterations)` Sets the maximum amount of iterations for the force push step of the algorithm.
`void`	`setModelGraph(edu.uci.ics.jung.graph.DirectedGraph<VNode,Connection> pjgraph)` Sets the model graph to be laid out.
`void`	`setNodelist(Collection<VNode> pnodelist)` Sets the list of nodes to be laid out.
`void`	`setRecursive(boolean precursive)` If set to true, the layout is applied to all subflows of the given workflow recursively.
`void`	`setScaling(double pscaling)` Sets the scaling parameter of the algorithm.
`void`	`setSubflowscale(double psubflowscale)` Sets the scaling factor that is used to scale subflow-nodes in the autoscaleNodes procedure.
`void`	`setWorkflow(VFlowModel pworkflow)` Sets the workflow to be laid out.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LayoutGeneratorSmart
```
public LayoutGeneratorSmart()
```
    Default constructor. All parameters are initialized with default values.
  - LayoutGeneratorSmart
```
public LayoutGeneratorSmart(boolean pdebug)
```
    Constructor with debug-functionality. Debug parameter can be set, all other parameters are initialized with default values.
    
    Parameters:
    
    pdebug - boolean
- Method Detail
  - getWorkflow
```
public VFlowModel getWorkflow()
```
    Returns the workflow to be laid out.
    
    Specified by:
    
    getWorkflow in interface LayoutGenerator
    
    Returns:
    
    VFlowModel
  - getModelGraph
```
public edu.uci.ics.jung.graph.DirectedGraph<VNode,Connection> getModelGraph()
```
    Returns the model graph to be laid out. default: a graph is generated automatically from the workflow given.
    
    Returns:
    
    DirectedGraph
  - getNodelist
```
public Collection<VNode> getNodelist()
```
    Returns a list of the nodes to be laid out. default: the nodelist is gathered from the given workflow.
    
    Returns:
    
    Collection
  - getRecursive
```
public boolean getRecursive()
```
    If set to true, the layout is applied to all subflows of the given workflow recursively. default: true
    
    Specified by:
    
    getRecursive in interface LayoutGenerator
    
    Returns:
    
    boolean
  - getAutoscaleNodes
```
public boolean getAutoscaleNodes()
```
    If set to true, subflow nodes in the given workflow are automatically scaled to fit their contents. default: true
    
    Specified by:
    
    getAutoscaleNodes in interface LayoutGenerator
    
    Returns:
    
    boolean
  - getLayoutSelector
```
public int getLayoutSelector()
```
    Returns the Jung layout that is used in the first step of the algorithm. 0 - ISOM Layout 1 - FR Layout 2 - KK Layout 3 - DAG Layout (Does not terminate if the graph contains cycles) default: 0
    
    Returns:
    
    int
  - getAspectratio
```
public double getAspectratio()
```
    Returns the aspect ratio of the initial drawing area of the graph. Width is determined via the longest path in the graph. Height is determined by dividing the width by the aspect ratio. default: 16:9
    
    Returns:
    
    double
  - getGraphmode
```
public int getGraphmode()
```
    Returns the set input type. 0 - VFlowModel (setWorkflow) 1 - jgraph (setModelGraph) 2 - nodelist (setNodelist) The input must be delivered via the corresponding setter method before the call of generateLayout(). default: 0
    
    Returns:
    
    int
  - getLaunchRemoveCycles
```
public boolean getLaunchRemoveCycles()
```
    If set to true, a depth-first-search is performed and all back edges are removed from the model graph. The layout is then applied without these edges. Is only run if the graph contains cycles. default: true
    
    Returns:
    
    boolean
  - getLaunchSeparateDisjunctGraphs
```
public boolean getLaunchSeparateDisjunctGraphs()
```
    If set to true, disjunct parts of the model graph will be laid out separately and then arranged over each other to create the cumulative layout. Is never run if launchRemoveCycles is false and the graph contains cycles, because it does not terminate in this case. default: true
    
    Returns:
    
    boolean
  - getLaunchSeparateEdgeTypes
```
public boolean getLaunchSeparateEdgeTypes()
```
    If set to true, edge types will be separated and a layout generated that follows edge type priorities. There is no working implementation for this feature yet. default: false
    
    Returns:
    
    boolean
  - getLaunchJungLayout
```
public boolean getLaunchJungLayout()
```
    If set to true, the specified algorithm from the JUNG-library is applied to the graph. The algorithm is specified using setLayoutSelector(). default: true
    
    Returns:
    
    boolean
  - getLaunchRotate
```
public boolean getLaunchRotate()
```
    If set to true, the graph is rotated to reach an average flow direction that is the direction specified. default: true
    
    Returns:
    
    boolean
  - getLaunchOrigin
```
public boolean getLaunchOrigin()
```
    If set to true, nodes with an in-degree of 0 will be placed at the leftmost edge of the drawing space. Is always run if launchSeparateDisjunctGraphs is true, launchRemoveCycles is false and the graph contains cycles, because separateDisjunctGraphs does not terminate if the graph contains cycles. default: false
    
    Returns:
    
    boolean
  - getLaunchPushBack
```
public boolean getLaunchPushBack()
```
    If set to true, all nodes will be pushed past their predecessors, so no edges have a direction inverse to the specified direction. Is never run if launchRemoveCycles is false and the graph contains cycles, because it does not terminate in this case. default: true
    
    Returns:
    
    boolean
  - getLaunchDisplaceIdents
```
public boolean getLaunchDisplaceIdents()
```
    If set to true, nodes that are placed on the same coordinates will be displaced slightly, so the forcePush step can move them accordingly. default: true
    
    Returns:
    
    boolean
  - getLaunchForcePush
```
public boolean getLaunchForcePush()
```
    If set to true, all nodes will repel each other until no overlaps between nodes are left or the maximum amount of iterations has been reached. default: true
    
    Returns:
    
    boolean
  - getLaunchAlignNodes
```
public boolean getLaunchAlignNodes()
```
    If set to true, nodes will be aligned either with each other or on a global grid. default: true
    
    Returns:
    
    boolean
  - getMaxiterations
```
public int getMaxiterations()
```
    Returns the maximum amount of iterations used by the force push step of the algorithm. default: 500
    
    Returns:
    
    boolean
  - getScaling
```
public double getScaling()
```
    Returns the scaling parameter of the algorithm. Determines the distance between nodes. default: 1.2
    
    Returns:
    
    double
  - getSubflowscale
```
public double getSubflowscale()
```
    Returns the scaling factor that is used to scale subflow-nodes in the autoscaleNodes procedure. default: 2.0
    
    Returns:
    
    double
  - getDirection
```
public double getDirection()
```
    Returns the desired average edge direction of the resulting graph as an angle to the abscissa in degrees. default: 0.
    
    Returns:
    
    double
  - getAlignmentThreshold
```
public double getAlignmentThreshold()
```
    Sets the alignment parameter used to align nodes with each other. If the value is positive it describes the size of a grid which nodes will be aligned on. If the value is negative its absolute value will be used as multiplier to the mean size of each pair of nodes which will then result in a threshold under which these two nodes will be positioned at the same coordinate. default: -(scaling - 1)
    
    Returns:
    
    double
  - getDebug
```
public boolean getDebug()
```
    If set to true, debugging output will be printed in the command line. default: false
    
    Specified by:
    
    getDebug in interface LayoutGenerator
    
    Returns:
    
    boolean
  - setWorkflow
```
public void setWorkflow(VFlowModel pworkflow)
```
    Sets the workflow to be laid out.
    
    Specified by:
    
    setWorkflow in interface LayoutGenerator
    
    Parameters:
    
    pworkflow - VFlowModel
  - setModelGraph
```
public void setModelGraph(edu.uci.ics.jung.graph.DirectedGraph<VNode,Connection> pjgraph)
```
    Sets the model graph to be laid out. default: a graph is generated automatically from the workflow given.
    
    Parameters:
    
    pjgraph - DirectedGraph
  - setNodelist
```
public void setNodelist(Collection<VNode> pnodelist)
```
    Sets the list of nodes to be laid out. default: the nodelist is gathered from the given workflow.
    
    Parameters:
    
    pnodelist - Collection
  - setRecursive
```
public void setRecursive(boolean precursive)
```
    If set to true, the layout is applied to all subflows of the given workflow recursively. default: true
    
    Specified by:
    
    setRecursive in interface LayoutGenerator
    
    Parameters:
    
    precursive - boolean
  - setAutoscaleNodes
```
public void setAutoscaleNodes(boolean pautoscaleNodes)
```
    If set to true, subflow nodes in the given workflow are automatically scaled to fit their contents. Can only be run if graphmode is set to 0. default: true
    
    Specified by:
    
    setAutoscaleNodes in interface LayoutGenerator
    
    Parameters:
    
    pautoscaleNodes - boolean
  - setLayoutSelector
```
public void setLayoutSelector(int playoutSelector)
```
    Select the Jung layout that is supposed to be used in the first step of the algorithm. 0 - ISOM Layout 1 - FR Layout 2 - KK Layout 3 - DAG Layout (Does not terminate if the graph contains cycles) default: 0
    
    Parameters:
    
    playoutSelector - int
  - setAspectratio
```
public void setAspectratio(double paspectratio)
```
    Sets the aspect ratio of the initial drawing area of the graph. Width of the drawing space is determined via the longest path in the graph. Height is determined by dividing the width by the aspect ratio. default: 16:9
    
    Parameters:
    
    paspectratio - double
  - setGraphmode
```
public void setGraphmode(int pgraphmode)
```
    Sets the input type. 0 - VFlowModel (setWorkflow) 1 - jgraph (setModelGraph) 2 - nodelist (setNodelist) The input must be delivered via the corresponding setter method before the call of generateLayout(). default: 0
    
    Parameters:
    
    pgraphmode - int
  - setLaunchRemoveCycles
```
public void setLaunchRemoveCycles(boolean plaunchRemoveCycles)
```
    If set to true, a depth-first-search is performed and all back edges are removed from the model graph. The layout is then applied without these edges. Is only run if the graph contains cycles. default: true
    
    Parameters:
    
    plaunchRemoveCycles - boolean
  - setLaunchSeparateDisjunctGraphs
```
public void setLaunchSeparateDisjunctGraphs(boolean plaunchSeparateDisjunctGraphs)
```
    If set to true, disjunct parts of the model graph will be laid out separately and then arranged over each other to create the cumulative layout. Is never run if launchRemoveCycles is false and the graph contains cycles, because it does not terminate in this case. default: true
    
    Parameters:
    
    plaunchSeparateDisjunctGraphs - boolean
  - setLaunchSeparateEdgeTypes
```
public void setLaunchSeparateEdgeTypes(boolean plaunchSeparateEdgeTypes)
```
    If set to true, edge types will be separated and a layout generated that follows edge type priorities. There is no working implementation for this feature yet. default: false
    
    Parameters:
    
    plaunchSeparateEdgeTypes - boolean
  - setLaunchJungLayout
```
public void setLaunchJungLayout(boolean plaunchJungLayout)
```
    If set to true, the specified algorithm from the JUNG-library is applied to the graph. The algorithm is specified using setLayoutSelector(). default: true
    
    Parameters:
    
    plaunchJungLayout - boolean
  - setLaunchRotate
```
public void setLaunchRotate(boolean plaunchRotate)
```
    If set to true, the graph is rotated to reach an average flow direction that is the direction specified. default: true
    
    Parameters:
    
    plaunchRotate - boolean
  - setLaunchOrigin
```
public void setLaunchOrigin(boolean plaunchOrigin)
```
    If set to true, nodes with an in-degree of 0 will be placed at the leftmost edge of the drawing space. Is always run if launchSeparateDisjunctGraphs is true, launchRemoveCycles is false and the graph contains cycles, because separateDisjunctGraphs does not terminate if the graph contains cycles. default: false
    
    Parameters:
    
    plaunchOrigin - boolean
  - setLaunchPushBack
```
public void setLaunchPushBack(boolean plaunchPushBack)
```
    If set to true, all nodes will be pushed past their predecessors, so no edges have a direction inverse to the specified direction. (Does not terminate if the graph contains cycles) default: true
    
    Parameters:
    
    plaunchPushBack - boolean
  - setLaunchDisplaceIdents
```
public void setLaunchDisplaceIdents(boolean plaunchDisplaceIdents)
```
    If set to true, nodes that are placed on the same coordinates will be displaced slightly, so the forcePush step can move them accordingly. default: true
    
    Parameters:
    
    plaunchDisplaceIdents - boolean
  - setLaunchForcePush
```
public void setLaunchForcePush(boolean plaunchForcePush)
```
    If set to true, all nodes will repel each other until no overlaps between nodes are left or the maximum amount of iterations has been reached. default: true
    
    Parameters:
    
    plaunchForcePush - boolean
  - setLaunchAlignNodes
```
public void setLaunchAlignNodes(boolean plaunchAlignNodes)
```
    If set to true, nodes will be aligned either with each other or on a global grid. default: true
    
    Parameters:
    
    plaunchAlignNodes - boolean
  - setMaxiterations
```
public void setMaxiterations(int pmaxiterations)
```
    Sets the maximum amount of iterations for the force push step of the algorithm. default: 500
    
    Parameters:
    
    pmaxiterations - int
  - setScaling
```
public void setScaling(double pscaling)
```
    Sets the scaling parameter of the algorithm. Determines the distance between nodes. default: 1.2
    
    Parameters:
    
    pscaling - double
  - setSubflowscale
```
public void setSubflowscale(double psubflowscale)
```
    Sets the scaling factor that is used to scale subflow-nodes in the autoscaleNodes procedure. default: 2.0
    
    Parameters:
    
    psubflowscale - double
  - setDirection
```
public void setDirection(double pdirection)
```
    Sets the desired average edge direction as an angle to the abscissa in degrees. default: 0.
    
    Parameters:
    
    pdirection - double
  - setAlignmentThreshold
```
public void setAlignmentThreshold(double palignmentThreshold)
```
    Sets the alignment parameter used to align nodes with each other. If the value is positive it describes the size of a grid which nodes will be aligned on. If the value is negative its absolute value will be used as multiplier to the mean size of each pair of nodes which will then result in a threshold under which these two nodes will be positioned at the same coordinate. default: -(scaling - 1)
    
    Parameters:
    
    palignmentThreshold - double
  - setDebug
```
public void setDebug(boolean pdebug)
```
    If set to true, debugging output will be printed in the command line. default: false
    
    Specified by:
    
    setDebug in interface LayoutGenerator
    
    Parameters:
    
    pdebug - boolean
  - generateLayout
```
public void generateLayout()
```
    Applies all steps of the layout, whose launch-parameters are set to true.
    
    Specified by:
    
    generateLayout in interface LayoutGenerator

Class LayoutGeneratorSmart

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LayoutGeneratorSmart

LayoutGeneratorSmart

Method Detail

getWorkflow

getModelGraph

getNodelist

getRecursive

getAutoscaleNodes

getLayoutSelector

getAspectratio

getGraphmode

getLaunchRemoveCycles

getLaunchSeparateDisjunctGraphs

getLaunchSeparateEdgeTypes

getLaunchJungLayout

getLaunchRotate

getLaunchOrigin

getLaunchPushBack

getLaunchDisplaceIdents

getLaunchForcePush

getLaunchAlignNodes

getMaxiterations

getScaling

getSubflowscale

getDirection

getAlignmentThreshold

getDebug

setWorkflow

setModelGraph

setNodelist

setRecursive

setAutoscaleNodes

setLayoutSelector

setAspectratio

setGraphmode

setLaunchRemoveCycles

setLaunchSeparateDisjunctGraphs

setLaunchSeparateEdgeTypes

setLaunchJungLayout

setLaunchRotate

setLaunchOrigin

setLaunchPushBack

setLaunchDisplaceIdents

setLaunchForcePush

setLaunchAlignNodes

setMaxiterations

setScaling

setSubflowscale

setDirection

setAlignmentThreshold

setDebug

generateLayout