org.openmrs.util

Class PersonByNameComparator

java.lang.Object

org.openmrs.util.PersonByNameComparator

All Implemented Interfaces:

Comparator<Person>

public class PersonByNameComparator
extends Object
implements Comparator<Person>

A simple person comparator for sorting persons by name. Sorts names based on the following precedence: FamilyName, FamilyName2, GivenName, MiddleName, FamilyNamePrefix, FamilyNameSuffix

Since:

1.8

Constructor Summary

Constructors

Constructor and Description
PersonByNameComparator()

Method Summary

Modifier and Type	Method and Description
int	compare(Person person1, Person person2)
static int	comparePersonsByName(Person person1, Person person2) Compares two person objects by name

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

PersonByNameComparator

public PersonByNameComparator()

Method Detail

compare

public int compare(Person person1,
                   Person person2)

Specified by:

compare in interface Comparator<Person>

See Also:

Comparator.compare(java.lang.Object, java.lang.Object)

comparePersonsByName

public static int comparePersonsByName(Person person1,
                                       Person person2)

Compares two person objects by name

Since:

1.8

Should:

return negative if personName for person1 comes before that of person2, return positive if personName for person1 comes after that of person2, return zero if the givenName middleName and familyName match