y.module
Class ChannelEdgeRouterModule

java.lang.Object
  y.module.YModule
      y.module.LayoutModule
          y.module.ChannelEdgeRouterModule

public class ChannelEdgeRouterModule
extends LayoutModule

This module represents an interactive configurator and launcher for ChannelEdgeRouter.

See Also:

Section Channel Edge Routing in the yFiles for Java Developer's Guide

Field Summary

protected static java.lang.String	ITEM_ACTIVATE_GRID_ROUTING
protected static java.lang.String	ITEM_BEND_COST
protected static java.lang.String	ITEM_EDGE_CROSSING_COST
protected static java.lang.String	ITEM_GRID_SPACING
protected static java.lang.String	ITEM_MINIMUM_DISTANCE
protected static java.lang.String	ITEM_NODE_CROSSING_COST
protected static java.lang.String	ITEM_PATHFINDER
protected static java.lang.String	ITEM_POLICY
protected static java.lang.String	ITEM_SCOPE
protected static java.lang.String	MODULE_CHANNEL_EDGE_ROUTER
protected static java.lang.String	TITLE_COST
protected static java.lang.String	TITLE_LAYOUT_OPTIONS
protected static java.lang.String	VALUE_ORTHOGONAL_PATTERN_PATH_FINDER
protected static java.lang.String	VALUE_ORTHOGONAL_SHORTESTPATH_PATH_FINDER
protected static java.lang.String	VALUE_POLICY_ALWAYS
protected static java.lang.String	VALUE_POLICY_PATH_AS_NEEDED
protected static java.lang.String	VALUE_SCOPE_ALL_EDGES
protected static java.lang.String	VALUE_SCOPE_AT_SELECTED_NODES
protected static java.lang.String	VALUE_SCOPE_SELECTED_EDGES

Fields inherited from class y.module.YModule

FAILED, moduleListenerSupport, PRECONDITION_VIOLATED, SUCCESS

Constructor Summary

ChannelEdgeRouterModule()
Creates an instance of this module.

Method Summary

protected void	configure(ChannelEdgeRouter channel, OptionHandler options) Configures the module's layout algorithm according to the given options.
protected OptionHandler	createOptionHandler() Creates an OptionHandler and adds the option items used by this module.
protected void	mainrun() Main module execution routine.
protected void	prepareGraph(Graph2D graph, OptionHandler options) Prepares a graph depending on the given options for the module's layout algorithm.
protected void	restoreGraph(Graph2D graph, OptionHandler options) Restores the given graph by freeing up resources created by prepareGraph(y.view.Graph2D, y.option.OptionHandler).

Methods inherited from class y.module.LayoutModule

backupDataProvider, createAnimationPlayer, createLayoutExecutor, createLayoutMorpher, getBufferedMode, getLayoutExecutor, isAbortable, isMorphingEnabled, isPortIntersectionCalculatorEnabled, launchLayouter, launchLayouter, restoreDataProvider, setBufferedMode, setLayoutExecutor, setMorphingEnabled, setPortIntersectionCalculatorEnabled, useEventDispatchThread

Methods inherited from class y.module.YModule

addModuleListener, createThread, dispose, exceptionHappened, fitGraph2DView, getAuthor, getDescription, getExitStatus, getGraph2D, getGraph2DView, getModuleListeners, getModuleName, getOptionHandler, getTimer, getView, init, initGuiFactory, isBackupRealizersEnabled, removeModuleListener, run, setBackupRealizersEnabled, setExitStatus, setGraph2D, setModuleName, setOptionHandler, start, startAsThread

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MODULE_CHANNEL_EDGE_ROUTER

protected static final java.lang.String MODULE_CHANNEL_EDGE_ROUTER

See Also:

Constant Field Values

TITLE_LAYOUT_OPTIONS

protected static final java.lang.String TITLE_LAYOUT_OPTIONS

See Also:

Constant Field Values

ITEM_PATHFINDER

