Package org.eclipse.nebula.widgets.nattable.hierarchical

Class HierarchicalWrapperComparator

java.lang.Object

org.eclipse.nebula.widgets.nattable.hierarchical.HierarchicalWrapperComparator

All Implemented Interfaces:

Comparator<HierarchicalWrapper>

public class HierarchicalWrapperComparator
extends Object
implements Comparator<HierarchicalWrapper>

Comparator for collections of HierarchicalWrapper. Ensures that the objects are ordered in a way that the expected tree structure is kept. Additionally provides a way to sort by column if an ISortModel is set, by still keeping the tree structure. That means in deeper levels of the tree, only the sub nodes are sorted, not the tree itself is changed.

Since:

1.6

Constructor Summary

Constructors

Constructor	Description
HierarchicalWrapperComparator(IColumnAccessor<HierarchicalWrapper> columnAccessor, Map<Integer,List<Integer>> levelIndexMapping)	Creates a new HierarchicalWrapperComparator without an ISortModel.
HierarchicalWrapperComparator(IColumnAccessor<HierarchicalWrapper> columnAccessor, Map<Integer,List<Integer>> levelIndexMapping, ISortModel sortModel)	Creates a new HierarchicalWrapperComparator with an ISortModel to support dynamic configurable column based sorting.

Method Summary

Modifier and Type	Method	Description
int	compare(HierarchicalWrapper o1, HierarchicalWrapper o2)
protected int	compareColumn(HierarchicalWrapper o1, HierarchicalWrapper o2, int columnIndex, boolean useDefault)	Compares two HierarchicalWrapper objects based on the information in the given column.
protected int	compareLevel(HierarchicalWrapper o1, HierarchicalWrapper o2, int level)	Compares two HierarchicalWrapper objects based on the information in the given level.
protected Comparator	getComparator(int columnIndex, boolean useDefault)	Returns the Comparator that should be used to compare the values in a column for the given column index.
ISortModel	getSortModel()
void	setSortModel(ISortModel sortModel)

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

equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

HierarchicalWrapperComparator

public HierarchicalWrapperComparator(IColumnAccessor<HierarchicalWrapper> columnAccessor,
                                     Map<Integer,List<Integer>> levelIndexMapping)

Creates a new HierarchicalWrapperComparator without an ISortModel. Without an ISortModel the DefaultComparator is used for comparison of column values to keep the tree structure. The sort order can not be influenced via column sorting, until a ISortModel is set via setSortModel(ISortModel).

Parameters:

columnAccessor - The IColumnAccessor needed to access the column values of the HierarchicalWrapper row objects.

levelIndexMapping - The mapping of tree level to column indexes needed for level based sorting.

HierarchicalWrapperComparator

public HierarchicalWrapperComparator(IColumnAccessor<HierarchicalWrapper> columnAccessor,
                                     Map<Integer,List<Integer>> levelIndexMapping,
                                     ISortModel sortModel)

Creates a new HierarchicalWrapperComparator with an ISortModel to support dynamic configurable column based sorting.

Parameters:

columnAccessor - The IColumnAccessor needed to access the column values of the HierarchicalWrapper row objects.

levelIndexMapping - The mapping of tree level to column indexes needed for level based sorting.

sortModel - The ISortModel that provides access to configured column comparators and supports dynamic sorting per column.

Method Detail

compare

public int compare(HierarchicalWrapper o1,
                   HierarchicalWrapper o2)

Specified by:

compare in interface Comparator<HierarchicalWrapper>

compareLevel

protected int compareLevel(HierarchicalWrapper o1,
                           HierarchicalWrapper o2,
                           int level)

Compares two HierarchicalWrapper objects based on the information in the given level.

Parameters:

o1 - The first HierarchicalWrapper object to be compared.

o2 - The second HierarchicalWrapper object to be compared.

level - The level that should be compared.

Returns:

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

compareColumn

protected int compareColumn(HierarchicalWrapper o1,
                            HierarchicalWrapper o2,
                            int columnIndex,
                            boolean useDefault)

Compares two HierarchicalWrapper objects based on the information in the given column.

Parameters:

o1 - The first HierarchicalWrapper object to be compared.

o2 - The second HierarchicalWrapper object to be compared.

columnIndex -

useDefault - flag to configure whether the DefaultComparator should be used in case no dedicated comparator is configured. Should be set to true in case the comparator for a column is requested that is needed to ensure the tree structure.

Returns:

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

getComparator

protected Comparator getComparator(int columnIndex,
                                   boolean useDefault)

Returns the Comparator that should be used to compare the values in a column for the given column index.

Parameters:

columnIndex - The column index of the column for which the Comparator is requested.

useDefault - flag to configure whether the DefaultComparator should be used in case no dedicated comparator is configured. Should be set to true in case the comparator for a column is requested that is needed to ensure the tree structure.

Returns:

The Comparator that should be used to compare the values for elements in the given column. Returns the DefaultComparator in case there is no ISortModel configured, no Comparator is found for the given column or a NullComparator is configured for the given column.

getSortModel

public ISortModel getSortModel()

Returns:

The ISortModel that is set in this HierarchicalWrapperComparator to support dynamic column based sorting in combination with tree sorting.

setSortModel

public void setSortModel(ISortModel sortModel)

Parameters:

sortModel - The ISortModel that should be used by this HierarchicalWrapperComparator to support dynamic column based sorting in combination with tree sorting.