ilog.views.sdm.renderer.graphlayout

Class IlvSDMObjectComparator.SortCriteria

java.lang.Object

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

All Implemented Interfaces:

Comparator<Object>

Direct Known Subclasses:

IlvSDMObjectComparator.ComparatorSortCriteria, IlvSDMObjectComparator.DataModelAttributeSortCriteria, IlvSDMObjectComparator.ModelOrderSortCriteria

Enclosing class:

IlvSDMObjectComparator

public abstract static class IlvSDMObjectComparator.SortCriteria
extends Object
implements Comparator<Object>

SortCriteria is the base class for specifying a sort criteria. Sort criteria are intended for use with the IlvSDMObjectComparator only.

Note: you must use one of the following subclasses: IlvSDMObjectComparator.DataModelAttributeSortCriteria, IlvSDMObjectComparator.ComparatorSortCriteria or IlvSDMObjectComparator.ModelOrderSortCriteria. You should not create a new direct subclass of this abstract class.

Subclassing this abstract class is not supported. This is to keep the text description of the sort criteria as simple as possible.

Since:

JViews 8.8

See Also:

IlvSDMObjectComparator.setSortCriteria(ilog.views.sdm.renderer.graphlayout.IlvSDMObjectComparator.SortCriteria[])

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract int	compare(Object obj1, Object obj2) Compares two objects according to their sort criteria.
static IlvSDMObjectComparator.SortCriteria	createFromTextualDescription(String description) Returns a new instance of a sort criteria from the provided text description.
abstract String	getTextualDescription() Returns the text description of the sort criteria.

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

SortCriteria

public SortCriteria()

Creates a new SortCriteria instance.

Method Detail

compare

public abstract int compare(Object obj1,
                            Object obj2)

Compares two objects according to their sort criteria.

Specified by:

compare in interface Comparator<Object>

Parameters:

obj1 - One object.

obj2 - Another object.

Returns:

An integer value using the conventions of java.util.Comparator.

getTextualDescription

public abstract String getTextualDescription()

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

Returns:

The text description of the sort criteria.

createFromTextualDescription

public static IlvSDMObjectComparator.SortCriteria createFromTextualDescription(String description)

Returns a new instance of a sort criteria from the provided text description.

Parameters:

description - This parameter must match the format defined by one of the sort criteria concrete classes. It must also be consistent with the format used by getTextualDescription().

Returns:

If description is empty, null is returned.