com.phloc.commons.compare

Class AbstractCollationComparator<DATATYPE>

java.lang.Object

com.phloc.commons.compare.AbstractComparator<DATATYPE>

com.phloc.commons.compare.AbstractCollationComparator<DATATYPE>

Type Parameters:

DATATYPE - the type of object to be compared

All Implemented Interfaces:

Serializable, Comparator<DATATYPE>

Direct Known Subclasses:

ComparatorAsString, ComparatorDisplayNameProvider, ComparatorDisplayTextProvider, ComparatorFileAbsolutePath, ComparatorFileName, ComparatorHasDisplayName, ComparatorHasDisplayText, ComparatorHasErrorID, ComparatorHasName, ComparatorLocale, ComparatorLocaleCountry, ComparatorLocaleDisplayCountry, ComparatorLocaleDisplayCountryInLocale, ComparatorLocaleDisplayCountryNative, ComparatorLocaleDisplayLanguage, ComparatorLocaleDisplayLanguageInLocale, ComparatorLocaleDisplayLanguageNative, ComparatorLocaleDisplayName, ComparatorLocaleDisplayNameInLocale, ComparatorLocaleDisplayNameNative, ComparatorLocaleLanguage, ComparatorString, ComparatorThreadName

public abstract class AbstractCollationComparator<DATATYPE>
extends AbstractComparator<DATATYPE>

An abstract implementation of a Comparator that uses collations for ordering. This is only necessary when comparing strings.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractCollationComparator() Comparator with default locale Collator and default sort order.
AbstractCollationComparator(Collator aCollator) Constructor with Collator using the default sort order
AbstractCollationComparator(Collator aCollator, Comparator<? super DATATYPE> aNestedComparator) Constructor with Collator using the default sort order and a nested comparator.
AbstractCollationComparator(Collator aCollator, ESortOrder eSortOrder) Constructor with Collator and sort order.
AbstractCollationComparator(Collator aCollator, ESortOrder eSortOrder, Comparator<? super DATATYPE> aNestedComparator) Constructor with Collator and sort order and a nested comparator.
AbstractCollationComparator(Comparator<? super DATATYPE> aNestedComparator) Comparator with default locale Collator and default sort order and a nested comparator.
AbstractCollationComparator(ESortOrder eSortOrder) Comparator with default locale Collator.
AbstractCollationComparator(ESortOrder eSortOrder, Comparator<? super DATATYPE> aNestedComparator) Comparator with default locale Collator and a nested comparator.
AbstractCollationComparator(Locale aSortLocale) Comparator with default sort order and specified sort locale.
AbstractCollationComparator(Locale aSortLocale, Comparator<? super DATATYPE> aNestedComparator) Comparator with default sort order but special locale and a nested comparator.
AbstractCollationComparator(Locale aSortLocale, ESortOrder eSortOrder) Constructor with locale and sort order.
AbstractCollationComparator(Locale aSortLocale, ESortOrder eSortOrder, Comparator<? super DATATYPE> aNestedComparator) Constructor with locale and sort order and a nested comparator.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract String	asString(DATATYPE aObject) Abstract method that needs to be overridden to convert an object to a string representation for comparison.
protected int	mainCompare(DATATYPE aElement1, DATATYPE aElement2)
String	toString()

Methods inherited from class com.phloc.commons.compare.AbstractComparator

compare, getSortOrder, setSortOrder

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

equals

Constructor Detail

AbstractCollationComparator

public AbstractCollationComparator()

Comparator with default locale Collator and default sort order.

AbstractCollationComparator

public AbstractCollationComparator(@Nullable
                           Comparator<? super DATATYPE> aNestedComparator)

Comparator with default locale Collator and default sort order and a nested comparator.

Parameters:

aNestedComparator - The nested comparator to be invoked, when the main comparison resulted in 0.

AbstractCollationComparator

public AbstractCollationComparator(@Nonnull
                           ESortOrder eSortOrder)

Comparator with default locale Collator.

Parameters:

