Popis projektu - petrpanek/VedeniKuchyne GitHub Wiki

Vedení kuchyně

Aplikace slouží pro správu receptů, potřebných surovin, skladových zásob, plánování jídel a nákupů surovin.

Název týmu

Senior Java Developers

Seznam členů týmu

  1. Marek Pospíšil
  2. Tibor Vondrášek
  3. Petr Pánek
  4. Štěpán Bartoš

Seznam úkolů

  • vytvoření UseCase modelu ---> Tibor Vondrášek/Marek Pospíšil/Petr Pánek
  • vytvoření ClassDiagramu ---> Petr Pánek
  • návrh databáze ---> Štěpán Bartoš
  • návrh uživatelského prostředí ---> Petr Pánek/Tibor Vondrášek/Marek Pospíšil
  • vytvoření databáze ---> Štěpán Bartoš
  • naplnění databáze testovými daty ---> Štěpán Bartoš
  • implementace databáze - třída DBUtil ---> Petr Pánek
  • implementace tříd Jidelnicek, KnihaReceptu, Sklad ---> Petr Pánek
  • implementace tříd Jidlo, Recept Potravina ---> Marek Pospíšil/Štěpán Bartoš
  • implementace tříd jednotlivých controllerů ---> Tibor Vondrášek/Petr Pánek
  • vytvoření pohledů jednotlivých obrazovek, Scene Builder ---> Tibor Vondrášek/Marek Pospíšil

Použité konvence

  • velké první písmeno u pojmenování tříd
  • konstanty velkými písmeny, odděleny podtržítkem
  • pojmenování interfacu se skládá z "I" + jméno interfacu
  • využívání camelCase notace při pojmenování proměnných a jmen metod
  • v každém souboru pouze jedna třída
  • třída začíná import statementy
  • následně popis třídy v JavaDOC
  • následuje tělo třídy
  • tělo třídy začíná atributy
  • následuje konstruktor třídy
  • následují metody
  • jedna deklarace proměnné na řádek
  • jeden statement na řádek
  • deklarace proměnných na začátku metod
  • viz.: dokumentace

Use Case diagram

Use Case diagram

Přidání receptu

Shrnutí

Uživatel přídá recept.

Výsledek

Recept byl přidán do knihy receptů.

Základní tok

  1. Systém zobrazí knihu receptů.
  2. Kuchař založí nový recept.
  3. Kuchař přidá název receptu.
  4. Kuchař přidá potraviny pro recept.
  5. Kuchař přidá postup receptu.
  6. Kuchař odesílá údaje.
  7. Systém kontroluje údaje.
  8. Systém přidá recept do knihy receptů.

Výjimečný tok

  1. Systém zobrazí knihu receptů.
  2. Kuchař založí nový recept.
  3. Kuchař přidá název receptu.
  4. Kuchař přidá potraviny pro recept.
  5. Kuchař přidá postup receptu.
  6. Kuchař odesílá údaje.
  7. Systém zkontroluje správnost údajů.
  8. Kuchař opravuje údaje.
  9. Kuchařl odesílá údaje.
  10. Systém přidá recept do knihy receptů.

Odebrání receptu

Shrnutí

Odstranění receptu.

Předpoklad

Recept byl vytvořen.

Výsledek

Recept byl odstraněn.

Základní tok

  1. Systém zobrazí knihu receptů.
  2. Kuchař vybere recept.
  3. Kuchař odešle vybraný recept.
  4. Systém odstraní recept.

Výjimečný tok

  1. Systém zobrazí knihu receptů.
  2. Kuchař vybere recept.
  3. Kuchař odešle recept k odstranění.
  4. Systém nenajde recept.

Úprava receptu

Shrnutí

Byl upraven recept.

Předpoklad

Recept byl vytvořen.

Výsledek

Recept byl upraven.

Základní tok

  1. Systém zobrazí knihu receptů.
  2. Kuchař vybere recept.
  3. Systém zobrazí údaje receptu.
  4. Kuchař upraví údaje.
  5. Kuchař odešle údaje.
  6. Systém zkontroluje správnost údajů.
  7. Systém smaže staré údaje.
  8. Systém přidá upravený recept do knihy receptů.

Výjimečný tok

  1. Systém zobrazí knihu receptů.
  2. Kuchař vybere recept.
  3. Systém zobrazí údaje receptu.
  4. Kuchař upraví údaje.
  5. Kuchař odešle údaje.
  6. Systém zkontroluje správnost údajů.
  7. Kuchař opravuje údaje.
  8. Kuchařl odesílá údaje.
  9. Systém přidá recept do knihy receptů.

Přidání potraviny

Shrnutí

Přidání potraviny na sklad.

Výsledek

Přidána nová potravina na sklad.

Základní tok

  1. Systém zobrazí položky na skladě.
  2. Kuchař založí novou položku.
  3. Kuchař přidá název potraviny.
  4. Kuchař přidá mnošství potraviny.
  5. Kuchař odesílá údaje.
  6. Systém zkontroluje správnost údajů.
  7. Systém přidá potravinu na sklad.

