All Downloads are FREE. Search and download functionalities are using the official Maven repository.

se.sawano.java.text.AlphanumericComparator Maven / Gradle / Ivy

Go to download

An implementation of a comparator that sort strings in an order that makes sense for a human.

There is a newer version: 1.4.1
Show newest version
/*
 * GNU LESSER GENERAL PUBLIC LICENSE
 *                        Version 3, 29 June 2007
 *
 *  Copyright (C) 2007 Free Software Foundation, Inc. 
 *  Everyone is permitted to copy and distribute verbatim copies
 *  of this license document, but changing it is not allowed.
 *
 *
 *   This version of the GNU Lesser General Public License incorporates
 * the terms and conditions of version 3 of the GNU General Public
 * License, supplemented by the additional permissions listed below.
 *
 *   0. Additional Definitions.
 *
 *   As used herein, "this License" refers to version 3 of the GNU Lesser
 * General Public License, and the "GNU GPL" refers to version 3 of the GNU
 * General Public License.
 *
 *   "The Library" refers to a covered work governed by this License,
 * other than an Application or a Combined Work as defined below.
 *
 *   An "Application" is any work that makes use of an interface provided
 * by the Library, but which is not otherwise based on the Library.
 * Defining a subclass of a class defined by the Library is deemed a mode
 * of using an interface provided by the Library.
 *
 *   A "Combined Work" is a work produced by combining or linking an
 * Application with the Library.  The particular version of the Library
 * with which the Combined Work was made is also called the "Linked
 * Version".
 *
 *   The "Minimal Corresponding Source" for a Combined Work means the
 * Corresponding Source for the Combined Work, excluding any source code
 * for portions of the Combined Work that, considered in isolation, are
 * based on the Application, and not on the Linked Version.
 *
 *   The "Corresponding Application Code" for a Combined Work means the
 * object code and/or source code for the Application, including any data
 * and utility programs needed for reproducing the Combined Work from the
 * Application, but excluding the System Libraries of the Combined Work.
 *
 *   1. Exception to Section 3 of the GNU GPL.
 *
 *   You may convey a covered work under sections 3 and 4 of this License
 * without being bound by section 3 of the GNU GPL.
 *
 *   2. Conveying Modified Versions.
 *
 *   If you modify a copy of the Library, and, in your modifications, a
 * facility refers to a function or data to be supplied by an Application
 * that uses the facility (other than as an argument passed when the
 * facility is invoked), then you may convey a copy of the modified
 * version:
 *
 *    a) under this License, provided that you make a good faith effort to
 *    ensure that, in the event an Application does not supply the
 *    function or data, the facility still operates, and performs
 *    whatever part of its purpose remains meaningful, or
 *
 *    b) under the GNU GPL, with none of the additional permissions of
 *    this License applicable to that copy.
 *
 *   3. Object Code Incorporating Material from Library Header Files.
 *
 *   The object code form of an Application may incorporate material from
 * a header file that is part of the Library.  You may convey such object
 * code under terms of your choice, provided that, if the incorporated
 * material is not limited to numerical parameters, data structure
 * layouts and accessors, or small macros, inline functions and templates
 * (ten or fewer lines in length), you do both of the following:
 *
 *    a) Give prominent notice with each copy of the object code that the
 *    Library is used in it and that the Library and its use are
 *    covered by this License.
 *
 *    b) Accompany the object code with a copy of the GNU GPL and this license
 *    document.
 *
 *   4. Combined Works.
 *
 *   You may convey a Combined Work under terms of your choice that,
 * taken together, effectively do not restrict modification of the
 * portions of the Library contained in the Combined Work and reverse
 * engineering for debugging such modifications, if you also do each of
 * the following:
 *
 *    a) Give prominent notice with each copy of the Combined Work that
 *    the Library is used in it and that the Library and its use are
 *    covered by this License.
 *
 *    b) Accompany the Combined Work with a copy of the GNU GPL and this license
 *    document.
 *
 *    c) For a Combined Work that displays copyright notices during
 *    execution, include the copyright notice for the Library among
 *    these notices, as well as a reference directing the user to the
 *    copies of the GNU GPL and this license document.
 *
 *    d) Do one of the following:
 *
 *        0) Convey the Minimal Corresponding Source under the terms of this
 *        License, and the Corresponding Application Code in a form
 *        suitable for, and under terms that permit, the user to
 *        recombine or relink the Application with a modified version of
 *        the Linked Version to produce a modified Combined Work, in the
 *        manner specified by section 6 of the GNU GPL for conveying
 *        Corresponding Source.
 *
 *        1) Use a suitable shared library mechanism for linking with the
 *        Library.  A suitable mechanism is one that (a) uses at run time
 *        a copy of the Library already present on the user's computer
 *        system, and (b) will operate properly with a modified version
 *        of the Library that is interface-compatible with the Linked
 *        Version.
 *
 *    e) Provide Installation Information, but only if you would otherwise
 *    be required to provide such information under section 6 of the
 *    GNU GPL, and only to the extent that such information is
 *    necessary to install and execute a modified version of the
 *    Combined Work produced by recombining or relinking the
 *    Application with a modified version of the Linked Version. (If
 *    you use option 4d0, the Installation Information must accompany
 *    the Minimal Corresponding Source and Corresponding Application
 *    Code. If you use option 4d1, you must provide the Installation
 *    Information in the manner specified by section 6 of the GNU GPL
 *    for conveying Corresponding Source.)
 *
 *   5. Combined Libraries.
 *
 *   You may place library facilities that are a work based on the
 * Library side by side in a single library together with other library
 * facilities that are not Applications and are not covered by this
 * License, and convey such a combined library under terms of your
 * choice, if you do both of the following:
 *
 *    a) Accompany the combined library with a copy of the same work based
 *    on the Library, uncombined with any other library facilities,
 *    conveyed under the terms of this License.
 *
 *    b) Give prominent notice with the combined library that part of it
 *    is a work based on the Library, and explaining where to find the
 *    accompanying uncombined form of the same work.
 *
 *   6. Revised Versions of the GNU Lesser General Public License.
 *
 *   The Free Software Foundation may publish revised and/or new versions
 * of the GNU Lesser General Public License from time to time. Such new
 * versions will be similar in spirit to the present version, but may
 * differ in detail to address new problems or concerns.
 *
 *   Each version is given a distinguishing version number. If the
 * Library as you received it specifies that a certain numbered version
 * of the GNU Lesser General Public License "or any later version"
 * applies to it, you have the option of following the terms and
 * conditions either of that published version or of any later version
 * published by the Free Software Foundation. If the Library as you
 * received it does not specify a version number of the GNU Lesser
 * General Public License, you may choose any version of the GNU Lesser
 * General Public License ever published by the Free Software Foundation.
 *
 *   If the Library as you received it specifies that a proxy can decide
 * whether future versions of the GNU Lesser General Public License shall
 * apply, that proxy's public statement of acceptance of any version is
 * permanent authorization for you to choose that version for the
 * Library.
 */

