com.yworks.yfiles.layout.hierarchic

Class PortCandidateOptimizer

java.lang.Object

com.yworks.yfiles.layout.hierarchic.AbstractPortConstraintOptimizer

com.yworks.yfiles.layout.hierarchic.PortCandidateOptimizer

All Implemented Interfaces:

IPortConstraintOptimizer

public class PortCandidateOptimizer
extends AbstractPortConstraintOptimizer

This class is an implementation of the IPortConstraintOptimizer interface that tries to assign the edges of the graph to ports considering the specified PortCandidates.

Instances of this class can be set using property PortConstraintOptimizer.

This implementation will query for IDataProviders registered with the graph with keys PortCandidate.SOURCE_PORT_CANDIDATE_COLLECTION_DPKEY, PortCandidate.TARGET_PORT_CANDIDATE_COLLECTION_DPKEY and PortCandidateSet.NODE_PORT_CANDIDATE_SET_DPKEY. It will try to assign each edge one of the matching PortCandidates without introducing too many crossings and without violating the cost or capacity constraints.

See Also:

PortCandidate.getCost(), PortCandidateSet.getEntries(), PortCandidateSet.getConnectionCount()

Nested Class Summary

Nested classes/interfaces inherited from class com.yworks.yfiles.layout.hierarchic.AbstractPortConstraintOptimizer

AbstractPortConstraintOptimizer.SameLayerData

Constructor Summary

Constructors

Constructor and Description
PortCandidateOptimizer() Creates a new instance of PortCandidateOptimizer with the default settings.

Method Summary

Modifier and Type	Method and Description
double	getBackLoopPenalty() Gets the penalty cost associated with each back-loop.
double	getCrossingPenalty() Gets the penalty cost associated with a crossing that would occur if a given combination of PortCandidates would be chosen.
double	getOverUsagePenalty() Gets the penalty cost associated with each edge being assigned to a port which has already reached its capacity.
protected IDataProvider	getPortCandidateSetDataProvider(LayoutGraph graph) Returns the data provider that provides the port candidate sets for nodes.
protected AbstractPortConstraintOptimizer.SameLayerData	insertSameLayerStructures(LayoutGraph graph, ILayers layers, ILayoutDataProvider ldp, IItemFactory itemFactory) Inserts a same-layer edge structure for each same-layer edge of the original graph.
boolean	isDeterministicModeEnabled() Gets whether or not this implementation uses a deterministic algorithm to assign the PortCandidates.
void	optimizeAfterLayering(LayoutGraph graph, ILayers layers, ILayoutDataProvider ldp, IItemFactory itemFactory) Assigns new temporary port constraints after the nodes have been assigned to layers.
void	optimizeAfterSequencing(LayoutGraph graph, ILayers layers, ILayoutDataProvider ldp, IItemFactory itemFactory) Assigns new temporary port constraints after the order of the nodes in each layer has been determined.
protected void	optimizeAfterSequencing(Node node, Comparator<Object> inEdgeOrder, Comparator<Object> outEdgeOrder, LayoutGraph graph, ILayoutDataProvider ldp, IItemFactory itemFactory) Assigns new temporary port constraints to a given node of the graph after the order of the nodes in each layer has been determined.
void	setBackLoopPenalty(double value) Sets the penalty cost associated with each back-loop.
void	setCrossingPenalty(double value) Sets the penalty cost associated with a crossing that would occur if a given combination of PortCandidates would be chosen.
void	setDeterministicModeEnabled(boolean value) Sets whether or not this implementation uses a deterministic algorithm to assign the PortCandidates.
void	setOverUsagePenalty(double value) Sets the penalty cost associated with each edge being assigned to a port which has already reached its capacity.

Methods inherited from class com.yworks.yfiles.layout.hierarchic.AbstractPortConstraintOptimizer

getLayoutOrientation, getMirrorMode, optimizeAfterSequencing, removeSameLayerStructures, setLayoutOrientation, setMirrorMode

Methods inherited from class java.lang.Object

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

