Graafinen käyttöliittymä lintujen rengastusjärjestelmään

Transkriptio

1 Graafinen käyttöliittymä lintujen rengastusjärjestelmään Suunnitteludokumentti Versiohistoria: Ensimmäinen luonnos. Tarja Rauste, Simo Salmensuu Toinen luonnos. Näyttöjä lisätty. Tarja Rauste, Simo Salmensuu Helsinki, 22. helmikuuta 2002 Markus Päivinen Mari Jaakkola Peter Lindroos Tarja Rauste Simo Salmensuu Vesa Teikari HELSINGIN YLIOPISTO Tietojenkäsittelytieteen laitos Ohjelmistotuotantoprojekti Haukka

2 Sisältö 1 Johdanto Tuotteen tausta ja tarkoitus Tärkeimmät vaatimukset Suunnittelun ja toteutuksen rajoitukset Yhdenmukaisuus aiemmin toteutettuihin käyttöliittymän osiin Noudatettavat standardit Muut tarvittavat ohjelmat Ohjelmointityyli Järjestelmän yleiskuvaus Toimintaympäristö Moduulikuvaukset Näytöt Renkaiden palautus Rengastyyppien ylläpito Lajeille sallitut sarjat Renkaan merkitseminen hävinneeksi/tuhoutuneeksi Käytettyjen renkaiden selaus Rengasvälin hajoitus Rengastusten hirrustietojen ylläpito Rengastajien ylläpito Maatietojen ylläpito Läänien ylläpito LYL-alueiden ylläpito

3 Euring-provinssien ylläpito Rengastuskeskusten ylläpito Lajien ylläpito Sanaston ylläpito Lintuasemien ylläpito KORJAA: Näyttöjen toimintokuvaukset Servlet-luokat Mallipohjat Mallipohjan rakenne Näytön tilat Testaussuunnitelma Komponenttitestaus Integrointitestaus Validointitestaus Viitteet 28

4 1 1 Johdanto 1.1 Tuotteen tausta ja tarkoitus Helsingin yliopiston Luonnontieteellisen keskusmuseon Rengastustoimisto organisoi lintujen rengastuksen Suomessa. Rengastuksia ja rengastettujen lintujen havaintoja koskevat tiedot talletetaan tietokantaan, joka liittyy suurempaan tietokantajärjestelmään. Tämän avulla sekä tulostetaan rengastajille, maallikoille ja ulkomaisille rengastuskeskuksille kirjeitä että tuotetaan raportteja ja tutkimusdataa tutkijoile, päättäjille ja valistajille. Rengastustoimistossa on tuotantokäytössä SQL*Forms kehittimellä toteutettu merkkipohjainen käyttöliittymä rengastustietokantaan. Tämä vanhentunut käyttöliittymä on tarkoitus vaihtaa nykyaikaisempaan. Projektin tarkoituksena on jatkaa aikaisempien ohjelmistotuotantoprojektien, Tipu4:n ja Tintin, aloittamaa graafisen käyttöliittymän suunnittelua ja toteuttamista. Käyttöliittymä muodostuu interaktiivisista WWW-lomakkeista, joilla Rengastustoimiston väki voi syöttää tietokannan tauluihin suoraan tietoja. Käyttöliittymä tarjoaa rajapinnan tietokannan tauluihin, tarkistaa syötetyt tiedot ja tallentaa tiedot kantaan. Tuotantokäytössä olevan järjestelmän osia on tarkoitus käyttää toteutuksessa hyväksi soveltuvin osin. Tipu4:n ja Tintin tuottama suunnittelu ja toteutus tarjoavat valmiin mallin lopulliselle tuotteelle. Nämä materiaalit ovat suoraan hyödynnettävissä tässä projektissa, ja käyttöliittymä on tarkoitus toteuttaa pääosin Tipu4:n tekemän käyttöliittymäsuunnitelman mukaan.

5 2 1.2 Tärkeimmät vaatimukset Projektin aikana on tarkoitus toteuttaa lintujen rengastusjärjestelmän puuttuvat näytöt: Renkaiden palautus, Rengastyyppien ylläpito, Lajeille sallitut sarjat, Renkaan merkitseminen hävinneeksi/tuhoutuneeksi, Käytettyjen renkaiden selaus, Rengasvälin hajoitus, Rengastusten hirrustietojen ylläpito, Rengastajien ylläpito, Maatietojen ylläpito, Läänien ylläpito, LYL-alueiden ylläpito, Euring-provinssien ylläpito, Rengastuskeskusten ylläpito, Lajien ylläpito, Sanaston ylläpito ja Lintuasemien ylläpito. Uusien näyttöjen ulkomuodon ja toiminnallisuuden tulisi olla yhteneväinen projektiryhmien Tipu4 ja Tintti toteuttamien näyttöjen kanssa. Näin käyttöliittymästä muodostuu yhdenmukainen kokonaisuus. Ohjelmiston vaatimukset on kuvattu tarkemmin Määrittelydokumentissa [1].

