com.hlcl.rql.util.as
Class PageComparator

java.lang.Object
  com.hlcl.rql.util.as.PageComparator

All Implemented Interfaces:

java.util.Comparator

Direct Known Subclasses:

HeadlinePageComparator, LastChangedUserNamePageComparator, PageIdPageComparator, SortedHeadlinesPageComparator, StandardFieldDateDescAndHeadlineAscPageComparator, StandardFieldDatePageComparator, StandardFieldTextPageComparator

public abstract class PageComparator
extends java.lang.Object
implements java.util.Comparator

Author:

lejafr This class is the root of all page comparators.

Constructor Summary

PageComparator()
Creates a Comparator default ordering mode ascending.

Method Summary

int	compare(java.lang.Object o1, java.lang.Object o2) Needed method from Comparator.
abstract int	comparePages(Page page1, Page page2) Compare given pages for ascending ordering.
void	forceDescendingOrdering() Change the sort mode from ascending (default) to descending.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Comparator

equals

Constructor Detail

PageComparator

public PageComparator()

Creates a Comparator default ordering mode ascending.

Method Detail

forceDescendingOrdering

public void forceDescendingOrdering()

Change the sort mode from ascending (default) to descending.

compare

public final int compare(java.lang.Object o1,
                         java.lang.Object o2)

Needed method from Comparator.

Specified by:

compare in interface java.util.Comparator

Returns:

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

Throws:

java.lang.ClassCastException - if the arguments' types prevent them from being compared by this Comparator.

comparePages

public abstract int comparePages(Page page1,
                                 Page page2)

Compare given pages for ascending ordering.

Returns:

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

Throws:

java.lang.ClassCastException - if the arguments' types prevent them from being compared by this Comparator.