Constructor Detail

PortCandidateOptimizer

public PortCandidateOptimizer()

Creates a new instance of PortCandidateOptimizer with the default settings.

Method Detail

getBackLoopPenalty

public double getBackLoopPenalty()

Gets the penalty cost associated with each back-loop.

Values should be non-negative.

Throws:

IllegalArgumentException - if the penalty cost is negative

Default Value:

The default value is 1.0.

Returns:

the penalty for a back-loop

See Also:

setBackLoopPenalty(double)

getCrossingPenalty

public double getCrossingPenalty()

Gets the penalty cost associated with a crossing that would occur if a given combination of PortCandidates would be chosen.

Values should be non-negative.

Throws:

IllegalArgumentException - if the crossing penalty is negative

Default Value:

The default value is 10.0d.

Returns:

the penalty for a produced edge ctossing

See Also:

setCrossingPenalty(double)

getOverUsagePenalty

public double getOverUsagePenalty()

Gets the penalty cost associated with each edge being assigned to a port which has already reached its capacity.

Values should be non-negative.

Throws:

IllegalArgumentException - if the penalty cost is negative

Default Value:

The default value is 100.0d.

Returns:

the penalty for over-saturated PortCandidates

See Also:

PortCandidateSet.IEntry#getConnections(), setOverUsagePenalty(double)

getPortCandidateSetDataProvider

protected IDataProvider getPortCandidateSetDataProvider(LayoutGraph graph)

Returns the data provider that provides the port candidate sets for nodes.

Parameters:

graph - The graph that stores the data provider

insertSameLayerStructures

protected AbstractPortConstraintOptimizer.SameLayerData insertSameLayerStructures(LayoutGraph graph,
                                                                                  ILayers layers,
                                                                                  ILayoutDataProvider ldp,
                                                                                  IItemFactory itemFactory)

Description copied from class: AbstractPortConstraintOptimizer

Inserts a same-layer edge structure for each same-layer edge of the original graph.

Overrides:

insertSameLayerStructures in class AbstractPortConstraintOptimizer

Parameters:

graph - the input graph

layers - the given ILayers instance holding the layering information

ldp - the ILayoutDataProvider implementation which provides access to the INodeData and IEdgeData instances

itemFactory - the factory that sets the temporary port constraints

See Also:

IItemFactory.setTemporaryPortConstraint(Edge, boolean, com.yworks.yfiles.layout.PortConstraint)

isDeterministicModeEnabled

public boolean isDeterministicModeEnabled()

Gets whether or not this implementation uses a deterministic algorithm to assign the PortCandidates.

Default Value:

The default value is true. A deterministic algorithm will be applied.

Returns:

true if a deterministic algorithm should be applied, false otherwise

See Also:

setDeterministicModeEnabled(boolean)

optimizeAfterLayering

public void optimizeAfterLayering(LayoutGraph graph,
                                  ILayers layers,
                                  ILayoutDataProvider ldp,
                                  IItemFactory itemFactory)

Description copied from class: AbstractPortConstraintOptimizer

Assigns new temporary port constraints after the nodes have been assigned to layers.

More precisely, it is called after the layering information has been determined. In this phase, it is possible to create back-loops by assigning incoming edges to the south (i.e. bottom) side or outgoing edges to the north (i.e. top) side, respectively.

Specified by:

optimizeAfterLayering in interface IPortConstraintOptimizer

Specified by:

optimizeAfterLayering in class AbstractPortConstraintOptimizer

Parameters:

graph - the input graph

layers - the given ILayers instance holding the layering information

ldp - the ILayoutDataProvider implementation which provides access to the INodeData and IEdgeData instances

itemFactory - the factory that sets the temporary port constraints

See Also:

IItemFactory.setTemporaryPortConstraint(Edge, boolean, com.yworks.yfiles.layout.PortConstraint)

optimizeAfterSequencing

public void optimizeAfterSequencing(LayoutGraph graph,
                                    ILayers layers,
                                    ILayoutDataProvider ldp,
                                    IItemFactory itemFactory)