Výjimečný tok

  1. Systém zobrazí položky na skladě.
  2. Kuchař založí novou položku.
  3. Kuchař přidá název potraviny.
  4. Kuchař přidá mnošství potraviny.
  5. Kuchař odesílá údaje.
  6. Systém zkontroluje správnost údajů.
  7. Kuchař opravuje údaje.
  8. Kuchařl odesílá údaje.
  9. Systém přidá potravinu na sklad.

Odebrání potraviny

Shrnutí

Odstraní potravinu ze skladu.

Podmínka

Potravina byla přidána na sklad.

Výsledek

Potravina je odstraněna ze skladu.

Základní tok

  1. Systém zobrazí potraviny na skladě.
  2. Kuchař vybere potravinu k odstranění.
  3. Kuchař zadá počet.
  4. Kuchař odešle údaje.
  5. Systém zkontroluje údaje.
  6. Systém odstraní potravinu ze skladu.

Výjimečný tok

  1. Systém zobrazí potraviny na skladě.
  2. Kuchař vybere potravinu k odstranění.
  3. Kuchař zadá počet.
  4. Kuchař odešle údaje.
  5. Systém zkontroluje údaje.
  6. Kuchař opraví údaje.
  7. Kuchař odešle údaje.
  8. Systém odstraní potravinu ze skladu.

Úprava potraviny

Shrnutí

Úprava potraviny.

Podmínka

Potravina byla přidána na sklad.

Výsledek

Potravina je upravena.

Základní tok

  1. Systém zobrazí potraviny na skladě.
  2. Kuchař vybere potravinu.
  3. Systém zobrazí údaje.
  4. Kuchař upraví údaje.
  5. Kuchař odešle údaje.
  6. Systém zkontroluje údaje.
  7. Systém smaže staré údaje.
  8. Systém přidá upravenou potravinu na sklad.

Výjimečný tok

  1. Systém zobrazí potraviny na skladě.
  2. Kuchař vybere potravinu.
  3. Systém zobrazí údaje.
  4. Kuchař upraví údaje.
  5. Kuchař odešle údaje.
  6. Systém zkontroluje údaje.
  7. Kuchař upravuje údaje.
  8. Kuchař odesílá údaje.
  9. Systém smaže staré údaje.
  10. Systém přidá upravenou potravinu na sklad.

Přidání jídla

Shrnutí

Přidání jídla do plánu.

Podmínka

Byl vytvořen recept.

Výsledek

Přidáno jídlo do plánu.

Základní tok

  1. Systém zobrazí plán jídel.
  2. Kuchař založí nové jídlo.
  3. Kuchař přidá název jídla.
  4. Kuchař přidá čas.
  5. Kuchař přidá recept.
  6. Kuchař odesílá údaje.
  7. Systém kontroluje údaje.
  8. Systém přidá recept do knihy receptů.

Výjimečný tok

  1. Systém zobrazí plán jídel.
  2. Kuchař založí nové jídlo.
  3. Kuchař přidá název jídla.
  4. Kuchař přidá čas.
  5. Kuchař přidá recept.
  6. Kuchař odesílá údaje.
  7. Systém zkontroluje správnost údajů.
  8. Kuchař opravuje údaje.
  9. Kuchařl odesílá údaje.
  10. Systém přidá recept do knihy receptů.

Odstranění jídla

Shrnutí

Odstraní jídlo z plánu.

Podmínka

Jídlo bylo přidáno do plánu.

Výsledek

Jídlo je odstraněno z plánu.

Základní tok

  1. Systém zobrazí plán jídel.
  2. Kuchař vybere jídlo.
  3. Kuchař odešle vybrané jídlo k odstranění.
  4. Systém zkontroluje údaje.
  5. Systém odstraní jídlo.

Výjimečný tok

  1. Systém zobrazí plán jídel.
  2. Kuchař vybere jídlo.
  3. Kuchař odešle vybrané jídlo k odstranění.
  4. Systém nenajde jídlo.

Úprava jídla

Shrnutí

Úprava jídla.

Podmínka

Jídlo bylo přidáno do pláno.

Výsledek

Jídlo je upraveno.

Základní tok

  1. Systém zobrazí plán jídel.
  2. Kuchař vybere jídlo.
  3. Systém zobrazí údaje.
  4. Kuchař upraví údaje.
  5. Kuchař odešle údaje.
  6. Systém zkontroluje údaje.
  7. Systém smaže staré údaje.
  8. Systém přidá upravené jídlo do plánu.

Výjimečný tok

  1. Systém zobrazí plán jídel.
  2. Kuchař vybere jídlo.
  3. Systém zobrazí údaje.
  4. Kuchař upraví údaje.
  5. Kuchař odešle údaje.
  6. Systém zkontroluje údaje.
  7. Kuchař upravuje údaje.
  8. Kuchař odesílá údaje.
  9. Systém smaže staré údaje.
  10. Systém přidá upravené jídlo do plánu

Class diagram

Package logika

Package logika

Package UI

Package UI

Package util

Package util

Struktura databáze

Struktura databáze

Návrh uživatelského rozhraní

Stránka s recepty

Recepty

Stránka s potravinami

Potraviny

Stránka s kalkulací jídel

Kalkulace

Stránka pro přidávání

Přidání

Stránka pro úpravy

Úprava

Stranka pro odebírání

Odebrání