Sortierung eigener Objekte in einer ArrayList mit Comparable und Comparator

In Java lassen sich die Wrapper-Klassen wie Byte, Short, Integer, Long, Float, Double und String mühelos mit den Methoden in den Klassen Arrays und Collections sortieren, da diese Wrapper-Klassen alle das Interface Comparable implementieren. Was aber, wenn man eigene Objekte sortiert haben will? Der folgende Beitrag erläutert das anhand der Klasse ArrayList mit der eigenen Klasse Auto.

Zuerst sei das Interface Comparable erläutert. Eine ArrayList ist eine Klasse, welche das Interface List implementiert. Deshalb sollte bei der Instantierung zuerst als Typ das Interface und danach den Konstruktor der Klasse angeben. Will man Objekte des Typs String in eine ArrayList speichern, kann die Liste wie folgt angelegt werden:

List<String> liste = new ArrayList<String>();

Wir haben nun eine Referenz mit dem Bezeichner liste erzeugt, welche auf ein Objekt des Typs Arraylist referenziert. Die liste ist typsicher, d.h. es können nur Objekte des Typs String hinzugefügt werden. Versucht man Objekte eines anderen Typs hinzuzufügen, wird der Code schon gar nicht kompiliert.

Die Klasse ArrayList implementiert die Methode add(), welches das Hinzufügen von Objekten erlaubt, also für die liste:

liste.add("Hallo");  
liste.add("Welt");  

Will man nun liste sortieren, verwendet man in Java die Klasse Collections, welche viele nützliche Methoden enthält, u.a. die Methode sort()

Collections.sort(liste);

Damit ist die liste sortiert. So einfach geht das mit allen Wrapper-Klassen wie Byte, Short, Long, Float, Double und eben String, da diese das Interface Comparable von Haus aus implementieren.

Was aber, wenn man eigene Objekte mit mehreren Feldern sortieren will? Die JVM kann natürlich nicht wissen, nach welchem Feld sortiert werden soll. Deshalb muss die eigene Klasse das Interface Comparable implementieren resp. deren Methode compareTo(), welche angibt, nach was sortiert werden soll. Angenommen es gibt eine Klasse Auto mit den Feldern Marke und Inverkehrsetzung und die Sortierung soll nach der Marke vorgenommen werden, dann kann die Klasse Auto wie folgt aussehen:

public class Auto implements Comparable<Auto>{
	private String marke;
	private int inv;
	
	public Auto(String m, int i) {
		this.marke = m;
		this.inv = i;
	}

	public String getMarke() {
		return this.marke;
	}
	
	public String toString() {
		return this.marke + " (" + this.inv + ")";  
	}
	
	@Override
	public int compareTo(Auto auto) {
		return this.marke.compareTo(auto.getMarke());
	}
}

Nun enthält die Liste nicht mehr String Typen, sondern Autos. Musterhaft könnte eine Beispielklasse so aussehen:

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

public class AutoListeBeispiel {
	public static void main(String args) {
		
		List<Auto> autos = new ArrayList<Auto>();
		
		autos.add(new Auto("Mercedes", 2007));  
		autos.add(new Auto("Audi A8", 2010));  
		
		Collections.sort(autos);
		
		for (Auto a : autos) {
			System.out.println(a);
		}
	}
}

Die for-Schleife gibt die Liste wie folgt sortiert aus:

Audi A8 (2010)
Mercedes (2007)

So kann jede eigene Klasse sortiert werden. Implementiert die eigene Klasse das Interface Comparable können die Objekte auch in sortierte Collections wie TreeSet oder TreeMap eingefügt werden.

Was aber, wenn die Klasse nach unterschiedlichen Feldern sortiert werden muss? Hier kommt das Interface Comparator ins Spiel.

Der aufmerksame Leser wird bemerkt haben, dass mit Comparable nur ein Feld der eigenen Klasse sortiert werden kann. Dies, weil die Methodensignatur compareTo(Object anotherObject) lautet und sich der Vergleich mit this d.h. mit dem eigenen Objekt durchgeführt werden muss. Der return Wert von

return this.marke.compareTo(auto.getMarke())

ist nagativ falls this.marke < auto.getMarke()
0 falls this.marke = auto.getMarke()
oder positiv falls this.marke > auto.getMarke()

Statt einer aufsteigenden kann man eine absteigende Sortierung durchführen, wenn man zuerst das auto.getMarke() mit this.marke vergleicht.