protected static final java.lang.String ITEM_PATHFINDER

See Also:

Constant Field Values

VALUE_ORTHOGONAL_PATTERN_PATH_FINDER

protected static final java.lang.String VALUE_ORTHOGONAL_PATTERN_PATH_FINDER

See Also:

Constant Field Values

VALUE_ORTHOGONAL_SHORTESTPATH_PATH_FINDER

protected static final java.lang.String VALUE_ORTHOGONAL_SHORTESTPATH_PATH_FINDER

See Also:

Constant Field Values

ITEM_SCOPE

protected static final java.lang.String ITEM_SCOPE

See Also:

Constant Field Values

VALUE_SCOPE_ALL_EDGES

protected static final java.lang.String VALUE_SCOPE_ALL_EDGES

See Also:

Constant Field Values

VALUE_SCOPE_SELECTED_EDGES

protected static final java.lang.String VALUE_SCOPE_SELECTED_EDGES

See Also:

Constant Field Values

VALUE_SCOPE_AT_SELECTED_NODES

protected static final java.lang.String VALUE_SCOPE_AT_SELECTED_NODES

See Also:

Constant Field Values

ITEM_POLICY

protected static final java.lang.String ITEM_POLICY

See Also:

Constant Field Values

VALUE_POLICY_ALWAYS

protected static final java.lang.String VALUE_POLICY_ALWAYS

See Also:

Constant Field Values

VALUE_POLICY_PATH_AS_NEEDED

protected static final java.lang.String VALUE_POLICY_PATH_AS_NEEDED

See Also:

Constant Field Values

ITEM_MINIMUM_DISTANCE

protected static final java.lang.String ITEM_MINIMUM_DISTANCE

See Also:

Constant Field Values

ITEM_ACTIVATE_GRID_ROUTING

protected static final java.lang.String ITEM_ACTIVATE_GRID_ROUTING

See Also:

Constant Field Values

ITEM_GRID_SPACING

protected static final java.lang.String ITEM_GRID_SPACING

See Also:

Constant Field Values

TITLE_COST

protected static final java.lang.String TITLE_COST

See Also:

Constant Field Values

ITEM_BEND_COST

protected static final java.lang.String ITEM_BEND_COST

See Also:

Constant Field Values

ITEM_EDGE_CROSSING_COST

protected static final java.lang.String ITEM_EDGE_CROSSING_COST

See Also:

Constant Field Values

ITEM_NODE_CROSSING_COST

protected static final java.lang.String ITEM_NODE_CROSSING_COST

See Also:

Constant Field Values

Constructor Detail

ChannelEdgeRouterModule

public ChannelEdgeRouterModule()

Creates an instance of this module.

Method Detail

createOptionHandler

protected OptionHandler createOptionHandler()

Creates an OptionHandler and adds the option items used by this module.

Overrides:

createOptionHandler in class YModule

Returns:

the created OptionHandler providing module related options

mainrun

protected void mainrun()

Main module execution routine. Launches the module's underlying algorithm on the module's graph based on user options.

Specified by:

mainrun in class YModule

prepareGraph

protected void prepareGraph(Graph2D graph,
                            OptionHandler options)

Prepares a graph depending on the given options for the module's layout algorithm.
Additional resources created by this method have to be freed up by calling restoreGraph(y.view.Graph2D, y.option.OptionHandler) after layout calculation.

Parameters:

graph - the graph to be prepared

options - the options for the module's layout algorithm

restoreGraph

protected void restoreGraph(Graph2D graph,
                            OptionHandler options)

Restores the given graph by freeing up resources created by prepareGraph(y.view.Graph2D, y.option.OptionHandler).

Parameters:

graph - the graph for which prepareGraph has been called

options - the options for the module's layout algorithm

configure

protected void configure(ChannelEdgeRouter channel,
                         OptionHandler options)

Configures the module's layout algorithm according to the given options.

Parameters:

channel - the ChannelEdgeRouter to be configured

options - the layout options to set