ilog.views.chart.datax.adapter.sort

Class IlvColumnValueComparatorFactory

java.lang.Object

ilog.views.chart.datax.adapter.sort.IlvColumnValueComparatorFactory

All Implemented Interfaces:

IlvComparatorFactory, Serializable

public class IlvColumnValueComparatorFactory
extends Object
implements IlvComparatorFactory, Serializable

This class represents a comparison between model objects that is based on the values of the object in a given column. The column may be given through its index.

Since:

JViews 8.1

See Also:

IlvColumnValueComparator, Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvColumnValueComparatorFactory(IlvDataColumnInfo column, Comparator comparator, boolean inverted) Creates a comparator that uses a given column to compare objects of a model.
IlvColumnValueComparatorFactory(int columnIndex, Comparator comparator, boolean inverted) Creates a comparator that uses a given column to compare objects of a given model.

Method Summary

Modifier and Type	Method and Description
Comparator	createComparator(IlvObjectModelWithColumns model) Returns a comparator for the objects of the given model.
boolean	equals(Object other) Compares this object to another object.
IlvDataColumnInfo	getColumn() Returns the column whose values are used for comparison, or null if it was not specified to the constructor.
int	getColumnIndex() Returns the index of the column whose values are used for comparison, or -1 if it was not specified to the constructor.
Comparator	getComparator() Returns the Comparator for comparing the column values, or null denoting a default comparator.
int	hashCode() Returns a hash code that is compatible with equals().
boolean	isInverted() Returns true if the comparison is inverted.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvColumnValueComparatorFactory

public IlvColumnValueComparatorFactory(IlvDataColumnInfo column,
                                       Comparator comparator,
                                       boolean inverted)

Creates a comparator that uses a given column to compare objects of a model.

Parameters:

column - The column of the model whose values are used for comparison.

comparator - A Comparator for comparing the column values, or null denoting a default comparator.

inverted - true if the comparison is inverted.

IlvColumnValueComparatorFactory

public IlvColumnValueComparatorFactory(int columnIndex,
                                       Comparator comparator,
                                       boolean inverted)

Creates a comparator that uses a given column to compare objects of a given model. The column is specified through its index.

Parameters:

columnIndex - The index of the column of the model whose values are used for comparison.

comparator - A Comparator for comparing the column values, or null denoting a default comparator.

inverted - true if the comparison is inverted.

Method Detail

createComparator

public Comparator createComparator(IlvObjectModelWithColumns model)

Returns a comparator for the objects of the given model.

Specified by:

createComparator in interface IlvComparatorFactory

Parameters:

model - The model whose elements are being sorted.

equals

public boolean equals(Object other)

Compares this object to another object.

Specified by:

equals in interface IlvComparatorFactory

Overrides:

equals in class Object

hashCode

public int hashCode()

Returns a hash code that is compatible with equals().

Specified by:

hashCode in interface IlvComparatorFactory

Overrides:

hashCode in class Object

getColumn

public IlvDataColumnInfo getColumn()

Returns the column whose values are used for comparison, or null if it was not specified to the constructor.

getColumnIndex

public int getColumnIndex()

Returns the index of the column whose values are used for comparison, or -1 if it was not specified to the constructor.

getComparator

public Comparator getComparator()

Returns the Comparator for comparing the column values, or null denoting a default comparator.

isInverted

public boolean isInverted()

Returns true if the comparison is inverted.