Graafinen käyttöliittymä lintujen rengastusjärjestelmään Toteutusdokumentti Versiohistoria: 0.1 19.04.2002 Ensimmäinen luonnos. Peter Lindroos 0.2 26.04.2002 Toinen luonnos. Vesa Teikari 0.3 02.05.2002 Kolmas luonnos. Peter Lindroos Helsinki, 3. toukokuuta 2002 Markus Päivinen Mari Jaakkola Peter Lindroos Tarja Rauste Simo Salmensuu Vesa Teikari HELSINGIN YLIOPISTO Tietojenkäsittelytieteen laitos Ohjelmistotuotantoprojekti Haukka
Sisältö 1 Johdanto 1 1.1 Dokumentin tarkoitus........................ 1 1.2 Tekninen sanasto ja käytetyt lyhenteet............... 1 1.2.1 Rengastuksiin liittyvä sanasto............... 1 1.3 Tekninen sanasto ja lyhenteet.................... 2 2 Vaatimusmäärittely, suunnittelu ja niihin tehdyt muutokset 3 2.1 Vaatimusdokumentti........................ 3 2.2 Suunnitteludokumentti....................... 3 3 Toteutusratkaisut 3 3.1 Ratkaisun filosofia ja toteutuksen toimintaperiaate......... 3 3.2 Käytetyt ohjelmointikielet..................... 4 3.3 Käytetyt luokkakirjastot ja ajurit.................. 4 4 Järjestelmään toteutetut uudet luokat 4 4.1 tipu.servlet.renpal.................... 4 4.2 tipu.servlet.retyyllapito............... 5 4.3 tipu.servlet.lasarjat................... 5 4.4 tipu.servlet.renkir.................... 5 4.5 tipu.servlet.krselaus................... 6 4.6 tipu.servlet.varejakelu................. 6 4.7 tipu.servlet.rehirrus................... 6 4.8 tipu.servlet.tahirrus................... 6 4.9 tipu.servlet.rengastajat................ 6 4.10 tipu.servlet.maat...................... 6
2 4.11 tipu.servlet.laanit.................... 6 4.12 tipu.servlet.lylalue................... 6 4.13 tipu.servlet.euring.................... 7 4.14 tipu.servlet.renkesupd.................. 7 4.15 tipu.servlet.lajiupd................... 7 4.16 tipu.servlet.sanasto................... 7 4.17 tipu.servlet.lintuasemat................ 7 5 Aikaisempaan toteutukseen tehdyt muutokset 7 5.1 Menu................................ 7 6 Toteuttamatta jääneet piirteet ja parannusehdotukset 8 6.1 Popup-valikko............................ 8 6.2 Virheiden korjaus.......................... 8
1 1 Johdanto 1.1 Dokumentin tarkoitus Ohjelmistotuotantoprojekti Haukka jatkoi Tipu4- ja Tintti-projektien työtä graafisen käyttöliittymän, WWW-Tipun, toteuttamiseksi lintujenrengastusjärjestelmään. Järjestelmä on käytössä Helsingin yliopiston Luonnontieteellisen keskusmuseon Rengastustoimistossa. Haukka-projektissa seurattiin Tipu4:n käyttöliittymäsuunnitelmaa ja toteutusmallia ja jatkettiin WWW-Tipu:n kehitystä Tintti-projektin mallin mukaisesti. Tässä dokumentissa kuvataan Haukka-projektin tekemät lisäykset ja muutokset lintujenrengastusjärjestelmän WWW-käyttöliittymään. Tarkempi kuvaus toteutetuista Java-luokista löytyy järjestelmän Javadoc-dokumnetaatiosta [xx]. Muiden osien dokumentaatio on kuvattu Tipu4- [xx] ja Tintti-projektin [xx] dokumenteissa. 1.2 Tekninen sanasto ja käytetyt lyhenteet 1.2.1 Rengastuksiin liittyvä sanasto Kontrolli Rengastajien suorittama lintuhavainto. Kontrollit tehdään pesiltä lintuja pyydystämällä tai esimerkiksi kiikaroinnilla. Löytö Ennestään rengastetun linnun kohtaaminen. Lintu voi olla elävä tai kuollut. Rengastaja on lintuharrastaja joka on oikeutettu ja koulutettu merkitsemään lintuja virallisilla linturenkailla. Rengastus Uuden renkaan laittaminen linnulle, jolla ei ennestään ole rengasta. Tapaaminen Ennestään rengastetun, elävän linnun kohtaaminen.
2 1.3 Tekninen sanasto ja lyhenteet Check Fortran kielinen ohjelma, joka huolehtii rengastuksiin ja tapaamisiin liittyvien tietojen tarkastuksista. Connection pool Ohjelmointiratkaisu, jolla voidaan rajata yhteydet johonkin tiettyyn resurssiin. Näitä yhteyksiä luodaan ja jaetaan asiakkaille dynaamisesti. JDBC-ajuri Java DataBase Connectivity - ajuri, mahdollistaa tietokantakutsut palvelinsovelmista. Mallipohja Käyttöliittymänäytön runko (Template), johon voidaan lisätä ohjelmallisesti vaihtuvia arvoja. Servlet on Javalla kirjoitettu ohjelmamoduuli, joka suoritetaan palvelimella, palvelinsovelma. SQL Structured Query Language. Standardi kyselykieli, jolla määrittetään erilaisia tietokantaoperaatioita. Tipukanta Eläinmuseossa käytettävä relaatiotietokanta rengastustietojen säilyttämiseen. WWW World Wide Web, maailmanlaajuinen tietoverkko. WWW-Tipu Tässä dokumentissa kuvattu graafinen käyttöliittymä lintujen rengastustietokannalle. Servlet Javalla kirjoitettu ohjelmamoduuli, joka suoritetaan palvelimella.
2 Vaatimusmäärittely, suunnittelu ja niihin tehdyt muutokset 3 Projektin vaatimukset ovat määritelty dokumentissa Graafinen käyttöliittymä lintujen rengastusjärjestelmään Vaatimusdokumentti (versio 1.3) [x]. Suunnittelu on kuvattu dokumentissa Graafinen käyttöliittymä lintujen rengastusjärjestelmään Suunnitteludokumentti (versio) [x, x]. 2.1 Vaatimusdokumentti 2.2 Suunnitteludokumentti Toteutus on tehty suunnitteludokumentin määrittelyjen mukaan. 3 Toteutusratkaisut 3.1 Ratkaisun filosofia ja toteutuksen toimintaperiaate Kuhunkin käyttöliittymän näyttöön liittyy yksi mallipohja, Java-Servlet sekä JavaScriptkoodi. Servlet-ohjelma vastaa toiminnallisuudesta ja palauttaa tietoa käyttäjälle. Tähän servlet käyttää apunaan mallipohjaa lomakkeen muodostami-seen johon servletin tuottama tieto ripustetaan. Lomakkeen ulkoasun määrittelyyn käytetään css-tyylimäärittelyjä, jotka liitetään lomakkeeseen käyttäjän selaimes-sa. Ennen lomakkeelle syötettyjen tietojen lähettämistä takaisin servletille tehdään tarkistus JavaScript-funktioilla. Ohjelmaan kuuluu myös yleiskäyttöisiä moduuleja, joilla hoidetaan mm. yhteydet tietokantaan.
4 3.2 Käytetyt ohjelmointikielet Servletit kirjoitettiin Java 1.2 [12, 2] -standardin mukaisesti. Lähdekoodi kommentoitiin siten, että siitä voidaan generoida Javadoc [13] -dokumentaatio [8]. Selaimessa tehtävät tarkistukset ja alasvetovalikko on toteutettu JavaScriptillä. 3.3 Käytetyt luokkakirjastot ja ajurit Näytöt laadittiin ilmaisen (GPL) FreeMarker-kirjaston avulla [3, 11]. Alasvetovalikko on toteutettu osoitteesta http://www.brainjar.com saa-tavissa olevalla Navigation Bar -sovelluksella, jonka lähdekoodi ja dokumentaatio ovat tiedostossa navbar.zip. Oracle 8i:n JDBC-ajurista on käytössä versio 8.1.7 for Java 1.2.x. 4 Järjestelmään toteutetut uudet luokat Kaikki projektin toteuttamat luokat ovat laajennuksia tipu.servlet.tipuservlet yläluokkaan. Tässä kappaleessa kuvataan vain ne ratkaisut, jotka poikkeavat yliluokan tarjoamista palveluista. tipu.servlet.tipuservlet luokka on kuvattu Tintti-projektin toteutusdokumentissa [tipu4tot, Kappale 3.9]. 4.1 tipu.servlet.renpal Luokka RenPal huolehtii rengastajille jaettujen renkaiden selailusta ja käyttämättä jättämien palautuksesta. Kohdetauluna on JAKELU. Servletti on toteutettu sikäli muista näytöistä poikkeavasti, että siinä Palautustoiminto suorittaa Update-operaation, joka kuitenkin ohittaa tipu.servlet.tipuservlet
5 yliluokan update toiminnon. Kaikki tarpeelliset tarkistukset ja lisäysoperaatiot suoritetaan douprateprehook metodissa. 4.2 tipu.servlet.retyyllapito Luokka ReTyYllapito huolehtii rengassarjojen hausta, lisäyksestä, poistosta ja ylläpidosta. Kohdetauluna on RENGAS. Koska rengassarjat ovat välejä (tietokannassa RGTUNNUS1 ja RGTUNNUS2), joudutaan tämän taulun ylläpidossa huomioimaan lisäyksen yhteydessä, etteivät uudet sarjat mene vanhojen kanssa päällekkäin: Poiston yhteydessä on tarkistetaan, ettei jotakin välin rengasta ole jo jaettu tai rengastettu. 4.3 tipu.servlet.lasarjat 4.4 tipu.servlet.renkir Luokka RenKir huolehtii rengastajille jaettujen renkaiden selauksesta ja hävinneiden/ tuohoutuneiden renkaiden merkitsemisestä. Kohdetaulu on RENGASTUS.
6 4.5 tipu.servlet.krselaus 4.6 tipu.servlet.varejakelu 4.7 tipu.servlet.rehirrus 4.8 tipu.servlet.tahirrus 4.9 tipu.servlet.rengastajat Luokka rengastajat huolehtii rengastajatietojen ylläpidosta. Kohdetaulu on REN- GASTAJA, johon myös kaikki tietokantaoperaatiot kohdistuvat. 4.10 tipu.servlet.maat Luokka Maat huolehtii maiden hausta, lisäyksestä, päivityksestä ja poistosta. Kohdetaulu on OSOITEMAA, johon myös kaikki tietokantaoperaatiot kohdistuvat. 4.11 tipu.servlet.laanit Luokka Laanit huolehtii läänitietojen ylläpidosta. Kohdetaulu on LAANI, johon myös kaikki tietokantaoperaatiot kohdistuvat. 4.12 tipu.servlet.lylalue Luokka Maat huolehtii Lyl-alueiden ylläpidosta. Kohdetaulu on LYL_ALUE, johon myös kaikki tietokantaoperaatiot kohdistuvat.
7 4.13 tipu.servlet.euring Luokka Maat huolehtii maiden hausta, lisäyksestä, päivityksestä ja poistosta. Kohdetaulu on OSOITEMAA, johon myös kaikki tietokantaoperaatiot kohdistuvat. 4.14 tipu.servlet.renkesupd Luokka RenKesUpd huolehtii rengaskeskusten hausta, lisäyksestä, päivityksestä ja poistosta. Kohdetaulu on RENGSTUSKESKUS. 4.15 tipu.servlet.lajiupd Luokka LajiUpd huolehtii lajien hausta, lisäyksestä, päivityksestä ja poistosta. Kohdetaulu on LAJI. 4.16 tipu.servlet.sanasto Luokka Sanasto huolehtii SANASTO tietokantataulun tietueiden ylläpidosta. 4.17 tipu.servlet.lintuasemat 5 Aikaisempaan toteutukseen tehdyt muutokset 5.1 Menu Valikon todettiin toimivan väärin Internet Explorer 6.0:n eri versioilla, joten se vaihdettiin uuteen (HV Menu (c) Ger Versluis 2000) ja määriteltiin sen parametrit muistuttamaan vanhaa valikkoa mahdollisimman paljon.
6 Toteuttamatta jääneet piirteet ja parannusehdotukset 8 Projektin aikana tuli esille useita parannusehdotuksia ja joitakin edellisten projektien huomaamattajääneitä virheitä, joita ei ajanpuutteen vuoksi kyetty korjaamaan. 6.1 Popup-valikko Popup valikon katsottiin olevan liian hidas latautumaan. Lisäksi se, että popup-servletti hakee kaikki koskaan tarvitsemansa tiedot kerralla muistiin, todettiin olevan huono ratkaisu silloin, kun on juuri lisätty uusi tietue ja pitäisi saada se popup-listaukseen. Tähän ehdotettiin ratkaisuksi uudelleenohjelmointia, jossa tietokannan tiedot haettaisiin aina kyselyn yhteydessä vain siitä taulusta johon kysely kohdistuu. Kun hakutulosten listauksessa saadaan yli 100 tietuetta, pitäisi lause "löytyi 100 sanaa"korvata lauseella "löytyi ainakin 100 sanaa". Siniset viivat (HR elementit) pitää vaihtaa siniseen viiva-imageen. Värirenkaiden jakeluun pitää lisätä 80 merkkiä pitkä kommenttikenttä. Värirengastusten kommenttikenttää pitää pidentää ja lisätä uusina kenttinä jalkarenkaan rengastajan numero ja nimi, sekä värirenkaan rengastajan numero ja nimi. 6.2 Virheiden korjaus Tintti-projektin koodiin oli jäänyt muutama ohjelmointivirhe, joiden korjaamiseen aika ei riittänyt.
9 Rengastusten syöttö -lomakkeessa alempi Pvm kenttä ei toimi oikein. Taulujen INPUT-kentät näkyvät IE 6.0:ssa keskitettynä. Tietokantataulut Ohjelmakoodit (A) liitteenä omissa tiedostoissaan: alkokrunni@/home/local/haukka/jserv/servlet/*.java Viitteet [tipu4tot] TIPU4-PROJEKTIRYHMÄ: Toteutusdokumnetti http: www.cs.helsinki.fi/group/tipu4/implementationspec/toteutus.html