com.yworks.yfiles.layout.tree

Class NodeOrderComparator

java.lang.Object

com.yworks.yfiles.layout.tree.NodeOrderComparator

All Implemented Interfaces:

com.yworks.yfiles.algorithms.Comparators.IPartialOrder, Comparator<Object>

public class NodeOrderComparator
extends Object
implements Comparator<Object>, com.yworks.yfiles.algorithms.Comparators.IPartialOrder

The NodeOrderComparator compares edges according to a specified order.

It obtains the order from a IDataProvider registered with the graph with key NODE_ORDER_COMPARABLE_DPKEY.

Various tree layout algorithms can use this Comparator to influence the resulting layout. To achieve this, use this comparator and assign it to the comparator property of the layout algorithm classes.

See Also:

ClassicTreeLayout.setComparator(Comparator), TreeLayout.setDefaultOutEdgeComparator(Comparator), TreeLayout.OUT_EDGE_COMPARATOR_DPKEY, BalloonLayout.setComparator(Comparator), AspectRatioTreeLayout.setComparator(Comparator), NODE_ORDER_COMPARABLE_DPKEY

Field Summary

Fields

Modifier and Type	Field and Description
static NodeDpKey<Comparable>	NODE_ORDER_COMPARABLE_DPKEY A DataProvider key for registering an order for each node in the graph

Constructor Summary

Constructors

Constructor and Description
NodeOrderComparator() Creates a new NodeOrderComparator instance.

Method Summary

Modifier and Type	Method and Description
int	compare(Object edge1, Object edge2) Compares two edges according to their index in the order specified using a IDataProvider.

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

Field Detail

NODE_ORDER_COMPARABLE_DPKEY

public static final NodeDpKey<Comparable> NODE_ORDER_COMPARABLE_DPKEY

A DataProvider key for registering an order for each node in the graph

Constructor Detail

NodeOrderComparator

public NodeOrderComparator()

Creates a new NodeOrderComparator instance.

Method Detail

compare

public int compare(Object edge1,
                   Object edge2)

Compares two edges according to their index in the order specified using a IDataProvider.

Target nodes for which the IDataProvider registered with NODE_ORDER_COMPARABLE_DPKEY returns null or an Object that does not implement Comparable are treated as being smaller than other target nodes.

Specified by:

compare in interface Comparator<Object>

Parameters:

edge1 - the first edge

edge2 - the second edge

See Also:

NODE_ORDER_COMPARABLE_DPKEY