com.helger.commons.text.display

Class CollatingComparatorDisplayTextProvider<DATATYPE>

java.lang.Object

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

com.helger.commons.compare.AbstractPartComparator<DATATYPE,String>

com.helger.commons.compare.AbstractCollatingComparator<DATATYPE>

com.helger.commons.text.display.CollatingComparatorDisplayTextProvider<DATATYPE>

Type Parameters:

DATATYPE - The type of elements to be compared.

All Implemented Interfaces:

ISerializableComparator<DATATYPE>, Serializable, Comparator<DATATYPE>

@NotThreadSafe
public class CollatingComparatorDisplayTextProvider<DATATYPE>
extends AbstractCollatingComparator<DATATYPE>

This is a collation Comparator for objects that implement the IDisplayTextProvider interface.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CollatingComparatorDisplayTextProvider(Collator aCollator, IDisplayTextProvider<DATATYPE> aDisplayTextProvider, Locale aContentLocale) Constructor.
CollatingComparatorDisplayTextProvider(Locale aSortLocale, IDisplayTextProvider<DATATYPE> aDisplayTextProvider, Locale aContentLocale) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Locale	getContentLocale()
IDisplayTextProvider<DATATYPE>	getDisplayTextProvider()
protected String	getPart(DATATYPE aObject) Implement this method to extract the part to compare from the original object.

Methods inherited from class com.helger.commons.compare.AbstractCollatingComparator

getCollator

Methods inherited from class com.helger.commons.compare.AbstractPartComparator

getPartComparator, mainCompare, toString

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

compare, getNestedComparator, getSortOrder, isNullValuesComeFirst, setNestedComparator, setNullValuesComeFirst, 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

CollatingComparatorDisplayTextProvider

public CollatingComparatorDisplayTextProvider(@Nullable
                                      Locale aSortLocale,
                                      @Nonnull
                                      IDisplayTextProvider<DATATYPE> aDisplayTextProvider,
                                      @Nonnull
                                      Locale aContentLocale)

Constructor.

Parameters:

aSortLocale - The locale to be used for sorting. May be null.

aDisplayTextProvider - The display text provider to be used. May not be null.

aContentLocale - The locale to be used to retrieve the display text of an object. May not be null.

CollatingComparatorDisplayTextProvider

public CollatingComparatorDisplayTextProvider(@Nullable
                                      Collator aCollator,
                                      @Nonnull
                                      IDisplayTextProvider<DATATYPE> aDisplayTextProvider,
                                      @Nonnull
                                      Locale aContentLocale)

Constructor.

Parameters:

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

aDisplayTextProvider - The display text provider to be used. May not be null.

aContentLocale - The locale to be used to retrieve the display text of an object. May not be null.

Method Detail

getDisplayTextProvider

@Nonnull
public IDisplayTextProvider<DATATYPE> getDisplayTextProvider()

Returns:

The display text provider passed in the constructor. Never null.

getContentLocale

@Nonnull
public Locale getContentLocale()

Returns:

The content locale provided in the constructor. Never null.

getPart

protected String getPart(@Nonnull
             DATATYPE aObject)

Description copied from class: AbstractPartComparator

Implement this method to extract the part to compare from the original object.

Specified by:

getPart in class AbstractPartComparator<DATATYPE,String>

Parameters:

aObject - The object to be compared. Never null.

Returns:

The part of the source object to be compared with the part comparator provided in the constructor. May be null.