Programowanie w Javie- wykład 12 Kolekcje (zbiory)

1 Programowanie w Javie- wykład 12 Kolekcje (zbiory) Treści prezentowane w wykładzie zostały oparte o: Barteczko, JAVA Programowanie praktyczne od podstaw, PWN, 2014 Barteczko, JAVA Uniwersalne techniki programowania, PWN, 2017 http://docs.oracle.com/javase/8/docs/ http://docs.oracle.com/javase/9/docs/ C. S. Horstmann, G. Cornell, Java. Podstawy, Helion, Gliwice 2013

Podstawowe interfejsy JCF Collection - dowolna kolekcja nie będącą mapą List - zestaw elementów, z których każdy znajduje się na określonej pozycji; do listy można wielokrotnie dodać ten sam element i można sięgnąć po element na dowolnej pozycji. Queue - kolejka, czyli sekwencja elementów, do której dodawanie i sięganie po elementy odbywa się na pozycjach, określonych przez zadany porządek (najczęsciej FIFO - first in first out). Nie ma bezpośredniego dostępu do dowolnej pozycji. Deque - rozszerza Queue: kolejka podwójna, do której dodawanie i sięganie może odbywać się na obu końcach (np. dodaj na początku, dodaj na końcu, usuń z początku, usuń z końca). Set - zestaw niepowtarzających się elementów, pozycje elementów są nieokreślone. SortedSet - rozszerza Set: zbiór uporządkowany NavigableSet - rozszerza SortedSet: zbiór uporządkowany, dla którego możliwe są operacje uzyskiwania elementów "bliskich" danemu. Map mapa (tablica asocjacyjna, słownik) - zestaw par: klucz-wartość, przy czym odwzorowanie kluczy w wartości jest jednoznaczne SortedMap - mapa z uporządkowanymi kluczami (typu SortedSet) NavigableMap - mapa, w której klucze są typu NavigableSet 2

Wybrane podstawowe konkretne implementacje Implementowany interfejs Implementujące klasy Sposób realizacji właściwości określanych przez interfejs List ArrayList Dynamicznie rozszerzalna tablica (szybki bezpośredni dostęp po indeksach) List, Queue, Deque LinkedList Lista liniowa z podwójnymi dowiązaniami (szybkie wpisywanie i usuwanie elementów poza końcem listy; wolny dostęp bezpośredni; implementacja operacji na kolejkach) Queue, Deque ArrayDeque Kolejka podwójna (zrealizowana jako rozszerzalna tablica; szybki dostęp do obu końców, brak dostępu do dowolnej pozycji) Queue PriorityQueue Kolejka z priorytetami (kolejka, w której pierwszy i ostatni elment jest określany na podstawie ustalonego porządku (porównania elmentów wg kryteriów) ) Set HashSet Tablica haszująca (mieszania) (szybkie wpisywanie (add) i odnajdywanie elementów(contains); kolejność elementów nieokreślona) Set, SortedSet, NavigableSet TreeSet Drzewo czerwono-czarne, szybkie wstawianie, (uporządkowanie elementów; dostęp i wyszukiwanie wolniejsze niż w implementacji mieszającej) Set LinkedHashSet Tablica mieszania i lista liniowa (jak w implememntacji mieszającej, z zachowaniem porządku wpisywania elementów) 3

Zbiory (interfejs Set) 4 Zbiór jest kolekcją, reprezentującą zestaw niepowtarzających się elementów. W zbiorze elementy nie mają pozycji. Nie jest możliwy dostęp do elementów zbioru po indeksach. O elemencie zbioru można zatem powiedzieć jedynie, czy należy do zbioru (w jednym egzemplarzu), czy nie. Zatem zbiór posiada, odmienną niż lista, semantykę: nie zachowuje kolejności elementów, natomiast wyklucza istnienie duplikatów. Interfejs Set nie definiuje żadnych nowych metod w porównaniu do interfejsu Collection. Jedyne uszczegółowienie polega na tym, że w przypadku zbiorów, metody dodające elementy do zbiorów zwracają wartość false, jeśli dodawane elementy już w zbiorze występują. Podobnie, jak w przypadku listy, zbiór posiada w JDK kilka gotowych implementacji. Jedną z nich jest HashSet, w którym unikatowość elementów jest zapewniona przez zastosowanie tablicy haszującej (mieszającej); natomiast w przypadku klasy TreeSet poprzez wyszukiwanie binarne z użyciem drzewa czerwono-czarnego (drzewo dwukolorowe).

