ilog.views.sdm.renderer.graphlayout

Class IlvSDMObjectComparator

java.lang.Object

ilog.views.sdm.renderer.graphlayout.IlvSDMObjectComparator

All Implemented Interfaces:

IlvPersistentObject, Serializable, Comparator<Object>

public class IlvSDMObjectComparator
extends Object
implements Comparator<Object>, IlvPersistentObject, Serializable

IlvSDMObjectComparator allows you to define one or more ordering criteria for the nodes and links of a graph. The ordering criteria can be the order of objects in the SDM model, the values of data model attributes, or be implemented as java.util.Comparator objects.

This class is an implementation of the java.util.Comparator interface.

Since:

JViews 8.8

See Also:

IlvBusLayout.setNodeComparator(java.util.Comparator), IlvGridLayout.setNodeComparator(java.util.Comparator), IlvGraphLayoutRenderer.setNodeOrderingComparator(java.util.Comparator<java.lang.Object>), IlvGraphLayoutRenderer.setLinkOrderingComparator(java.util.Comparator<java.lang.Object>), Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlvSDMObjectComparator.ComparatorSortCriteria ComparatorSortCriteria defines a sort criteria by using an implementation of java.util.Comparator.
static class	IlvSDMObjectComparator.DataModelAttributeSortCriteria DataModelAttributeSortCriteria defines a sort criteria that allows you to specify the order using data model attributes of the objects.
static class	IlvSDMObjectComparator.ModelOrderSortCriteria ModelOrderSortCriteria defines a sort criteria to order the objects as in the SDM model.
static class	IlvSDMObjectComparator.SortCriteria SortCriteria is the base class for specifying a sort criteria.

Constructor Summary

Constructors

Constructor and Description
IlvSDMObjectComparator() Creates a new empty IlvSDMObjectComparator instance.
IlvSDMObjectComparator(IlvInputStream stream) Reads the object from an IlvInputStream.
IlvSDMObjectComparator(IlvSDMObjectComparator.SortCriteria[] sortCriteria) Creates a new IlvSDMObjectComparator with a given list of sort criteria.
IlvSDMObjectComparator(String textualDescription) Creates a new IlvSDMObjectComparator from a given text description.

Method Summary

Modifier and Type	Method and Description
int	compare(Object obj1, Object obj2) Compares two objects for order.
IlvSDMObjectComparator.SortCriteria[]	getSortCriteria() Returns the sort criteria.
String	getTextualSortCriteria() Returns the text description sort criteria.
void	setSortCriteria(IlvSDMObjectComparator.SortCriteria[] sortCriteria) Sets the sort criteria.
void	setTextualSortCriteria(String textualSortCriteria) Sets the sort criteria using a text description.
void	write(IlvOutputStream stream) Writes this comparator to the output stream.

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

IlvSDMObjectComparator

public IlvSDMObjectComparator()

Creates a new empty IlvSDMObjectComparator instance.

See Also:

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

IlvSDMObjectComparator

public IlvSDMObjectComparator(IlvSDMObjectComparator.SortCriteria[] sortCriteria)

Creates a new IlvSDMObjectComparator with a given list of sort criteria.

Parameters:

sortCriteria - The sort criteria to be used by this IlvSDMObjectComparator instance.

See Also:

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

IlvSDMObjectComparator

public IlvSDMObjectComparator(String textualDescription)

Creates a new IlvSDMObjectComparator from a given text description.

The textualDescription parameter must use a format similar to the following example:

data,name,ascending;data,value,descending;comparator,DESCENDING_HEIGHT;

which means:

• The primary sort criteria is the the "name" data model attribute in ascending order.
• The secondary sort criteria is the "value" data model attribute in descending order.
• The ternary sort criteria is the natural order defined by the DESCENDING_HEIGHT predefined comparator.

The textual description model,ascending describes the order of objects in the SDM model.

Parameters:

textualDescription - The description used to create a new IlvSDMObjectComparator instance.

See Also:

setTextualSortCriteria(java.lang.String), IlvSDMObjectComparator.DataModelAttributeSortCriteria, IlvSDMObjectComparator.ComparatorSortCriteria, IlvSDMObjectComparator.ModelOrderSortCriteria

IlvSDMObjectComparator

public IlvSDMObjectComparator(IlvInputStream stream)

Reads the object from an IlvInputStream.

Parameters:

stream - The IlvInputStream to read from.

Method Detail

setSortCriteria

public void setSortCriteria(IlvSDMObjectComparator.SortCriteria[] sortCriteria)

Sets the sort criteria. The sortCriteria list can contain either:

• Data model attribute names provided as Strings.
• Instances of java.util.Comparator. For example, the comparators defined by the Bus or Grid layout.
• The order of objects in the SDM model.

See Also:

getSortCriteria()

getSortCriteria

public IlvSDMObjectComparator.SortCriteria[] getSortCriteria()

Returns the sort criteria.

Returns:

The sort criteria.

See Also:

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

setTextualSortCriteria

public void setTextualSortCriteria(String textualSortCriteria)

Sets the sort criteria using a text description. The textualSortCriteria parameter must use a format similar to the following example:

data,name,ascending;data,value,descending;comparator,DESCENDING_HEIGHT;

which means:

• The primary sort criteria is the the "name" data model attribute in ascending order.
• The secondary sort criteria is the "value" data model attribute in descending order.
• The ternary sort criteria is the natural order defined by the DESCENDING_HEIGHT predefined comparator.

The textual description model,ascending describes the order of objects in the SDM model.

See Also:

getTextualSortCriteria()

getTextualSortCriteria

public String getTextualSortCriteria()

Returns the text description sort criteria.

Returns:

The text description sort criteria. If no sort criteria is defined, this method returns an empty string.

See Also:

setTextualSortCriteria(java.lang.String)

compare

public int compare(Object obj1,
                   Object obj2)

Compares two objects for order. Returns a negative integer, zero, or a positive integer if the first argument is less than, equal to, or greater than the second.

Specified by:

compare in interface Comparator<Object>

Parameters:

obj1 - The first object to be compared.

obj2 - The second object to be compared.

Returns:

This method returns one of the following:

• a negative integer: the first object is less than the second
• zero, the first object is equal to the second
• a positive integer or greater than the second

Throws:

ClassCastException - if the type of the arguments prevents them from being compared by this Comparator.

write

public void write(IlvOutputStream stream)
           throws IOException

Writes this comparator to the output stream.

Specified by:

write in interface IlvPersistentObject

Parameters:

stream - The output stream to write to.

Throws:

IOException - thrown when an exception occurs during the write operation for this object.