6 3 2 Suunnittelun ja toteutuksen rajoitukset 2.1 Yhdenmukaisuus aiemmin toteutettuihin käyttöliittymän osiin Jotta lopullisen käyttöliittymän yhdenmukaisuus voidaan varmistaa, noudattavat myös uusina toteutettavat näytöt Tipu4-projektin suunittelu- ja toteutusvalintoja. Koska ratkaisut on testattu ja todettu toimiviksi ja asiakas on niihin tyytyväinen, voidaan Haukka-projektissa hyödyntää myös projektiryhmien Tipu4 ja Tintti kehittämiä yleiskäyttöisiä moduuleja (esimerkiksi tietokantayhteyden luomiseen) joko suoraan tai periyttämällä. Haukka-projektin suunnittelun osuus käsittää lähinnä toteutettavien näyttöjen sisällön selvittämisen, käytettävien tietokannan osien määrittelemisen sekä tarvittavien moduulien valitsemisen. 2.2 Noudatettavat standardit Servlet-ohjelmamoduuli kommunikoi käyttäjän kanssa HTTP 1.1 -protokollan mukaisesti. Asiakaspäätteellä näkyvät uudet HTML-dokumentit kirjoitetaan HTML spesifikaation mukaisesti. Java-ohjelmakoodin ulkoasu on Sun Microsystemsin Java Code Conventions -spesifikaation mukainen. 2.3 Muut tarvittavat ohjelmat WWW-Tipu tarvitsee toimiakseen Oracle 8-tietokannanhallintajärjestelmän sekä Apache Web Server (versio ) -www-palvelimen, jossa on Apache JServ (versio 1.1.2) -moduuli.

7 4 2.4 Ohjelmointityyli WWW-Tipu kirjoitetaan Sun Microsystemsin kehittämällä Java 1.2 -kielellä. Kielen syntaktinen ulkoasu (mm. sisennystyyli, isojen ja pienten kirjainten käyttö) on Java Code Conventions -spesifikaation mukainen. Luokkien, metodien ja muuttujien nimet kirjoitetaan englanniksi, jotta niistä tulisi johdonmukaisia Java-kielen varattujen sanojen ja valmiiden luokkakirjastojen nimien kanssa. Tulostettava teksti ja kommentit kirjoitetaan suomeksi, jotta ne olisivat yhdenmukaisia aikaisemman järjestelmän tulostamien tekstien kanssa. 3 Järjestelmän yleiskuvaus Kuva 1: Järjestelmän servlet-luokkien luokkakaavio Haukka-projektissa käytetään Tipu4- ja Tintti-projekteissa kehitettyjä tietokannan käsittelyluokkia, TipuServlet- ja Popup-luokkia sekä apuluokkaa ja Coords (Kuva 1). TipuServlet on abstrakti luokka josta jokainen WWW-Tipu-järjestelmän servletti periytyy. Popup toimii apuluokkana servleteille. Coords on koordinaattien käsittelyyn tarvittava apuluokka. TipuProperties sisältää tipu-järjestelmän properties-tiedot.

8 5 3.1 Toimintaympäristö Ohjelmisto toteutetaan Java Servlet-tekniikalla Unix-ympäristössä. Servletit käyttävät järjestelmässä valmiina olevia tietokantakomponentteja. Projektin aikana käytettävät Java Servlet -ajoympäristö (Apache JServ ) ja Java-kääntäjä (Sun J2SE ) sijaitsevat TKTL:n Unix-palvelimella alkokrunni alias db.cs.helsinki.fi.valmis WWW-tipu-ohjelma tullaan sijoittamaan ATK-osaston palvelimeen. WWW-etusivu ladataan eläinmuseon käyttämältä WWW-palvelimelta ja loput sivuista luodaan käyttäjän valintojen mukaan Unix-palvelimelle sijoitettavien servlettien avulla. WWW-lomakkeiden tiedot lähetetään Java servleteille HTTP-protokollan GET- ja POST-toiminnoin, tulosteet generoidaan asiakkaan selaimelle. HTML sivuissa tullaan käyttämään JavaScriptiä yksinkertaisten tarkistusten suorittamiseen. Järjestelmä on ensisijaisesti suunniteltu käytettäväksi Internet Explorer- selaimen versiolla 4.0 tai uudemmalla. 4 Moduulikuvaukset Tässä dokumentissa kuvataan toteutettaviksi valittujen näyttöjen sisältö ja niihin suoraan liittyvät servlet-moduulit. Muut toteutuksessa käytetyt luokat on kuvattu Tipu4-projektin suunnittelu- ja toteutusdokumenteissa. 4.1 Näytöt Toteutettavien näyttöjen ulkonäkö tulee noudattamaan Tipu4:n ja Tintin suunnitteluja toteutusvalintoja. Näyttöjen sisältämät kentät määräytyvät pitkälti vanhojen SQL*Formsnäyttöjen kenttien mukaan. Tiedot siitä, mihin tietokannan kenttiin mitkäkin näyttöjen kentät tallennetaan, ovat liittessä 1. Liitteestä 2 löytyy myös lista niistä käyttöliittymän valikoista, joi-