eSortOrder - The sort order to use. May not be null.

AbstractCollationComparator

public AbstractCollationComparator(@Nonnull
                           ESortOrder eSortOrder,
                           @Nullable
                           Comparator<? super DATATYPE> aNestedComparator)

Comparator with default locale Collator and a nested comparator.

Parameters:

eSortOrder - The sort order to use. May not be null.

aNestedComparator - The nested comparator to be invoked, when the main comparison resulted in 0.

AbstractCollationComparator

public AbstractCollationComparator(@Nullable
                           Locale aSortLocale)

Comparator with default sort order and specified sort locale.

Parameters:

aSortLocale - The locale to use. May be null.

AbstractCollationComparator

public AbstractCollationComparator(@Nullable
                           Locale aSortLocale,
                           @Nullable
                           Comparator<? super DATATYPE> aNestedComparator)

Comparator with default sort order but special locale and a nested comparator.

Parameters:

aSortLocale - The locale to use. May be null.

aNestedComparator - The nested comparator to be invoked, when the main comparison resulted in 0.

AbstractCollationComparator

public AbstractCollationComparator(@Nullable
                           Locale aSortLocale,
                           @Nonnull
                           ESortOrder eSortOrder)

Constructor with locale and sort order.

Parameters:

aSortLocale - The locale to use. May be null.

eSortOrder - The sort order to use. May not be null.

AbstractCollationComparator

public AbstractCollationComparator(@Nullable
                           Locale aSortLocale,
                           @Nonnull
                           ESortOrder eSortOrder,
                           @Nullable
                           Comparator<? super DATATYPE> aNestedComparator)

Constructor with locale and sort order and a nested comparator.

Parameters:

aSortLocale - The locale to use. May be null.

eSortOrder - The sort order to use. May not be null.

aNestedComparator - The nested comparator to be invoked, when the main comparison resulted in 0.

AbstractCollationComparator

public AbstractCollationComparator(@Nonnull
                           Collator aCollator)

Constructor with Collator using the default sort order

Parameters:

aCollator - The Collator to use. May not be null.

AbstractCollationComparator

public AbstractCollationComparator(@Nonnull
                           Collator aCollator,
                           @Nullable
                           Comparator<? super DATATYPE> aNestedComparator)

Constructor with Collator using the default sort order and a nested comparator.

Parameters:

aCollator - The Collator to use. May not be null.

aNestedComparator - The nested comparator to be invoked, when the main comparison resulted in 0.

AbstractCollationComparator

public AbstractCollationComparator(@Nonnull
                           Collator aCollator,
                           @Nonnull
                           ESortOrder eSortOrder)

Constructor with Collator and sort order.

Parameters:

aCollator - The Collator to use. May not be null.

eSortOrder - The sort order to use. May not be null.

AbstractCollationComparator

public AbstractCollationComparator(@Nonnull
                           Collator aCollator,
                           @Nonnull
                           ESortOrder eSortOrder,
                           @Nullable
                           Comparator<? super DATATYPE> aNestedComparator)

Constructor with Collator and sort order and a nested comparator.

Parameters:

aCollator - The Collator to use. May not be null.

eSortOrder - The sort order to use. May not be null.

aNestedComparator - The nested comparator to be invoked, when the main comparison resulted in 0.

Method Detail

asString

@Nullable
protected abstract String asString(@Nonnull
                       DATATYPE aObject)

Abstract method that needs to be overridden to convert an object to a string representation for comparison.

Parameters:

aObject - The object to be converted. May not be null depending on the elements to be sorted.

Returns:

The string representation of the object. May be null.

mainCompare

protected final int mainCompare(@Nullable
              DATATYPE aElement1,
              @Nullable
              DATATYPE aElement2)

Specified by:

mainCompare in class AbstractComparator<DATATYPE>

Parameters:

aElement1 - First element to compare. No information on the null status.

aElement2 - Second element to compare. No information on the null status.

Returns:

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

toString

public String toString()

Overrides:

toString in class Object