15. díl - Diář s databází v Javě

V minulé lekci, Datum a čas v Javě 8 - Parsování a porovnávání, jsme si představili ArrayList. Víme, že nám oproti poli umožňuje přidávat nové prvky za běhu programu a nemusíme se starat o jeho velikost. V dnešním tutoriálu si do ArrayListu zkusíme uložit objekty.

Prvně jsem chtěl udělat databázi uživatelů, ale uživatele jsme tu již několikrát měli. Jelikož jsme se nedávno naučili datum a čas, naprogramujeme si diář. Do databáze budeme ukládat jednotlivé záznamy a vždy vypíšeme ten dnešní a zítřejší. Databáze to nebude samozřejmě ta v tom pravém slova smyslu (na to ještě nemáme zkušenosti), ale bude se jednat právě o ArrayList v operační paměti počítače. Bude umožňovat záznamy přidávat, hledat je podle data a mazat podle data a času. Založte si nový projekt, který nepojmenujeme Diar (budeme toto jméno potřebovat pro třídu) ale např. Poznamkovac, to bude jméno naší výsledné aplikace.

Záznam

Prvně si udělejme třídu, jejíž instance budeme ukládat. Nazvěme ji Zaznam. Záznam v diáři se bude vázat k nějakému datu a času. Také bude obsahovat nějaký text. Např.: 12. ledna 2013 - Vyvenčit psa. To je asi vše, třída může vypadat takto:

import java.util.Calendar;

public class Zaznam {
    private Calendar datumCas;
    private String text;

    public Zaznam (Calendar datumCas, String text) {
        this.datumCas = datumCas;
        this.text = text;
    }

    public Calendar getDatumCas() {
        return datumCas;
    }

    public void setDatumCas(Calendar datumCas) {
        this.datumCas = datumCas;
    }

    public String getText() {
        return text;
    }

    public void setText(String text) {
        this.text = text;
    }

    @Override
    public String toString() {
        return datumCas + " " + text;
    }

}

Třída v podstatě slouží jen k záznamu dat a nemá žádné metody (až na konstruktor a ToString() a nějaké ty gettery/settery). Funkcionalitu jako takovou ale nenabízí. Bystřejší si jistě všimli, že metoda toString() nijak neformátuje datum a čas. K tomu se později ještě vrátíme.

Databáze

Protože program bude o něco složitější, rozdělíme ho do více objektů (vrstev). Záznam máme, nyní si vytvoříme objekt Databaze, ve které budou záznamy uloženy. Opět bude mít privátní ArrayList, jako měl Losovac. Ten bude nyní typu Zaznam. Diář bude umožňovat záznamy přidávat, mazat a vyhledávat podle data. K projektu tedy přidáme třídu Databaze. Bude velmi podobná minulému Losovači:

import java.util.ArrayList;

public class Databaze {

    private ArrayList<Zaznam> zaznamy;

    public Databaze() {
        zaznamy = new ArrayList<>();
    }

}

Všimněte si použití "diamond operátoru" při vytváření nové instance ArrayListu. Od Javy 7 nemusíme generický typ uvádět 2x, ale stačí ho uvést pouze při deklaraci proměnné a špičaté závorky můžeme podruhé již ponechat prázdné. Také si řekněme, že kdybychom špičaté závorky nenapsali vůbec a ArrayList deklarovali i inicializovali bez uvedení generického typu, položky by se ukládaly jako typ Object. Mseli bychom je vždy na naše Záznamy ručně převádět, dále v seriálu si ukážeme jak by se to dělalo a listy ještě potom potkáte u kolekcí.

Třída Zaznam tedy slouží pouze pro manipulaci s daty. Obsahuje vnitřní kolekci zaznamy, ta se inicializuje v konstruktoru. Mohli bychom použít i inicializaci bez konstruktoru přímo u deklarace ve formě:

private ArrayList<Zaznam> zaznamy = new ArrayList<>();

Dodejme třídě metody pro přidání, vymazání a vyhledání záznamu.

Přidání záznamu by mělo být jasné:

public void pridejZaznam(Calendar datumCas, String text) {
        zaznamy.add(new Zaznam(datumCas, text));
}

Jako druhou metodu přidejme nalezení záznamů v daný den. Metoda bude vracet ArrayList nalezených záznamů, protože jich pro ten den může být v databázi více. Záznamy budeme moci vyhledávat podle data i času nebo jen podle data. Můžeme tak najít záznamy v konkrétní den bez ohledu na to, v jakou jsou hodinu. Podle čeho budeme chtít vyhledávat bude udávat parametr dleCasu typu boolean. Pokud bude false, hledáme jen podle data bez ohledu na čas. ArrayList si nejprve vytvoříme a poté do něj přidáváme záznamy, které odpovídají hledanému datu. Odpovídat musí buď celé datum a čas (pokud hledáme i podle času) nebo jen den, měsíc a rok (pokud hledáme jen podle data). Naplněný ArrayList s nalezenými záznamy vrátíme.

public ArrayList<Zaznam> najdiZaznamy(Calendar datum, boolean dleCasu) {
        ArrayList<Zaznam> nalezene = new ArrayList<>();
        for (Zaznam z : zaznamy) {
                if (((dleCasu) && (z.getDatumCas().equals(datum))) // dle času a data
                        ||
                ((!dleCasu) && // pouze dle data
                        (z.getDatumCas().get(Calendar.DAY_OF_MONTH) == datum.get(Calendar.DAY_OF_MONTH)) &&
                        (z.getDatumCas().get(Calendar.MONTH) == datum.get(Calendar.MONTH))) &&
                        (z.getDatumCas().get(Calendar.YEAR) == datum.get(Calendar.YEAR))
                )
                   nalezene.add(z);
        }
        return nalezene;
}

Nakonec přidáme vymazání záznamů v určitou dobu. To provedeme pomocí metody najdiZaznamy() a nalezené záznamy jednoduše proiterujeme a z ArrayListu odstraníme. Budeme mazat podle přesného data i času, 2. parametr u metody najdiZaznamy() bude tedy true:

public void vymazZaznamy(Calendar datum) {
        ArrayList<Zaznam> nalezeno = najdiZaznamy(datum, true);
        for (Zaznam z : nalezeno) {
                zaznamy.remove(z);
        }
}

Diář

Nyní si přidáme k projektu poslední třídu, bude to samotný diář. Nazvěme ji Diar. Ten již bude obsahovat metody pro komunikaci s uživatelem. Všimněte si, jak aplikaci rozdělujeme a jednotlivé její části zapouzdřujeme. ArrayList je zapouzdřen v databázi, která nad ním postavila další metody pro bezpečnou manipulaci s jeho obsahem. Samotnou databázi nyní vložíme do diáře. Tím oddělíme logiku a práci s daty od komunikace s uživatelem a dalšími vstupy/výstupy programu. Třída Diar tedy bude komunikovat s uživatelem a data od něj předá databázi.

Přidejme si privátní instanci databáze, kterou si vytvoříme v konstruktoru. Podobně přidejme i instanci Scanneru, kterou budeme ve třídě potřebovat:

import java.util.Scanner;

public class Diar {

        private Databaze databaze;
        private Scanner sc = new Scanner(System.in, "Windows-1250");

        public Diar() {
                databaze = new Databaze();
        }

}

Třídu Diar dokončíme v příští lekci, Diář s databází v Javě (dokončení), spolu se zprovozněním celé aplikace.