Nun zum eigentlichen Thema. Nehmen wir an, wir möchten nach Automarke oder nach Inverkehrsetzung sortieren. Hierzu braucht die Klasse Auto nicht mehr das Interface Comparable zu implementieren. Damit wir ausserhalb der Klasse Auto auf das Feld inv zugreifen können, fügen wir der Klasse Auto zuerst eine Gettermethode getInv() hinzu. Ebenfalls wurde die Methode toString() überschrieben, so dass beim Aufruf die Fahrzeugmarke sowie das Jahr der Inverkehrssetzung in Klammern zurückgeliefert wird.

public class Auto {
	private String marke;
	private int inv;
	
	public Auto(String m, int i) {
		this.marke = m;
		this.inv = i;
	}

	public String getMarke() {
		return this.marke;
	}
	
	public int getInv() {
		return this.inv;
	}
	
	public String toString() {
		return this.marke + " (" + this.inv + ")";  
	}
}

Wo wird nun gesagt, wie sortiert werden soll? Hierzu definieren wir eine eigene Klasse, welche das Interface Comparator implementiert. Die erste Klasse soll nach Marke sortieren, also erstellen wir eine neue Klasse SortMarke:

import java.util.Comparator;

public class SortMarke implements Comparator<Auto>{

	@Override
	public int compare(Auto a1, Auto a2) {
		return a1.getMarke().compareTo(a2.getMarke());
	}
}

Im Code sieht man den Unterschied zwischen den Methodensignaturen vom compareTo und compare. Compare hat zwei Argumente des Typs Objekt. Der Vergleich erfolgt nicht mehr zwischen this und einem anderen Objekt, sondern im obigen Fall zwischen a1 und a2. Für die Sortierung nach dem Jahr der Inverkehrssetzung kann man folgende Klasse verwenden:

import java.util.Comparator;

public class SortInv implements Comparator<Auto>{

	@Override
	public int compare(Auto a1, Auto a2) {
		return a1.getInv() - a2.getInv();
	}
}

Nach dem Return wird hier nicht mehr mit compareTo verglichen, sondern die Zahl von a2 von a1 substrahiert. Dies ergibt dasselbe Ergebnis wie oben gezeigt: falls a1.getInv() < f2.getInv() dann gebe ein negativer Wert zurück etc.

Die Sortierung nach beliebigen Feldern hat Programmieraufwand verursacht, dafür ist der Aufruf ziemlich einfach. Das folgende Programm implementiert die Methode main(), erzeugt zwei Fahrzeuge, sortiert nach Marke und gibt die Ergebnisse aus, sortiert nach Jahr der Inverkehrssetzung und gibt die Ergebnisse aus:

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

public class AutoListeBeispiel {
	public static void main(String args) {
		
		List<Auto> autos = new ArrayList<Auto>();
		
		autos.add(new Auto("Mercedes", 2007));  
		autos.add(new Auto("Audi A8", 2010));  
		
		Collections.sort(autos, new SortMarke());
		
		System.out.println("Sortierung nach Fahrzeugmarke:");  
		for (Auto a : autos) {
			System.out.println(a);
		}
		
		Collections.sort(autos, new SortInv());
		
		System.out.println("\nSortierung nach Jahr der Inverkehrssetzung:");  
		for (Auto a : autos) {
			System.out.println(a);
		}
	}
}

Da nun die Klasse Auto nicht mehr sich selbst sortiert, muss man beim Aufruf von Collections.sort() ein Objekt des Typs Comparator mitgeben. Dies wird im ersten Aufruf mit new SortMarke() und beim zweiten Aufruf mit SortInv() gewährleistet. Und der Output sieht wie folgt aus:

Sortierung nach Fahrzeugmarke:
Audi A8 (2010)
Mercedes (2007)

Sortierung nach Jahr der Inverkehrssetzung:
Mercedes (2007)
Audi A8 (2010)

Der Quellcode kann mit wenig Aufwand aus diesem Beitrag kopiert und kompiliert werden. Falls der Quellcode und die kompilierten Klassen gewünscht werden, bitte Nachricht an mich. Beim Vorliegen der kompilierten Klassen kann das Beispiel mit

java AutoListeBeispiel

gestartet werden. Bitte auf Gross- bzw. Kleinschreibung achten, da Java in Groß-/Kleinschreibung unterscheidet!