package se.sawano.java.text;

import java.nio.CharBuffer;
import java.text.Collator;
import java.util.Comparator;
import java.util.Locale;

import static java.nio.CharBuffer.wrap;
import static java.util.Objects.requireNonNull;
/*
 * Author of AlphanumericComparator:  Daniel Sawano, 2014, https://github.com/sawano/alphanumeric-comparator
 *
 * Original authors of the Alphanum Java implementation include: Daniel Migowski, Andre Bogus, and David Koelle
 * See http://www.DaveKoelle.com for information on the original algorithm.
 */

/**
 * An implementation of a comparator that sort strings in an order that makes sense for a human.
 * 

* This comparator is based on the AlphanumComparator found at http://www.DaveKoelle.com and has been rewritten and modified by Daniel Sawano. *

* This source can be found at https://github.com/sawano/alphanumeric-comparator *

* Note: this algorithm does not take into account numeric notation such as decimals, negative numbers, scientific notation etc. * * @author Daniel Sawano */ public class AlphanumericComparator implements Comparator { private final Collator collator; /** * Creates a comparator that will use lexicographical sorting of the non-numerical parts of the compared strings. */ public AlphanumericComparator() { collator = null; } /** * Creates a comparator that will use locale-sensitive sorting of the non-numerical parts of the compared strings. * * @param locale * the locale to use */ public AlphanumericComparator(final Locale locale) { this(Collator.getInstance(requireNonNull(locale))); } /** * Creates a comparator that will use the given collator to sort the non-numerical parts of the compared strings. * * @param collator * the collator to use */ public AlphanumericComparator(final Collator collator) { this.collator = requireNonNull(collator); } @Override public int compare(final String s1, final String s2) { final CharBuffer b1 = wrap(s1); final CharBuffer b2 = wrap(s2); while (b1.remaining() > 0 && b2.remaining() > 0) { final int result = compare(nextToken(b1), nextToken(b2)); if (result != 0) { return result; } } return s1.length() - s2.length(); } private int compare(final CharBuffer s1, final CharBuffer s2) { if (isNumeric(s1) && isNumeric(s2)) { final int numericalResult = compareNumerically(s1, s2); if (numericalResult != 0) { return numericalResult; } } return compareStrings(s1.toString(), s2.toString()); } private int compareStrings(final String s1, final String s2) { if (collator == null) { return s1.compareTo(s2); } return collator.compare(s1, s2); } private CharBuffer nextToken(final CharBuffer s) { final int endOfToken = positionOfNextDigitBoundary(s); final CharBuffer token = s.subSequence(0, endOfToken - s.position()); s.position(endOfToken); return token; } private int positionOfNextDigitBoundary(final CharBuffer s) { int endPos = s.position(); final boolean firstWasDigit = isDigit(s.get(s.position())); while (endPos < s.limit() && firstWasDigit == isDigit(s.get(endPos))) { ++endPos; } return endPos; } private boolean isNumeric(final CharBuffer string) { return isDigit(string.get(string.position())); } private boolean isDigit(final char c) { if (collator == null) { final int cInt = (int) c; return cInt >= 48 && cInt <= 57; } return Character.isDigit(c); } private int compareNumerically(final CharBuffer s1, CharBuffer s2) { trimLeadingZeros(s1); trimLeadingZeros(s2); if (s1.remaining() != s2.remaining()) { return s1.remaining() - s2.remaining(); } while (s1.hasRemaining()) { final int result = Character.compare(s1.get(), s2.get()); if (result != 0) { return result; } } return 0; } private void trimLeadingZeros(final CharBuffer numericalString) { while (numericalString.remaining() > 0 && numericalString.get(numericalString.position()) == '0') { numericalString.position(numericalString.position() + 1); } } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy