ilog.views.sdm.renderer.graphlayout

Class IlvSDMObjectComparator.ComparatorSortCriteria

java.lang.Object

ilog.views.sdm.renderer.graphlayout.IlvSDMObjectComparator.SortCriteria

ilog.views.sdm.renderer.graphlayout.IlvSDMObjectComparator.ComparatorSortCriteria

All Implemented Interfaces:

Comparator<Object>

Enclosing class:

IlvSDMObjectComparator

public static class IlvSDMObjectComparator.ComparatorSortCriteria
extends IlvSDMObjectComparator.SortCriteria

ComparatorSortCriteria defines a sort criteria by using an implementation of java.util.Comparator.

Since:

JViews 8.8

Constructor Summary

Constructors

Constructor and Description
ComparatorSortCriteria(Comparator<Object> comparator) Creates a new comparator sort criteria that relies on the given comparator.
ComparatorSortCriteria(String description) Creates a new comparator sort criteria from a text description.

Method Summary

Modifier and Type	Method and Description
int	compare(Object gobj1, Object gobj2) Compares two graphic objects using the comparator.
Comparator<Object>	getComparator() Returns the comparator used to perform the comparison.
String	getTextualDescription() Returns the text description of this sort criteria.
void	setComparator(Comparator<Object> comparator) Sets the comparator used to perform the comparison.

Methods inherited from class ilog.views.sdm.renderer.graphlayout.IlvSDMObjectComparator.SortCriteria

createFromTextualDescription

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

ComparatorSortCriteria

public ComparatorSortCriteria(Comparator<Object> comparator)

Creates a new comparator sort criteria that relies on the given comparator.

Parameters:

comparator - The comparator used to test values.

ComparatorSortCriteria

public ComparatorSortCriteria(String description)

Creates a new comparator sort criteria from a text description. The possible descriptions are:

• comparator,ASCENDING_WIDTH,
• comparator,DESCENDING_WIDTH,
• comparator,ASCENDING_HEIGHT,
• comparator,DESCENDING_HEIGHT,
• comparator,ASCENDING_AREA,
• comparator,DESCENDING_AREA.
• comparator,classname - the second part of the description must be a fully qualified class name of a comparator class that has a default constructor.

Parameters:

description - The text description of the comparator.

See Also:

getTextualDescription()

Method Detail

setComparator

public final void setComparator(Comparator<Object> comparator)

Sets the comparator used to perform the comparison.

Parameters:

comparator - The comparator.

getComparator

public final Comparator<Object> getComparator()

Returns the comparator used to perform the comparison.

Returns:

The comparator.

getTextualDescription

public final String getTextualDescription()

Returns the text description of this sort criteria. The description format must match the rules defined by IlvSDMObjectComparator.setTextualSortCriteria(java.lang.String).

Specified by:

getTextualDescription in class IlvSDMObjectComparator.SortCriteria

Returns:

The text description of this sort criteria.

compare

public int compare(Object gobj1,
                   Object gobj2)

Compares two graphic objects using the comparator.

Specified by:

compare in interface Comparator<Object>

Specified by:

compare in class IlvSDMObjectComparator.SortCriteria

Parameters:

gobj1 - One graphic object.

gobj2 - Another graphic object.

Returns:

An integer value according to the conventions of java.util.Comparator. The comparison takes into account the sort order as indicated by getComparator().

See Also:

getComparator()