9 6 Kuva 2: Näyttö Tapaamisten ylläpito, alkuosa Kuva 3: Näyttö Tapaamisten ylläpito, loppuosa den arvot haetaan SANASTO-taulusta. Liitteessä on listattu myös koodit, joiden perusteella haku suoritetaan. Renkaiden palautus, Rengastyyppien ylläpito, Lajeille sallitut sarjat, Renkaan merkitseminen hävinneeksi/tuhoutuneeksi, Käytettyjen renkaiden selaus, Rengasvälin hajoitus, Rengastusten hirrustietojen ylläpito, Rengastajien ylläpito, Maatietojen ylläpito, Läänien ylläpito, LYL-alueiden ylläpito, Euring-provinssien ylläpito, Rengastuskeskusten ylläpito, Lajien ylläpito, Sanaston ylläpito ja Lintuasemien ylläpito Renkaiden palautus Renkaiden palautusnäyttö (Kuva 2, 3) vastaa vanhan järjestelmän näyttöjä tap03 ja tap03/2. KORJAA:Kenttiin liittyvät haut ja tarkistukset

10 7 Kuva 4: Näyttö Käytettyjen renkaiden selaus Kuvaukset vastaavat Tapausten syöttönäytön kenttien kuvauksia. Poikkeuksina ovat Ilmtap- ja Kirpvm-kentät. Kirpvm on syöttönäytöllä piilokenttänä. Ylläpitonäytöllä se kuitenkin näkyy, mutta ei ole ylläpidettävissä. Ilmtap- alasvetovalikossa on syöttösivun arvojen lisäksi myös arvo 3, koska vanhoissa tiedoissa tämä arvo voi esiintyä. Huomattakoon lisäksi, että Uusirg-kenttään liittyvä tarkistuksessa käytetäänkin Tapaaminen-taulun TA_RLUJALKAR- ja TA_RENROTA-kenttiä VROSKA-taulun kenttien sijaan. KORJAA: Näytön toiminnot Ei sisällä tietojen lisäys- ja kopiointi-toimintoja. Muuten toteuttaa samat toiminnot kuin Tapaamisten syöttö -sivu. Näytön tietokantatoiminnot kohdistuvat TAPAAMINENtauluun Rengastyyppien ylläpito Lajeille sallitut sarjat Renkaan merkitseminen hävinneeksi/tuhoutuneeksi Käytettyjen renkaiden selaus Käytettyjen renkaiden selausnäyttö (kuva 4) vastaa vanhan järjestelmän näyttöä 2.5. Kenttiin liittyvät haut ja tarkistukset Kaikki muut, paitsi Renkaan tila-kenttä ovat tekstikenttiä. Renkaan tila-kenttä voidaan toteuttaa pudotusvalikkona, koska mahdollisia vaihtoehtoja on vähän.

11 8 Kuva 5: Näyttö Rengasvälin hajoitus Tietokantatoiminnot kohdistuvat RENGASTETTU-tauluun. Otsikko kenttä tyyppi pituus Jalkarengas rlujalkar varchar2 12 Nimirengas rlnimir varchar2 12 Renkaan tila rltila varchar2 1 Vanha rengas rlvjalkar varchar2 12 Poisto pvm rlvpvm date 7 Rengastunnus rstunnus varchar2 12 Näytön toiminnot Näyttö sisältää haku-, -tyhjennys- ja ohje-toiminnot Rengasvälin hajoitus Rengasvälin hajoitus -näyttö (kuva 5) vastaa vanhan järjestelmän näyttöä 2.6. Näytön molemmat kentät ovat tekstikenttiä. Kenttiin liittyvät haut ja tarkistukset Tietokantatoiminnot kohdistuvat?????-tauluun. Otsikko kenttä tyyppi pituus Ensimmäinen rengas????? varchar2???? Viimeinen rengas????? varchar2???? Näytön toiminnot Näyttö sisältää haku-, pilko-, tyhjennys- ja ohje-toiminnot Rengastusten hirrustietojen ylläpito Rengastajien ylläpito Rengastajien ylläpitonäyttö (kuva 6) vastaa vanhan järjestelmän näyttöä apu01.

