LayoutGeneratorNaive (vworkflows-core 0.2.4.3)

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

All Implemented Interfaces:

LayoutGenerator
```
public class LayoutGeneratorNaive
extends Object
implements LayoutGenerator
```
This class provides a naive implementation for the LayoutGenerator interface. Nodes will be positioned in a layered arrangement, but there is no process for the minimization of line-crossings.

Author:

Tobias Mertz

Constructor Summary

Constructors
Constructor and Description

LayoutGeneratorNaive()
Default constructor.

LayoutGeneratorNaive(boolean pdebug)
Constructor with debug-functionality.

Constructors
Constructor and Description
`LayoutGeneratorNaive()` Default constructor.
`LayoutGeneratorNaive(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.
`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.
`int`	`getGraphmode()` Returns the set input type.
`boolean`	`getLaunchCalculateHorizontalPositions()` If set to true, the horizontal position for each layer is calculated and changed.
`boolean`	`getLaunchCalculateVerticalPositions()` If set to true, the vertical position for each node is calculated and changed.
`boolean`	`getLaunchCreateLayering()` If set to true, a new layering for the given graph is created.
`boolean`	`getLaunchRemoveCycles()` If set to true, a depth-first-search is performed and all back edges are removed from the model graph.
`int[]`	`getLayering()` Returns the layering of the current graph as an array of layer indices.
`LinkedList<edu.uci.ics.jung.graph.util.Pair<Integer>>`	`getModelGraph()` Returns the Graph modeled after the workflow.
`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`	`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`	`setGraphmode(int pgraphmode)` Sets the input type.
`void`	`setLaunchCalculateHorizontalPositions(boolean plaunchCalculateHorizontalPositions)` If set to true, the horizontal position for each layer is calculated and changed.
`void`	`setLaunchCalculateVerticalPositions(boolean plaunchCalculateVerticalPositions)` If set to true, the vertical position for each node is calculated and changed.
`void`	`setLaunchCreateLayering(boolean plaunchCreateLayering)` If set to true, a new layering for the given graph is created.
`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`	`setLayering(int[] playering)` Sets the layering of the current graph as an array of layer indices.
`void`	`setModelGraph(LinkedList<edu.uci.ics.jung.graph.util.Pair<Integer>> pconnectionList)` Sets the model graph.
`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.
`boolean`	`setUp()` Sets up the model-fields.
`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
  - LayoutGeneratorNaive
```
public LayoutGeneratorNaive()
```
    Default constructor. Debug is set to false.
  - LayoutGeneratorNaive
```
public LayoutGeneratorNaive(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
  - 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
  - getGraphmode
```
public int getGraphmode()
```
    Returns the set input type. 0 - VFlowModel (setWorkflow) 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
  - getLaunchCreateLayering
```
public boolean getLaunchCreateLayering()
```
    If set to true, a new layering for the given graph is created. default: true
    
    Returns:
    
    boolean
  - getLaunchCalculateVerticalPositions
```
public boolean getLaunchCalculateVerticalPositions()
```
    If set to true, the vertical position for each node is calculated and changed. Does not change the order of nodes on each layer. default: true
    
    Returns:
    
    boolean
  - getLaunchCalculateHorizontalPositions
```
public boolean getLaunchCalculateHorizontalPositions()
```
    If set to true, the horizontal position for each layer is calculated and changed. default: true
    
    Returns:
    
    boolean
  - getScaling
```
public double getScaling()
```
    Returns the scaling parameter of the algorithm. Determines the distance between nodes. default: -1.5
    
    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
  - 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
  - getModelGraph
```
public LinkedList<edu.uci.ics.jung.graph.util.Pair<Integer>> getModelGraph()
```
    Returns the Graph modeled after the workflow.
    
    Returns:
    
    LinkedList>
  - getLayering
```
public int[] getLayering()
```
    Returns the layering of the current graph as an array of layer indices.
    
    Returns:
    
    int[]
  - setWorkflow
```
public void setWorkflow(VFlowModel pworkflow)
```
    Sets the workflow to be laid out.
    
    Specified by:
    
    setWorkflow in interface LayoutGenerator
    
    Parameters:
    
    pworkflow - VFlowModel
  - 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. default: true
    
    Specified by:
    
    setAutoscaleNodes in interface LayoutGenerator
    
    Parameters:
    
    pautoscaleNodes - boolean
  - setGraphmode
```
public void setGraphmode(int pgraphmode)
```
    Sets the input type. 0 - VFlowModel (setWorkflow) 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
  - setLaunchCreateLayering
```
public void setLaunchCreateLayering(boolean plaunchCreateLayering)
```
    If set to true, a new layering for the given graph is created. default: true
    
    Parameters:
    
    plaunchCreateLayering - boolean
  - setLaunchCalculateVerticalPositions
```
public void setLaunchCalculateVerticalPositions(boolean plaunchCalculateVerticalPositions)
```
    If set to true, the vertical position for each node is calculated and changed. Does not change the order of nodes on each layer. default: true
    
    Parameters:
    
    plaunchCalculateVerticalPositions - boolean
  - setLaunchCalculateHorizontalPositions
```
public void setLaunchCalculateHorizontalPositions(boolean plaunchCalculateHorizontalPositions)
```
    If set to true, the horizontal position for each layer is calculated and changed. default: true
    
    Parameters:
    
    plaunchCalculateHorizontalPositions - boolean
  - setScaling
```
public void setScaling(double pscaling)
```
    Sets the scaling parameter of the algorithm. Determines the distance between nodes. default: -1.5
    
    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
  - 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
  - setModelGraph
```
public void setModelGraph(LinkedList<edu.uci.ics.jung.graph.util.Pair<Integer>> pconnectionList)
```
    Sets the model graph.
    
    Parameters:
    
    pconnectionList - LinkedList>
  - setLayering
```
public void setLayering(int[] playering)
```
    Sets the layering of the current graph as an array of layer indices.
    
    Parameters:
    
    playering - int[]
  - setUp
```
public boolean setUp()
```
    Sets up the model-fields. This includes nodearray, nodecount and the model graph. Uses either a VFlowModel or a nodelist depending on the graphmode parameter.
    
    Returns:
    
    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 LayoutGeneratorNaive

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LayoutGeneratorNaive

LayoutGeneratorNaive

Method Detail

getWorkflow

getNodelist

getRecursive

getAutoscaleNodes

getGraphmode

getLaunchRemoveCycles

getLaunchCreateLayering

getLaunchCalculateVerticalPositions

getLaunchCalculateHorizontalPositions

getScaling

getSubflowscale

getDebug

getModelGraph

getLayering

setWorkflow

setNodelist

setRecursive

setAutoscaleNodes

setGraphmode

setLaunchRemoveCycles

setLaunchCreateLayering

setLaunchCalculateVerticalPositions

setLaunchCalculateHorizontalPositions

setScaling

setSubflowscale

setDebug

setModelGraph

setLayering

setUp

generateLayout