Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/**
* Copyright (C) 2006-2015 phloc systems
* http://www.phloc.com
* office[at]phloc[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.phloc.commons.compare;
import java.text.Collator;
import java.util.Comparator;
import java.util.Locale;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import com.phloc.commons.ValueEnforcer;
import com.phloc.commons.string.ToStringGenerator;
/**
* An abstract implementation of a {@link java.util.Comparator} that uses
* collations for ordering. This is only necessary when comparing strings.
*
* @author Philip Helger
* @param
* the type of object to be compared
*/
public abstract class AbstractCollationComparator extends AbstractComparator
{
private final Collator m_aCollator;
/**
* Comparator with default locale {@link Collator} and default sort order.
*/
public AbstractCollationComparator ()
{
this ((Locale) null, ESortOrder.DEFAULT, (Comparator ) null);
}
/**
* Comparator with default locale {@link Collator} and default sort order and
* a nested comparator.
*
* @param aNestedComparator
* The nested comparator to be invoked, when the main comparison
* resulted in 0.
*/
public AbstractCollationComparator (@Nullable final Comparator aNestedComparator)
{
this ((Locale) null, ESortOrder.DEFAULT, aNestedComparator);
}
/**
* Comparator with default locale {@link Collator}.
*
* @param eSortOrder
* The sort order to use. May not be null.
*/
public AbstractCollationComparator (@Nonnull final ESortOrder eSortOrder)
{
this ((Locale) null, eSortOrder, (Comparator ) null);
}
/**
* Comparator with default locale {@link Collator} and a nested comparator.
*
* @param eSortOrder
* The sort order to use. May not be null.
* @param aNestedComparator
* The nested comparator to be invoked, when the main comparison
* resulted in 0.
*/
public AbstractCollationComparator (@Nonnull final ESortOrder eSortOrder,
@Nullable final Comparator aNestedComparator)
{
this ((Locale) null, eSortOrder, aNestedComparator);
}
/**
* Comparator with default sort order and specified sort locale.
*
* @param aSortLocale
* The locale to use. May be null.
*/
public AbstractCollationComparator (@Nullable final Locale aSortLocale)
{
this (aSortLocale, ESortOrder.DEFAULT, (Comparator ) null);
}
/**
* Comparator with default sort order but special locale and a nested
* comparator.
*
* @param aSortLocale
* The locale to use. May be null.
* @param aNestedComparator
* The nested comparator to be invoked, when the main comparison
* resulted in 0.
*/
public AbstractCollationComparator (@Nullable final Locale aSortLocale,
@Nullable final Comparator aNestedComparator)
{
this (aSortLocale, ESortOrder.DEFAULT, aNestedComparator);
}
/**
* Constructor with locale and sort order.
*
* @param aSortLocale
* The locale to use. May be null.
* @param eSortOrder
* The sort order to use. May not be null.
*/
public AbstractCollationComparator (@Nullable final Locale aSortLocale, @Nonnull final ESortOrder eSortOrder)
{
this (aSortLocale, eSortOrder, (Comparator ) null);
}
/**
* Constructor with locale and sort order and a nested comparator.
*
* @param aSortLocale
* The locale to use. May be null.
* @param eSortOrder
* The sort order to use. May not be null.
* @param aNestedComparator
* The nested comparator to be invoked, when the main comparison
* resulted in 0.
*/
public AbstractCollationComparator (@Nullable final Locale aSortLocale,
@Nonnull final ESortOrder eSortOrder,
@Nullable final Comparator aNestedComparator)
{
super (eSortOrder, aNestedComparator);
m_aCollator = CollatorUtils.getCollatorSpaceBeforeDot (aSortLocale);
}
/**
* Constructor with {@link Collator} using the default sort order
*
* @param aCollator
* The {@link Collator} to use. May not be null.
*/
public AbstractCollationComparator (@Nonnull final Collator aCollator)
{
this (aCollator, ESortOrder.DEFAULT, (Comparator ) null);
}
/**
* Constructor with {@link Collator} using the default sort order and a nested
* comparator.
*
* @param aCollator
* The {@link Collator} to use. May not be null.
* @param aNestedComparator
* The nested comparator to be invoked, when the main comparison
* resulted in 0.
*/
public AbstractCollationComparator (@Nonnull final Collator aCollator,
@Nullable final Comparator aNestedComparator)
{
this (aCollator, ESortOrder.DEFAULT, aNestedComparator);
}
/**
* Constructor with {@link Collator} and sort order.
*
* @param aCollator
* The {@link Collator} to use. May not be null.
* @param eSortOrder
* The sort order to use. May not be null.
*/
public AbstractCollationComparator (@Nonnull final Collator aCollator, @Nonnull final ESortOrder eSortOrder)
{
this (aCollator, eSortOrder, (Comparator ) null);
}
/**
* Constructor with {@link Collator} and sort order and a nested comparator.
*
* @param aCollator
* The {@link Collator} to use. May not be null.
* @param eSortOrder
* The sort order to use. May not be null.
* @param aNestedComparator
* The nested comparator to be invoked, when the main comparison
* resulted in 0.
*/
public AbstractCollationComparator (@Nonnull final Collator aCollator,
@Nonnull final ESortOrder eSortOrder,
@Nullable final Comparator aNestedComparator)
{
super (eSortOrder, aNestedComparator);
ValueEnforcer.notNull (aCollator, "Collator");
m_aCollator = (Collator) aCollator.clone ();
}
/**
* Abstract method that needs to be overridden to convert an object to a
* string representation for comparison.
*
* @param aObject
* The object to be converted. May not be null depending
* on the elements to be sorted.
* @return The string representation of the object. May be null.
*/
@Nullable
protected abstract String asString (@Nonnull DATATYPE aObject);
@Nullable
private String _nullSafeGetAsString (@Nullable final DATATYPE aObject)
{
return aObject == null ? null : asString (aObject);
}
@Override
protected final int mainCompare (@Nullable final DATATYPE aElement1, @Nullable final DATATYPE aElement2)
{
final String s1 = _nullSafeGetAsString (aElement1);
final String s2 = _nullSafeGetAsString (aElement2);
return CompareUtils.nullSafeCompare (s1, s2, m_aCollator);
}
@Override
public String toString ()
{
return new ToStringGenerator (this).append ("sortOrder", getSortOrder ())
.append ("collator", m_aCollator)
.toString ();
}
}