12 9 Kuva 6: Näyttö Rengastajien ylläpito Kuva 7: Näyttö Läänien ylläpito Kenttiin liittyvät haut ja tarkistukset Rengastaja: Rengastajan numero, jonka perusteella käyttäjä suorittaa haun tietokannasta. Käyttäjä voi kirjoittaa suoraan rengastajan numeron kenttään, jonka perusteella rengastajan nimi haetaan. Tai molemmat voidaan hakea popupvalikosta, jonka arvot RENGASTAJA, REETUNIMI JA RESUKUNIMI haetaan RENGASTAJA-taulusta. Käyttäjä ei voi suoraan ylläpitää nimi-kenttiä. Pakollisina täytettävänä olevat kentät: Rengastajanumero. Lisäyksessä arvo saadaan kyselyllä SELECT MAX RENRO+1 FROM RENGASTAJA Numeerisen arvon sisältävät kentät: Rengastajanumero Kentät, joita käyttäjä ei voi ylläpitää: Rengastajanumero ja Päivitys pvm. Tietokantatoiminnot kohdistuvat RENGASTAJAtauluun Näytön toiminnot Näyttö sisältää lisäys-, haku-, ylläpito-, poisto-, palautus-, tyhjennys- ja ohjetoiminnot Maatietojen ylläpito Läänien ylläpito Läänien ylläpitonäyttö (kuva 7)vastaa vanhan järjestelmän näyttöä apu04. Kenttiin liittyvät haut ja tarkistukset Lääninumero: Läänin numero, jonka perusteella käyttäjä suorittaa haun tietokannasta. Käyttäjä voi valita läänin numeron alasvetovalikosta, jonka perusteella lää-

13 10 Kuva 8: Näyttö LYL-alueiden ylläpito nin nimi ja ruotsinkielinen nimi haetaan. Kenttien arvot LNNRO, LNNIMI ja LN- NIMIR haetaan LAANI-taulusta. Käyttäjä ei voi suoraan ylläpitää nimi-kenttiä. Pakollisina täytettävänä olevat kentät: Lääninumero. Lisäyksessä arvo saadaan kyselyllä SELECT MAX LNNRO+1 FROM LAANI. Numeerisen arvon sisältävät kentät: Lääninumero Kentät, joita käyttäjä ei voi ylläpitää: Lääninumero Tietokantatoiminnot kohdistuvat LAANI-tauluun. Näytön toiminnot Näyttö sisältää lisäys-, haku-, ylläpito-, poisto-, palautus-, tyhjennys- ja ohjetoiminnot LYL-alueiden ylläpito LYL-alueiden ylläpitonäyttö (kuva 8)vastaa vanhan järjestelmän näyttöä 6.6. Kenttiin liittyvät haut ja tarkistukset LYL-alue-kenttä voidaan toteuttaa editoitavana pudotusvalikkona. Näin käyttäjä voi päivittää tai lisätä uuden LYL-alueen. Numeerisen arvon sisältävät kentät: LYL-alue Tietokantatoiminnot kohdistuvat LYL-ALUE-tauluun. Näytön toiminnot Näyttö sisältää lisäys-, haku-, ylläpito-, poisto-, tyhjennys- ja ohje-toiminnot Euring-provinssien ylläpito Euring-provinssien ylläpitonäyttö (Kuva 9) vastaa vanhan järjestelmän näyttöä apu07.

14 11 Kuva 9: Näyttö Euring-provinssien ylläpito Kuva 10: Näyttö Lintuasemien ylläpito Kenttiin liittyvät haut ja tarkistukset Pakollisina täytettävänä olevat kentät: KORJAA: Rengastuskeskusten ylläpito Lajien ylläpito Sanaston ylläpito Lintuasemien ylläpito Lintuasemien ylläpitonäyttö (Kuva 10)vastaa vanhan järjestelmän näyttöä apu11. Kenttiin liittyvät haut ja tarkistukset Asema: Aseman lyhenne, jonka perusteella käyttäjä suorittaa haun tietokannasta. Käyttäjä voi suoraan kirjoittaa aseman lyhenteen kenttään, jonka perusteella aseman nimi haetaan. Tai molemmat tiedot voidaan hakea popup-valikosta, jonka arvot LTASEMALYH ja LTNIMI haetaan LINTUASEMA-taulusta. Käyttäjä ei voi suoraan ylläpitää nimi-kenttää. Kunta: Kenttä, johon käyttäjä voi suoraan kirjoittaa kuntalyhenteen tai hakea sen pop-up valikosta. Valikon arvot haetaan KUNTA-taulusta.(KULYH ja KUNIMI) Pakollisina täytettävänä olevat kentät: Aseman lyhenne Numeerisen arvon sisältävät kentät: Rengastajanro, säde sekä koordinaattikentät Kentät, joita käyttäjä ei

