Popis struktury aplikace

Důležité soubory

/src/main/webapp/WEB-INF/

• web.xml - deployment descriptor
  • načtení konfigurace aplikačního kontextu (Spring) - applicationContext.xml
  • načtení konfigurace log4j
• applicationContext.xml - aplikační kontext (Spring)
  • definice bean - jedná se o beany: poskytnuté Springem, DAO, validátory
• spot-servlet.xml - webová konfigurace pro Spring (Spring loaduje implicitně)
  • definice bean (těch zbývajících)
  • mapování URI na controllery
  • mapování pro DWR knihovnu (AJAX)

/src/main/webapp/WEB-INF/properities/ - konfigurační soubory ve formátu pro PropertyPlaceholderConfigurer?

• jdbc.properities - konfigurace připojení k databázi
• log4j.properities - konfigurace log4j
• spot.properities - různá nastavení spotu (verze, mail atd.)

/src/main/webapp/WEB-INF/classes/ - lokalizační soubory (cs, de, en)

Zdrojové soubory - Java

cz.zcu.kiv.spot.business

• zpřístupňuje DAO - veškeré operace s databází jdou přes DictionaryManager?

cz.zcu.kiv.spot.controllers

• kontrolery pro obsluhy HTML požadavků
• obsahují cestu k JSP, které dokončí požadavek

cz.zcu.kiv.spot.dao

• třídy DAO, které již obsahují SQL dotazy a pracují s jednotlivými tabulkami v databázi
• je-li dotaz typu select, namapují výsledek do domain objektů

cz.zcu.kiv.spot.domain

• doménové objekty, do kterých jsou DAO objekty mapovány záznamy z tabulek v databázi

cz.zcu.kiv.spot.exceptions

• vlastní implementace výjimek vzniklých při:
  • nahrávání souboru (při importu slov)
  • práci s mailem
  • úpravě slova

cz.zcu.kiv.spot.forms

• slouží Springu k mapování formulářů do objektů, se kterýmy pracují kontrolery (SimpleFormController?)

cz.zcu.kiv.spot.integration

• třídy umožňující zobrazení překladu z externích zdrojů (momentálně ze slovníků slovnik-cizich-slov.abz.cz a foldoc.org)
• používá SearchWordController? (zobrazeno při vyhledávání)

cz.zcu.kiv.spot.interceptors

• "filtry" Springu
• v našem případě mají implementovánu metodu preHandle - vykoná se před přednámím požadavku kontroleru
• AuthInterceptor? - zajišťuje autorizaci - přístup na stránky jen pro přihlášené uživatele, přístup do administračního rozhraní
• SettingInterceptor? - nastavuje kódování

cz.zcu.kiv.spot.mail

• posílání mailů

cz.zcu.kiv.spot.utils

• různé pomocné třídy

cz.zcu.kiv.spot.validators

• validátory
• vytvořeny Springem v ApplicationContext?.xml a přiřazeny k odpovídajícím kontrolerům (těm, co implememntují SimpleFormController?) ve spot-servlet.xml

cz.zcu.kiv.spot.web

• PagingHelper? - slouží ke stránkování u seznamů (ke stránkování je využita třída Springu PagedListHolder?)
• SearchParameter? - určí podle URI, o jaký seznam se jedná (štítky, slovník, ...)
• WordManager? - zapouzdřuje akce se slovy (volá metody DictionaryManageru? pro přístup k databázi)

JSP - View vrsta aplikace

/src/main/webapp/WEB-INF/jsp/

• index.jsp - hlavní stránka
• 404.jsp - stránka pro chybu 404
• account/
  • jsp pro stránky týkající se uživatelského účtu (registrace, aktivace, přihlášení, projekty, ...)
• admin/
  • jsp stránky pro administrační rozhraní (backend)
  • hlavní stránka adm. rozhraní - admin-list.jsp
• include/
  • footer.jsp - patička stránky
  • header.jsp - HTML hlavička
  • menu.jsp - hlavní menu
  • spotBox.jsp - vkládán do pages/about.jsp
  • top.jsp - horní lišta s vyhledáváním a menu (není na hlavní stránce)
  • pozn: userbar.jsp (pozůstatek ze starého designu) a freeDict.jsp se už zřejmě nepoužívají
  • backend/ - odpovídající JSP pro administrační rozhraní
• pages/
  • about.jsp, contact.jsp, involved.jsp, importWithoutRights - statické stránky
  • links.jsp - odkazy na jiné stránky
  • tag_csAdmin.jsp - správa štítků pro admina
  • tag_csView.jsp - seznam štítků pro běžné uživatele
  • web-map.jsp - nepoužito (zamýšleno zřejmě jako mapa webu)
  • project/ - jsp pro zobrazení seznamu projektů a detailu projektu
  • word/ - jsp pro stránky týkající se slov - zobrazení seznamů, detailu slova, přidání slova, návrhu atd.