Zbiory - HashSet 5 Przykład. Zauważmy, że jeśli w pliku firm dwa razy powtórzono tę samą nazwę, to co zrobić, jeśli chcemy mieć wynikowy zestaw firm bez powtórzeń nazw? Oczywiście, można własnoręcznie oprogramować sprawdzanie elementów zestawu i usuwać z niego duplikaty. Ale po co, jeśli istnieje prostszy sposób - zastosowanie kolekcji typu zbiór. Możemy np. użyć konkretnej klasy realizującej koncepcję zbioru nieuporządkowanego - klasy HashSet. Zwróćmy uwagę, że: w zbiorze elementy nie mają pozycji. Przy przeglądaniu możemy zatem zastosować wyłącznie iterator (dostęp "po indeksach" nie jest możliwy). porządek iterowania (przeglądania) zbioru nie jest określony (kolejność wyprowadzonych wyników może być inna niż kolejność firm w pliku).

Zbiory - HashSet - przykład 6 class Intro2 { public static void main(string args[]) throws IOException { Scanner scan = new Scanner(new File("firms.txt")); // Utworzenie obiektu klasy HashSet // z parametrem typu <String> Set<String> set = new HashSet<>(); while (scan.hasnextline()) { String firm = scan.nextline(); // dodanie kolejnego elementu do zbioru set.add(firm); // wyprowadzenie zawartości zbioru for (String elt : set) System.out.println(elt);

Zbiory - TreeSet Przykład. Co zrobić, jeśli od naszego programu wymagane jest wyprowadzenie uporządkowanego zestawu firm np. w alfabetycznym porządku? Możemy zastosować kolekcję stanowiącą zbiór uporządkowany. W zbiorze uporządkowanym kolejność przeglądania jego elementów za pomocą iteratora jest określona (np. w rosnącym porządku alfabetycznym nazw firm, będących elementami zbioru). Konkretną realizacją zbioru uporządkowanego jest w Javie klasa TreeSet. import java.util.*; import java.io.*; class Intro3 { public static void main(string args[]) throws IOException { Scanner scan = new Scanner(new File("firms.txt")); TreeSet<String> set = new TreeSet<>(); while (scan.hasnextline()){ set.add(scan.nextline()); for (String elt : set) System.out.println(elt); 7

Zbiory - HashSet Tablica mieszająca (haszująca - ang. hashtable) jest strukturą danych specjalnie przystosowaną do szybkiego odnajdywania elementów. Dla każdego elementu danych wyliczany jest kod numeryczny (liczba całkowita) nazywany kodem mieszania (hashcode), na podstawie którego obliczany jest indeks w tablicy, pod którym będzie umieszczony dany element. Może się zdarzyć, że kilka elementów otrzyma ten sam indeks, zatem elementy tablicy mieszającej stanowią listy, na których znajdują się elementy danych o takim samym indeksie, wyliczonym na podstawie ich kodów mieszania. Każda lista - element tablicy mieszania nazywa się kubełkiem (bucket). Aby umieścić nowy element w tablicy mieszania, wyliczany jest jego hashcode, po czym na podstawie jego wartości obliczany jest indeks w tablicy mieszania. Indeks taki stanowi resztę z dzielenia wartości kodu mieszania przez liczbę kubełków. Element umieszczany jest w kubełku pod tym indeksem. Istotne jest w tej procedurze, by: wyliczanie kodu mieszania było szybkie, kody mieszania dla rożnych elementów zależały tylko od ich wartości i były (możliwie) różne dla różnych wartości elementów, wynikowe indeksy dawały możliwie równomierną dystrybucję elementów danych po elementach tablicy mieszania. 8

Zbiory - hashtable W Javie można wyliczyć kod mieszania dla każdego obiektu za pomocą zastosowania metody hashcode(). Metoda ta, zdefiniowana w klasie Object, daje - ogólnie - jako wynik adresy obiektów. To, oczywiście, nie jest zbyt użyteczne, bowiem nie bierze pod uwagę zawartości obiektów (wszystkie obiekty mają rożne kody mieszania). Ale w standardowych klasach Javy metoda hashcode() została przedefiniowana, tak, by zwracała kod na podstawie "treści" obiektu, np. napisu stanowiącego "zawartość" obiektu klasy String. Dwa takie same napisy będą miały te same kody mieszania. Wyszukanie elementu w tablicy mieszania jest bardzo efektywne. Wystarczy obliczyć indeks tablicy na podstawie kodu mieszania szukanego elementu i jeżeli w danym kubełku jest tylko jeden element, to - nawet nie wykonując żadnych porównań - zwrócić ten element (lub wartość true - że jest). Jeżeli w kubełku jest kilka elementów, to musimy wykonać ich porównanie z szukanym elementem (equals(...)), ale i tak liczba porównań będzie zwykle bardzo niewielka w stosunku do liniowego czy nawet binarnego wyszukiwania. Klasa HashSet wykonuje to np. przy wywołaniu metod add(obiekt), remove(obiekt). Oprócz wyliczania kodów mieszania do prawidłowego dodawania i odnajdywania elementów potrzebne jest odpowiednie zdefiniowanie metody equals(), porównującej "treść" dwóch obiektów. 9

Zbiory HashSet 10 Jeżeli prawdziwe jest a.equals(b), to musi być spełniony warunek a.hashcode() == b.hashcode(). Zarówno hashcode() jak i equals() są dobrze zdefiniowane w standardowych klasach Javy, natomiast tworząc własne klasy musimy sami zadbać o właściwe ich zdefiniowanie. Należy pamiętać, że przedefiniowujemy metodę equals z klasy Object. A tam jej parametrem jest Object. Użycie innego typu parametru prowadzi do przeciążenia (a nie przedefiniowania) metody i uniemożliwia polimorficzne do niej odwołania. Metodę hashcode definiujemy w klasie jako: public int hashcode() { //obliczenie kodu mieszania na podstawie wartości pól klasy //dla pól obiektowych użyjemy metody hashcode() z ich klas Środowiska uruchomieniowe IDE (m.in. IntelliJ, NetBeans) dają możliwość automatycznej generacji kodów metod hashcode() i equals() poprzez wybór opcji z menu. Porządek elementów kolekcji HashSet nie jest określony. Klasa LinkedHashSet, dziedzicząc klasę HashSet udostępnia wygodną często właściwość: zachowania porządku, w jakim elementy dodane były do zbioru.

Zbiory TreeSet Inna podstawowa implementacja koncepcji zbioru - klasa TreeSet, opiera się na strukturze danych zwanej drzewem czerwono-czarnym. Dla potrzeb korzystania z klasy TreeSet wystarczy wiedzieć, że zapewnia ona szczególne uporządkowanie elementów zbioru, które pozwala szybko odnajdywać w nim podany element. Klasa TreeSet realizuje nie tylko koncepcję zbioru "w ogóle", ale również zbioru uporządkowanego, implementując interfejs SortedSet (ściślej NavigableSet), który rozszerza interfejs Set. Widzieliśmy już jak iterowanie po TreeSet zwraca elementy w porządku rosnącym. Np. poniższy fragment: String[] s = {"ala", "pies", "kot"; Set<String> set = new TreeSet<>(); for (int i=0; i < s.length; i++) set.add(s[i]); System.out.println(set.toString()); wypisze: [ala, kot, pies] Do zbiorów należy dodawać tylko referencje do obiektów niemodyfikowalnych, w przeciwnym razie zbiór może stracić spójność po ewentualnej zmianie zawartości obiektu (może zawierać identyczne obiekty) 11

Kolekcje przykład proste sortowanie TreeSet zapewnia uporządkowanie elementów kolekcji, ale usuwa duplikaty. Co zrobić, jeśli chcemy duplikaty zachować i posortować kolekcję? Zachowanie duplikatów zapewnia lista (np. ArrayList). Możemy wobec niej zastosowac gotowy algorytm sortowania zapisany w postaci statycznej metody klasy Collections (klasa ta zawiera metody realizujące rózne algorytmy działania na kolekcjach). import java.util.*; import java.io.*; class Intro4 { public static void main(string args[]) throws IOException { Scanner scan = new Scanner(new File("firms.txt")); ArrayList<String> list = new ArrayList<>(); while (scan.hasnextline()){ list.add(scan.nextline()); Collections.sort(list); for (String firm : list) { System.out.println(firm); //wyprowadzi firmy w rosnącym alfabetycznym porządku ich nazw 12

Porównywanie obiektów 13 Dodawanie elementów do zbiorów uporządkowanych (np. TreeSet), iterowanie po kolekcjach uporządkowanych, pobieranie elementów z kolejek z priorytetami, a także sortowanie kolekcji i tablic algorytmami kolekcyjnymi odbywa się w oparciu o: naturalny porządek obiektów, lub reguły porównywania obiektów określane przez komparator - obiekt klasy implementującej interfejs Comparator. Naturalny porządek określany jest przez implementację interfejsu Comparable<T> w klasie obiektów i dostarczenie definicji metody compareto tego interfejsu, porównującej dwa obiekty typu T. Metoda compareto ma następującą sygnaturę: public int compareto(t otherobject) gdzie T jest typem obiektu, i zwraca: liczbę < 0, jeżeli ten obiekt (this) znajduje się (w porządku) przed obiektem otherobject, liczbę > 0, jeżeli ten obiekt (this) znajduje się (w porządku) po obiekcie otherobject, 0, jeśli obiekty są takie same.

Porównywanie obiektów Wiele standardowych klas Javy implementuje interfejs Comparable (np. klasa String, Date, klasy opakowujące typy proste). We własnych klasach musimy o to zadbać sami. Zatem, każda nasza klasa, której obiekty mogą być elementami kolekcji uporządkowanych powinna określać naturalny porządek swoich obiektów. Np. w klasie Worker moglibyśmy ustalić, że naturalną kolejnością obiektów jest alfabetyczna kolejność nazwisk w porządku rosnącym poprzez dostarczenie definicji metody compareto: class Worker implements Comparable<Worker> { private String lname; private String fname; private int salary; //... public int compareto(worker other) { int res = lname.compareto(other.lname); if(res==0) res = fname.compareto(other.fname) return res; public String tostring() { return fname + " " + lname + " " + salary; 14

Porównywanie obiektów Po wykorzystaniu powyższej klasy w poniższym fragmencie: Worker[] p = { new Worker("Jan", "Kowalski", 2000), new Worker("Jan", "Malinowski", 2200), new Worker("Jan", "Kowalski", 2400), new Worker("Jan", "Kowalewski", 3000), ; Set<Osoba> set = new TreeSet<>(); for (Worker w : p) set.add(w); System.out.println(set); otrzymamy (naturalnie) uporządkowany wynik: [Jan Kowalewski 3000, Jan Kowalski 2000, Jan Malinowski 2200] 15

Porównywanie obiektów - komparator 16 Aby uzyskać zbiory uporządkowane według różnych kryteriów, np. według nazwisk lub według pensji, albo porządek odwrotny (np. w malejącym alfabetycznym porządku nazwisk) należy skorzystać z komparatora. Komparator jest obiektem porównującym inne obiekty. Komparatory w Javie są realizowane jako obiekty klas implementujących interfejs Comparator<T>, gdzie T jest typem porównywanych obiektów Interfejs ten zawiera metodę: int compare(t o1, T o2) której implementacja winna porównywać dwa swoje argumenty i zwracać: wynik 0 jeśli oba obiekty są równe, liczbę mniejszą od 0, jeśli o1 jest "mniejszy" od o2 liczbę większą od 0, jeśli o1 jest "większy" od o2. Obiekt komparator może być podany jako argument konstruktora klasy TreeSet (wtedy to on, a nie naturalny porządek, decyduje o sposobie wpisywania elementów do zbioru), może rownież występować jako argument metod sortowania z klasy Collections i Arrays, konstruktorów klasy PriorityQueue oraz konstruktorów innych kolekcji uporządkowanych (np. TreeMap). Specjalny komparator, odwracający naturalny porządek, uzyskiwany jest za pomocą statycznej metody klasy Collections - Collections.reverseOrder().

Porównywanie obiektów - przykład 17 import java.util.*; class Worker implements Comparable<Worker> { private String lname; private String fname; private int salary; public Worker(String fn, String ln, int sal) { lname = ln; fname = fn; salary = sal; public int getsalary() { return salary; public int compareto(worker other) { int res = lname.compareto(other.lname); if(res==0) res = fname.compareto(other.fname); return res; public String tostring() { return fname + " " + lname + " " + salary;

Porównywanie obiektów - przykład 18 public class TestKomparator { public static void main(string args[]) { Worker[] workers = { new Worker("Jan", "Kowalski", 2000), new Worker("Jan", "Malinowski", 2200), new Worker("Jan", "Kowalski", 2400), new Worker("Jan", "Kowalewski", 3000), new Worker("Stefan", "Zwierz", 3000), ; // Zbiór uporządkowany wg porządku naturalnego //(rosnąca kolejność nazwisk) Set<Worker> set = new TreeSet<>(); for (Worker w : workers) set.add(w); System.out.println(set); //[Jan Kowalewski 3000, Jan Kowalski 2000, // Jan Malinowski 2200, Stefan Zwierz 3000]

Porównywanie obiektów - przykład 19 // Zbiór uporządkowany wg rosnących pensji Set<Worker> set2 = new TreeSet<>( new Comparator<Worker>() { public int compare(worker o1, Worker o2) { // różnica pensji wystarczy do porownania: return o1.getsalary() - o2.getsalary(); ); for (Worker w : workers) set2.add(w); System.out.println(set2); //[Jan Kowalski 2000, Jan Malinowski 2200, // Jan Kowalski 2400, Jan Kowalewski 3000] // Zbiór uporządkowany w malejącym porządku naturalnym //(malejące nazwiska) Set<Worker> set3 = new TreeSet<>(Collections.reverseOrder()); for (Worker w : workers) set3.add(w); System.out.println(set3); //[Stefan Zwierz 3000, Jan Malinowski 2200, //Jan Kowalski 2000, Jan Kowalewski 3000]

Porównywanie obiektów 20 W powyższym przykładzie w klasie Worker nie definiowaliśmy metody equals() ani hashcode(), gdyż TreeSet ich nie potrzebuje. Zwróćmy uwagę, że komparator przesądza nie tylko o kolejności iterowania po zbiorze, ale również o tym, czy obiekty uznawane są za różne i czy wobec tego mogą stanowić elementy zbioru (przykład z powtórzeniem nazwiska Jan Kowalski i utrata Stefana Zwierza, gdy komparator porównywał pensje), Należy pamiętać, że: Operacje na zbiorze HashSet używają (i wymagają) metod hashcode() i equals(), a dodawanie i wyszukiwanie elementów odbywa się w oparciu o wyniki metody equals(). Operacje na zbiorze TreeSet odbywają się w oparciu o wyniki metody compareto() lub metody compare() komparatora. Oczywiście, nasze klasy powinny być przygotowane do tego, że ich obiekty mogą znaleźć się w zbiorach typu HashSet albo TreeSet, zatem powinny definiować wszystkie wspomniane metody. A do tego w sposob spójny: jeśli equals zwraca true, to compareto winno zwracać zero, a hashcode te same wartości dla obu porównywanych obiektów.

Porównywanie obiektów Warto zauważyć, że dla zbiorów uporządkowanych (naturalnie lub za pomocą komparatora) dostępna jest możliwość uzyskiwania "pierwszego" lub "ostatniego" (w zdefiniowanym porządku) elementu, a także podzbiorów, które zawierają elementy "od" - "do" (w zdefiniowanym porządku). Służą temu metody interfejsu SortedSet (pośrednio implementowanego przez TreeSet) m.in. headset(), tailset() i subset(), Interfejs NavigableSet bezpośrednio implementowany przez TreeSet dostarcza dodatkowych metod m.in. higher(e e), lower(e e), ceiling(e e), floor(e e), które pozwalają uzyskiwać elmenty "bliskie" względem danego porządku. Uwaga. Implementacja metody compareto w klasie String nie uwzględnia właściwego porządku napisów w różnych językach. Aby właściwie sortować napisy należy użyć kolatora (pobieramy go statyczną metodą Collator.getInstance()), który implementuje interfejs Comparator i jest specjalnym komparatorem uwzględniającym lokalizację (regionalne ustawienia językowe). List<String> polskie = Arrays.asList("z", "ę", "ź", "a", "ą"); Collections.sort(polskie, Collator.getInstance(new Locale("pl"))); // od Javy 8 mamy metodę sort również w interfejsie List : //list.sort(new Comparator<T>() {..) 21

Przetwarzanie list i zbiorów - przykłady Zmiana wartości elementów listy. Do każdego elementu listy firm (zmienna list), dodać przyrostek "-Polska". List<String> list = new ArrayList<>( Arrays.asList(new String[]{"Opel", "Fiat", "Audi")); for (int i=0; i<list.size(); i++) list.set(i, list.get(i) + " - Polska"); System.out.println(list); lub za pomocą iteratora listowego for (ListIterator<String> it = list.listiterator(); it.hasnext(); ) it.set(it.next() + " - Polska"); System.out.println(list); Usunięcie podanego obiektu z kolekcji. Usuniemy Opel z listy firm list. System.out.println("Przed: " + list); list.remove("opel"); System.out.println("Po: " + list); remove(ref) usuwa tylko pierwszy element, który został znaleziony ten sposób działa dla dowolnych modyfikowalnych kolekcji Można też usuwać element o podanym indeksie np. list.remove(3); W przypadku błędnego indeksu - IndexOutOfBoundsException 22

Przetwarzanie list i zbiorów - przykłady 23 Usuwanie za pomocą metody remove() iteratora System.out.println("Przed: " + list); for (Iterator<String> it = list.iterator(); it.hasnext();){ if(it.next().equals("opel")) it.remove(); System.out.println("Po: " + list); Ten sposób działa dla dowolnych modyfikowalnych kolekcji Operacje grupowe (bulk-operations) Metody addall(), removeall(), retainall(), to operacje grupowe (jednocześnie są wykonywane działania, które musielibyśmy programować za pomocą iteracji i metod contains(), remove(), add()). Zmienna list1 zawiera listę firm wczytanych z pliku, a list2 listę firm z innego pliku. Należy zmienić listę list1 tak, by zawierała dodatkowo, wszystkie te firmy z drugiego pliku, których nie było w pierwszym pliku. Przykładowe rozwiązanie:

Przetwarzanie list i zbiorów - przykłady 24 System.out.println("Na poczatku list1 : " + list1); System.out.println("Na poczatku list2 : " + list2); System.out.println("Usuwamy z list2, te które są na list1"); list2.removeall(list1); System.out.println("Teraz list2 : " + list2); System.out.println("Dodamy list2 do list1" ); list1.addall(list2); System.out.println("Na koncu list1 : " + list1); Gdyby chodziło tylko o podanie nazw firm bez powtórzeń: System.out.println("Dane z dwóch plików: "); System.out.println("list1 : " + list1); System.out.println("list2 : " + list2); HashSet<String> set = new HashSet<>(list1); set.addall(list2); System.out.println("Wynikowy zbiór : " + set);

Przetwarzanie list i zbiorów - przykłady W klasie Collections dostępne są metody statyczne, ułatwiające wykonywanie różnych operacji na kolekcjach. Oprócz wspomnianych wcześniej metod dostępne są dodatkowo metody odwracania list Collections.reverse(lista), wypełniania kolekcji i wiele innych. W trakcie przeglądania kolekcji za pomocą iteratora nie wolno jej modyfikować innymi środkami niż metody stosowanego właśnie do iterowania. Zatem // coll dowolna kolekcja napisów Iterator<String> it1=coll.iterator(); Iterator<String> it2=coll.iterator(); while(it1.hasnext()){ it1.next(); it2.next(); it2.remove(); // BŁĄD FAZY WYKONANIA wyjątek // ConcurrentModificationException Dotyczy to również pętli for-each dla kolekcji (stosowany jest w niej "pod spodem" iterator) for (String e : coll) coll.add(e+"1");//spowoduje ConcurrentModificationException 25