15 12 voi ylläpitää: Aseman lyhenne Tietokantatoiminnot kohdistuvat LINTUASEMAtauluun. Näytön toiminnot Näyttö sisältää lisäys-, haku-, ylläpito-, poisto-, palautus-, tyhjennys- ja ohjetoiminnot KORJAA: Näyttöjen toimintokuvaukset KORJAA: Tapaamistietojen lisäys 1. Suoritetaan javascript-tarkistukset (kaikki pakolliset kentät on täytetty ja kenttien arvot ovat oikean tyyppisiä). 2. Lähetetään lomake servletille käsiteltäväksi. 3. Tiedot tallennetaan VROSKA-tauluun. Ja suoritetaan commit-käsky. 4. Jos tietojen tallennus VROSKA-tauluun onnistui, kutsutaan Fortran-ohjelmaa, joka tarkistaa tiedot. Jos tiedot hyväksytään, tallentaa ohjelma ne automaattisesti oikeisiin tietokantatauluihinsa. 5. Fortran-ohjelma tallentaa VTXT-tauluun tiedon siitä, onnistuiko tietojen tarkistus ja tallennus. Jos se onnistui, tallentaa se tauluun yhden rivin, jossa RETCODE-kentän arvo on 0. Muuten se kirjoittaam yhden tai useamman virheilmoitusrivin VTXT-tauluun. 6. Luetaan VTXT-taulusta Fortran-ohjelman tallentamat tiedot. 7. Palautetaan käyttäjän tallentamat tiedot näytölle ja ilmoitetaan tallennuksen onnistumisesta tai näytetään mahdollinen virheilmoitus. 8. Käyttäjä voi yrittää tallennusta uudelleen korjaamalla tietoja.

16 13 KORJAA: Muiden tietojen lisäys Kuten tapaamistietojen lisäys, mutta Fortrantarkistusohjelmaa ei kutsuta vaan kaikki tarkistukset tehdään joko javascriptillä tai servletissä ja tiedot tallennetaan suoraan oikeaan tauluunsa. Haku 1. Suoritetaan javascript-tarkistukset käyttäjän syöttämille hakutekijöille 2. Lähetetään lomake servletille 3. Suoritetaan haku 4. Jos haun tuloksena on vain yksi tietue, näytetään sen sisältämät tiedot näytöllä. Muuten esitetään lista löydetyistä tietuesta, joita klikkaamalla käyttäjä pääsee näkemään kunkin yksityiskohtaiset tiedot. KORJAA: Tapaamistietojen ylläpito 1. Suoritetaan javascript-tarkistukset (kaikki pakolliset kentät on täytetty ja kenttien arvot ovat oikean tyyppisiä). 2. Lähetetään lomake servletille käsiteltäväksi 3. Tiedot tallennetaan TAPAAMINEN-tauluun ja suoritetaan commit-käsky. 4. Jos tallennus onnistui, kutsutaan Fortran-ohjelmaa, joka tarkistaa tiedot. 5. Fortran-ohjelma kirjoittaa VTXT-tauluun tiedon tarkistuksen ja tallennuksen onnistumisesta kuten Tapaamistietojen lisäyksessäkin. 6. Luetaan mahdollinen virheilmoitus VTXT-taulusta. 7. Palautetaan käyttäjän tallentamat tiedot näytölle ja ilmoitetaan tallennuksen onnistumisesta tai näytetään mahdollinen virheilmoitus. 8. Käyttäjä voi yrittää tallennusta uudelleen.

17 14 KORJAA: Muiden tietojen ylläpito Kuten tapaamistietojen ylläpito, mutta Fortrantarkistusohjelmaa ei kutsuta vaan kaikki tarkistukset tehdään joko javascriptillä tai servletissä. KORJAA: Pakotus Pakotus-toiminto on käytössä vain tapaamistietojen syötössä ja ylläpidossa. Toiminto käynnistetään muista toimintopainikkeista hieman erilleen sijoitettavasta, punaisesta Pakota-painikkeesta. Painikkeen väri ja sijainti muutetaan vastaavaksi myös Tipu4:n rengastusten syöttö- ja ylläpitonäyttöihin. Pakotus-toiminnossa ei suoriteta tietojen tarkistuksia vaan tallennetaan tiedot suoraan tietokantaan (Tapaamistietojen lisäyksessä VROSKA-tauluun ja ylläpidossa TAPAAMINEN-tauluun). Fortran-tarkistusohjelmaa kutsutaan parametreilla, jotka kertovat kyseessä olevan pakotuksen. Ohjelma kirjoittaa tiedot toiminnon onnistumisesta tai epäonnistumisesta VTXT-tauluun samaan tapaan kuin esimerkiksi Tapaamistietojen lisäyksessä. Poisto Kun näytölle on haettu yhden tietueen tiedot, voidaan ne poistaa tietokannasta painamalla Poista-painiketta. Ainoastaan yhden tietueen tiedot voi kerrallaan poistaa. Kullakin sivulla varmistetaan käyttäjältä tämän halukkuus poistoon ennen varsinaista tietojen poistamista. Lisäksi Tapaamisten ylläpitonäytössä tarkistetaan löytyykö samalla Diario-kentän arvolla rivi VTAPAAMINEN -taulusta, ja Maallikkojen ylläpitonäytössä tarkistetaan, löytyykö TAPAAMINEN -taulusta rivejä, joissa TA_MANRO = Maallikkonumero-kentän arvo. Molemmissa tapauksissa, jos kyselyllä rivejä löydetään, ilmoitetaan näistä käyttäjälle. Poistaminen sallitaan kuitenkin eikä liittyviä tietoja poisteta. Kopiointi Kopioinnin yhteydessä kasvatetaan Diario-kentän arvoa yhdellä Tapaamisten syöttönäytöllä sekä Väritapaamisten ja Tapaamisten hirrustietojen yllä-