Description copied from class: AbstractPortConstraintOptimizer

Assigns new temporary port constraints after the order of the nodes in each layer has been determined.

More precisely, it is called after the sequence of the nodes has been determined. It inserts the same-layer structures, invokes the hook in which the custom port assignment should be done, and finally restores the original state of the layout graph by removing the temporary edges.

Specified by:

optimizeAfterSequencing in interface IPortConstraintOptimizer

Overrides:

optimizeAfterSequencing in class AbstractPortConstraintOptimizer

Parameters:

graph - the input graph

layers - the given ILayers instance holding the layering information

ldp - the ILayoutDataProvider implementation which provides access to the INodeData and IEdgeData instances

itemFactory - the factory that sets the temporary port constraints

See Also:

AbstractPortConstraintOptimizer.insertSameLayerStructures(LayoutGraph, ILayers, ILayoutDataProvider, IItemFactory), AbstractPortConstraintOptimizer.optimizeAfterSequencing(LayoutGraph, ILayers, ILayoutDataProvider, IItemFactory), AbstractPortConstraintOptimizer.removeSameLayerStructures(SameLayerData, LayoutGraph, ILayoutDataProvider, IItemFactory)

optimizeAfterSequencing

protected void optimizeAfterSequencing(Node node,
                                       Comparator<Object> inEdgeOrder,
                                       Comparator<Object> outEdgeOrder,
                                       LayoutGraph graph,
                                       ILayoutDataProvider ldp,
                                       IItemFactory itemFactory)

Description copied from class: AbstractPortConstraintOptimizer

Assigns new temporary port constraints to a given node of the graph after the order of the nodes in each layer has been determined.

More precisely, it is called after the sequence of the nodes has been determined.

Incoming and outgoing edges are sorted using Comparator instances which define the preferred ordering of the incoming and outgoing edges from left to right.

Specified by:

optimizeAfterSequencing in class AbstractPortConstraintOptimizer

Parameters:

node - the original node to set temporary port constraints

inEdgeOrder - a given Comparator instance for incoming edges

outEdgeOrder - a given Comparator instance for outgoing edges

graph - the input graph

ldp - the ILayoutDataProvider implementation which provides access to the INodeData and IEdgeData instances

itemFactory - the factory that sets the temporary port constraints

See Also:

AbstractPortConstraintOptimizer.optimizeAfterSequencing(LayoutGraph, ILayers, ILayoutDataProvider, IItemFactory)

setBackLoopPenalty

public void setBackLoopPenalty(double value)

Sets the penalty cost associated with each back-loop.

Values should be non-negative.

Throws:

IllegalArgumentException - if the penalty cost is negative

Default Value:

The default value is 1.0.

Parameters:

value - the penalty for a back-loop

See Also:

getBackLoopPenalty()

setCrossingPenalty

public void setCrossingPenalty(double value)

Sets the penalty cost associated with a crossing that would occur if a given combination of PortCandidates would be chosen.

Values should be non-negative.

Throws:

IllegalArgumentException - if the crossing penalty is negative

Default Value:

The default value is 10.0d.

Parameters:

value - the penalty for a produced edge ctossing

See Also:

getCrossingPenalty()

setDeterministicModeEnabled

public void setDeterministicModeEnabled(boolean value)

Sets whether or not this implementation uses a deterministic algorithm to assign the PortCandidates.

Default Value:

The default value is true. A deterministic algorithm will be applied.

Parameters:

value - true if a deterministic algorithm should be applied, false otherwise

See Also:

isDeterministicModeEnabled()

setOverUsagePenalty

public void setOverUsagePenalty(double value)

Sets the penalty cost associated with each edge being assigned to a port which has already reached its capacity.

Values should be non-negative.

Throws:

IllegalArgumentException - if the penalty cost is negative

Default Value:

The default value is 100.0d.

Parameters:

value - the penalty for over-saturated PortCandidates

See Also:

PortCandidateSet.IEntry#getConnections(), getOverUsagePenalty()