com.yworks.yfiles.layout.seriesparallel

Class DefaultOutEdgeComparator

java.lang.Object

com.yworks.yfiles.layout.seriesparallel.DefaultOutEdgeComparator

All Implemented Interfaces:

Comparator<Object>

public class DefaultOutEdgeComparator
extends Object
implements Comparator<Object>

DefaultOutEdgeComparator is the default implementation for the out-edge comparator used in SeriesParallelLayout.

It keeps the order of the edges in the graph for edges without PortConstraints and considers the PortConstraints such that the order of the target nodes of the outgoing edges is similar to the port location at the source node. Note that this won't work for all cases because the target nodes may not be completely independent.

See Also:

SeriesParallelLayout.getDefaultOutEdgeComparator()

Constructor Summary

Constructors

Constructor and Description
DefaultOutEdgeComparator() Creates a DefaultOutEdgeComparator instance with default settings.

Method Summary

Modifier and Type	Method and Description
int	compare(Object o1, Object o2) Compares the two given edges considering their PortConstraints.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

DefaultOutEdgeComparator

public DefaultOutEdgeComparator()

Creates a DefaultOutEdgeComparator instance with default settings.

Method Detail

compare

public int compare(Object o1,
                   Object o2)

Compares the two given edges considering their PortConstraints.

The order of edges is kept unless there are PortConstraints assigned. Then the edges will be sorted to avoid edge crossings.

Specified by:

compare in interface Comparator<Object>

Parameters:

o1 - the first edge

o2 - the second edge

Returns:

the order of the given two edges