18 15 pitonäytöllä. Tapaamisten syöttönäytöllä lisäksi tyhjätään Rengas- ja Nimir-kentät. Vastaavasti tyhjätään Värirengas-kenttä Väritapaamisten ylläpitonäytöllä. Värirengastusten ylläpito-näytöllä tyhjätään Jalkarengas- ja Värirengas-kentät. Muiden kenttien arvot säilytetään ennallaan. Palautus Toiminto palauttaa näytöllä olevat tiedot samoiksi kuin ne ovat tietokannassa. Tämä toteutetaan selainten ymmärtämällä valmiilla javascript-funktiolla reset(). Tyhjennys Painikkeesta asetetaan kaikki näytön kentät tyhjiksi. Ohje Painikkeesta avataan näytön käyttöohje. 4.2 Servlet-luokat Lomakkeiden toiminnallisuus toteutetaan servlet-luokilla, joita on yksi kutakin lomakesivua (esim. tapaamisten syöttö) kohden. Lisäksi lomakkeilta avattavia popupvalikoita (esim. lista rengastajien nimistä) varten on oma Popup-luokkansa, joka on yhteiskäytössä eri näyttöjen kesken. Pääpiirteittäin luokat ovat toistensa kaltaisia, erot johtuvat lähinnä eri lomakesivujen sisältämistä kentistä. Servlet-luokan suoritus käynnistyy, kun servletiä kutsutaan WWW-selaimella ensimmäistä kertaa servlet-palvelimen käynnistyttyä. Tästä eteenpäin servlet on aktiivisena palvelimen muistissa niin kauan, kunnes palvelin suljetaan. Servlet käyttää säikeitä palvellakseen useita yhtäaikaisia pyyntöjä ja voi myös sisältää staattista, kaikkien pyyntöjen käytössä olevaa informaatiota. Servlet vastaanottaa informaatiota WWW-selaimelta HTTP-protokollan GET-ja POST-toiminnoilla ja voi istunnon lopuksi palauttaa selaimelle generoimansa WWWsivun.

19 16 Lomakesivujen toiminnallisuuden toteuttavat servlet-luokat muodostavat WWW- Tipun ytimen. Servletit kutsuvat muita pakkauksien luokkia mm. tietokantaa käsitellessään ja properties-tiedostoja lukiessaan, sekä lisäksi ulkoisia kirjastoja esim. templatetiedostojen tulostamiseksi. TipuServlet on kaikkien kannan tauluja vastaavien servletien abstrakti kantaluokka. Muut servletit Popup:ia lukuunottamatta on periytetty tästä. TipuServlet tarjoaa alaluokille mahdollisuuden kiinnittyä metodein pääoperaatioidensa esi- tai jälkitarkasteluosaan, joissa voidaan ohjata pyynnön suoritusta haluttuun suuntaan tekemällä esim. ylimääräisiä tarkastuksia. Nämä metodit on oletusarvoisesti toteutettu tyhjinä. TipuServletin abstraktit metodit ja muuttujat: // näihin tulee *luokkakohtaisesti* staattinen mappi protected Map searches = null; protected Map searchconditions = null; /** * Suoritetaan servletin käynnistyessä 1. kerran tai restartin * yhteydessä. * * 1. alustaa muuttuja <table> oikealla Table-instanssilla * 2. alustaa muuttuja <template> oikealla Template-instanssilla */ protected abstract void initialize(); Alustettavat taulut Tapaamisten syötölle ja ylläpidolle VROSKA VTXT

20 17 TAPAAMINEN THIRRUS MAALLIKKO VRENGASTUS VTAPAAMINEN Alustettava template TEMPLATE_TASYOTTO TEMPLATE_TAYLLAPITO Tapaamisten syötölle ja ylläpidolle haettavat sanastot ilmenevät liitteestä 2. Viitteiksi haetaan lintuasemat. Muiden servlettien tiedot näkyvät muista osista tätä dokumenttia, sekä Tietokantaliitteestä (nro 1). /** * Palauttaa avaimen nimen, jolla kohdetaulu hakuoperaatioissa järjestetään. */ protected abstract String getsearchkey(); /** * Palauttaa hakutuloslistan rivin SimpleHash-kenttinä. Tarvittavat arvot * voidaan lukea riviä vastaavasta parametrista values. */

