no.g9.client.support

Class AbstractAttributeComparator

java.lang.Object

no.g9.client.support.AbstractAttributeComparator

All Implemented Interfaces:

Comparable, Comparator

public abstract class AbstractAttributeComparator
extends Object
implements Comparator, Comparable

Internal use!

The AbstractAttributeComparator has the capability to chain comparators, facilitating a generic sort based on various attributes.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ASCENDING Constant denoting the sort direction.
static int	DESCENDING Constant denoting the sort direction.

Constructor Summary

Constructors

Constructor and Description
AbstractAttributeComparator(String attributeName, int column, int priority, int direction) Creates a new instance of this comparator.

Method Summary

Modifier and Type	Method and Description
static void	chainComparators(List comparators) Chains this comparator to first comparator in the list, and then calls that comparators chain method.
int	compareTo(AbstractAttributeComparator another) Compares this object to another instance of AbstractAttributeComparator.
int	compareTo(Object o) Compares this object with the specified object for order.
String	getAttributeName() Returns the attribute name this comparator compares.
int	getColumn() Internal use.
static AbstractAttributeComparator	getComparator(List comparators, int column) Get the comparator with the given column number
int	getDirection() Gets the sort direction of this comparator.
AbstractAttributeComparator	getNextComparator() Gets the next comparator in line.
int	getPriority() Gets the priority of this comparator.
void	setAttributeName(String attributeName) Sets the name of the attribute this comparator compares.
void	setColumn(int column) Internal use.
void	setDirection(int direction) Sets the sort direction of this comparator.
void	setNextComparator(AbstractAttributeComparator nextComparator) Sets the next comparator.
void	setPriority(int priority) Sets the priority of this comparator.
void	toggleDirection() Toggles the sort direction of this comparator.
String	toString() Mainly for debugging purposes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

compare, comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

ASCENDING

public static final int ASCENDING

Constant denoting the sort direction.

See Also:

Constant Field Values

DESCENDING

public static final int DESCENDING

Constant denoting the sort direction.

See Also:

Constant Field Values

Constructor Detail

AbstractAttributeComparator

public AbstractAttributeComparator(String attributeName,
                                   int column,
                                   int priority,
                                   int direction)

Creates a new instance of this comparator.

Parameters:

attributeName - the name of the attribute this comparator compares.

column - the column number for this comparator

priority - the priority of this comparator

direction - the sort direction of this comparator, either ASCENDING or DESCENDING.

Method Detail

compareTo

public int compareTo(Object o)

Compares this object with the specified object for order.

Specified by:

compareTo in interface Comparable

Parameters:

o - the Object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

compareTo

public int compareTo(AbstractAttributeComparator another)

Compares this object to another instance of AbstractAttributeComparator. The comparison is based on the priority.

Parameters:

another - the AbstractAttributeComparator to compare with.

Returns:

a negative integer, zero, or a positive integer as this object's priority is less than, equal to, or greater than the specified object's priority.

chainComparators

public static void chainComparators(List comparators)

Chains this comparator to first comparator in the list, and then calls that comparators chain method.

Parameters:

comparators - (missing javadoc)

getComparator

public static AbstractAttributeComparator getComparator(List comparators,
                                                        int column)

Get the comparator with the given column number

Parameters:

comparators - the list of comparators

column - the column number

Returns:

the comparator, null if not found

getNextComparator

public AbstractAttributeComparator getNextComparator()

Gets the next comparator in line.

Returns:

the next comparator.

setNextComparator

public void setNextComparator(AbstractAttributeComparator nextComparator)

Sets the next comparator. The next comparator is used if the comparison is equal.

Parameters:

nextComparator - the next comparator in line.

getAttributeName

public String getAttributeName()

Returns the attribute name this comparator compares.

Returns:

the attributeName

setAttributeName

public void setAttributeName(String attributeName)

Sets the name of the attribute this comparator compares.

Parameters:

attributeName - the attributeName to set

getDirection

public int getDirection()

Gets the sort direction of this comparator. The direction is either ASCENDING or DESCENDING.

Returns:

the direction

setDirection

public void setDirection(int direction)

Sets the sort direction of this comparator. The sort direction should be either ASCENDING or DESCENDING.

Parameters:

direction - the direction to set

toggleDirection

public void toggleDirection()

Toggles the sort direction of this comparator.

getPriority

public int getPriority()

Gets the priority of this comparator.

Returns:

the priority

setPriority

public void setPriority(int priority)

Sets the priority of this comparator.

Parameters:

priority - the priority to set

toString

public String toString()

Mainly for debugging purposes. Returns a string representation of this comparator. The string contains the name of the attribute this comparator compares, the sort direction and the priority of this comparator.

Overrides:

toString in class Object

Returns:

String representation of this comparator

getColumn

public int getColumn()

Internal use.

Returns:

the column

setColumn

public void setColumn(int column)

Internal use.

Parameters:

column - the column to set