21 18 protected abstract SimpleHash getindexrow(map values); /** * Suoritetaan juuri ennen modelrootin lähettämistä template-enginelle. */ protected void doposthook(map values, SimpleHash modelroot) {} /** * Tätä kutsutaan juuri ennen templaten tulostamista vastauksen * tulostevirtaan. Tarkoituksena on täällä asettaa modelroot:iin * kaikki juuri tälle lomakkeelle ominaiset kentät. * values lähettävät arvot modelroot Templaten runko-objekti. */ protected void doposthook(map values, SimpleHash modelroot) { Liitetään sanasto, ja viite-oliot modelrootiin. /** Suoritetaan ennen SearchOperation:in suoritusta. */ protected void dosearchprehook(map values) {} /** Suoritetaan SearchOperation:in suorituksen jälkeen. */ protected void dosearchposthook(map values) {} /** Suoritetaan ennen InsertOperation:in suoritusta. */ protected void doinsertprehook(map values) {}

22 19 Jos kyseessä on pakotustoiminto, haetaan avaimen mukainen rivi, jonka tarvittavat kentät päivitetään. Jos riviä ei avaimella löydy, luodaan uusi tietue. /** Suoritetaan InsertOperation:in suorituksen jälkeen. */ protected void doinsertposthook(map values) {} Ajetaan CHECK-ohjelma, Tarkistetaan VTXT-taulusta, löytyykö sieltä tarkistusohjelman kirjoittama virheilmoitusrivi. Jos löytyy näytetään käyttäjälle tiedot tapahtuneesta virheestä. /** Suoritetaan ennen DeleteOperation:in suoritusta. */ protected void dodeleteprehook(map values) {} /** Suoritetaan DeleteOperation:in suorituksen jälkeen. */ protected void dodeleteposthook(map values) {} /** Suoritetaan ennen UpdateOperation:in suoritusta. */ protected void doupdateprehook(map values) {} Kutsutaan ennen updatea, käytännössä kutsutaan doinsertprehook() metodia /** Suoritetaan UpdateOperation:in suorituksen jälkeen. */ protected void doupdateposthook(map values) {} protected abstract Map getsearchmap(); protected abstract Map getconditionmap(); Kaikki varsinaiset Insert, Update ja Delete-operaatiot tapahtuvat TipuServlet-luokassa. Tarkempaa koodiesimerkkiä voi katsoa esim. ReSyotto.java -tiedostosta.

23 20 Kaikki tietokantametodit on abstrahoitu tipu.db-paketissa. Servletillä on yksi nimetty kohdetaulu, johon kaikki siltä pyydetyt operaatiot kohdistuvat. Servlet hakee käynnistyessään jokaisen kohdetaulunsa Table -objektin, ja säilyttää niitä jäsenmuuttujissaan elinkaarensa ajan. SearchOperation suorittaa SELECT -lauseella haun tietokannan tauluun annetuilla attribuuttimaskeilla. Kaikki vertailut tehdään LIKE -operaattorein, joten käyttäjät voivat itse syöttää jokerimerkkejä hakukenttiin. Tulokset palautetaan erillisessä SearchResults -objektissa. SearchOperation(Table table) -konstruktori luo uuden, tauluun table kohdistuvan hakuoperaation. ExecuteSearch(Connection con, Map values, String sortkey) -metodi suorittaa hakuoperaation kohdetauluun annetulla yhteydellä con ja hakuarvoilla values. Tulokset järjestetään kohdetaulun sarakkeen sortkey mukaan. Kutsu palauttaa haun tuloksena SearchResults -instanssin. Luokka SearchResults periytyy luokasta OperationResults. Lisäksi se sisältää listan haussa löytyneiden kohdetaulun rivien ROWID:t, joita voidaan selata vapaassa järjestyksessä. Rivien varsinaiset tiedot haetaan vain pyydettäessä, eikä kursoreita pidetä suotta auki. Tarkemmat kuvaukset kaikista metodeista löytyy Tipu4:n toteusdokumentista. 4.3 Mallipohjat Näytöt laaditaan ilmaisen (GPL) FreeMarker-kirjaston avulla. Näin sivujen ulkoasun määrittely voidaan eriyttää varsinaisesta toiminnallisuudesta. Servlet-luokkien tuottama tieto tallennetaan mallipohjaan puumaiseen tietorakenteeseen. Mallipohja tuotaa asiakkaalle esitettävän HTML-sivun. Jokaista servlet-luokkaa varten on oma mallipohjansa.

24 Mallipohjan rakenne Mallipohja muodostuu HTML-koodista ja Freemarker-komennoista. Komentojen avulla toteutetaan ehtorakenteita ja luettelomuotoisen tiedon esitys. Mallipohjan tietorakenteeseen tallennetuilla tietokannan muuttujilla on sama nimi kuin tietokannassa. Näytön tila ohjataan muuttujalla formsate. Muuttujalla on neljä arvoa: detail, list, normal ja record_added. Näyttö on tilassa normal, kun se ei ole missään toisessa tilassa. Tilojen yhteiset muuttujat ovat Tipu4-ryhmän toteutusdokumentin mukaisesti: Muuttuja action errors noticeheading notices result.* rowid static_url success Sisä Ede Ede Mui Mui Sisä Lom Staa Tosi Mallipohja on jaettu seuraaviin osiin: Otsikko, staattinen. Sivun alustukset, JavaScript- ja tyylitiedostojen haku. Ilmoitukset, tiedot tietorakenteen haarassa errors, success tai notices. Tieto edellisen toiminnon onnistumisesta tai siitä syntyneistä ilmoituksista ja virheistä. Hakutulokset, tiedot tietorakenteen haarassa searchresults. Haun tulookset sekä viittaukset eteen- ja taaksepäin tuloslistassa. Näytetään kun näytön tila on list. Selaus, tiedot tietorakenteen haarassa searchresults. Viittaukset edelliseen ja seuraavaan tietueseen. Näytetään kun näytön tila on detail.

25 22 Lomake, tiedot tietorakenteen haarassa result. Näytön tietueet ja toiminnenapit. Alarivi, staattinen. Sivun lopetus Näytön tilat Näytön tila on normal, kun se ei ole missään muussa tilassa. Näyttö on tilassa detail, kun näytetätään yksittäistä hakutulosta. Tietuetta voi päivittää tai poistaa ja jos haun tulosjoukossa on useampia tiedostoja, niitä voi selata eteen- ja taaksepäin. Näytön tila on list kun käyttäjälle näytetään haun tulokset. Käyttäjä voi valita yksittäisen tuloksen näytettäväksi tai tehdä uuden haun muokaamalla hakuehtoja. Tilaa record_added käytetään kun käyttäjä on lisännyt uuden tietueen Lisää-painikkeella. Lisättyä tietuetta voi muokata, poistaa tai kopioida. 5 Testaussuunnitelma Tässä kuvataan yleisesti testauksen eri vaiheet. Tarkemmat kuvaukset ja testitapaukset tulevat erilliseen testausdokumenttiin. Tipu4n ja Tintti-projektien tekemiä ja testaamia osia ei testata uudelleen. Ainoastaan niiden toimiminen Haukkaprojektin tekemien osien kanssa testataan. 5.1 Komponenttitestaus Ohjelmiston jokainen moduuli testataan erillisenä komponenttina. Komponentit testataan white box -menetelmällä, jotta voidaan testata niiden sisäistä toimivuutta. Testauksessa on tarkoitus käyttää polkukattavuutta, eli jokainen mahdollinen suorituspolku testataan. Tämä takaa sen, että jokainen moduulin koodirivi

26 23 tulee suoritettua ainakin kerran. Jokaiselle komponentille määrätään erityinen testaaja, joka on eri henkilö kuin kyseisen komponentin tekijä. 5.2 Integrointitestaus Integrointitestauksessa varmistetaan järjestelmän eri moduulien (luokkien) toiminta yhdessä mustalaatikkotestauksena. Kunkin luokan syötteiden ja tulosteiden oikeellisuus varmistetaan jakamalla niiden arvoalueet ekvivalenssiluokkiin, joista muodostetaan testiaineisto. Tämän jälkeen toteutetaan luokille testiaineiston mukaiset testitapaukset. WWW-Tipu testataan alhaalta ylös-menetelmällä. Tällöin ohjelmiston toteutus ja testaus aloitetaan luokkakaavion alimmista luokista. Järjestelmästä vielä puuttuvien alempia luokkia kutsuvien luokkien toimintaa simuloidaan erikseen koodattavilla ajuriluokilla. Näiden ajuriluokkien tulosteista voidaan todentaa kutsutun luokan tulosteen vastaavuus määriteltyyn. 5.3 Validointitestaus Validointitestaus tehdään kun integrointitestaus on valmis ja siinä havaitut virheet korjattu. Validointitestauksen tarkoituksena on tarkastaa täyttääkö WWW- Tipu sille vaatimusmäärittelyssä asetetut vaatimukset. Tämä tapahtuu suorittamalla joukko testitapauksia black box -menetelmällä, jotka osoittavat että ohjelmisto täyttää sille asetetut toiminnallisuus-, suorituskyky- ja muut vaatimukset sekä sen että dokumentaatio on oikeellinen.

27 24 Viitteet 1 Code conventions for the java programming language 2 Hypertext markup language 3.2 specification 3 Hypertext transfer protocol 1.1 specification 4 Java servlet engine apache jserv 5 Javadoc Danny Coward James Duncan Davidson Java servlet specification Jan Lindström Tipu käyttöohje 8 Apache homepage Tietokantataulut Tietokantataulut liitteenä erillisessä tiedostossa osoitteessa: ă /home/group/haukka/public_html/dokumentit/tietokantataulut.txt