kalleprkl / tsoha-bootstrap

Tietokantasovellus-kurssin aloituspaketti

Tutkimusaineiston keräys

Huom! Työn aihe vaihtunut!

Yleisiä linkkejä:

• Linkki sovellukseeni Käyttäjätunnus: heebo Salasana: salis
• Linkki dokumentaatiooni

Työn aihe

Tutkimusaineiston keräys

Käyttöliittymän hahmotelmia

Kohteiden listaus Kohteen tarkastelu Kohteen muokkaus Näytteenottopaikan tarkastelu Näytteenottopaikan Muokkaus Raportin tarkastelu Raportin muokkaus Näytteen muokkaus Tutkijan raporttien listaus

tsoha-bootstrap's Issues

Koodikatselmointi

Projekti ladattu 3.1.2017 kello 00:09

Yleistä

Koodia katselmoidessani projekti oli selkeästi 2-viikon palautuksen jälkeisessä vaiheessa, eli esimerkkisivut olivat vielä staattisia eikä php-koodia ollut vielä juurikaan. En siis koodin laadusta keksinyt paljoa kommentoitavaa, hyvältä näyttivät nuo perustat mitä projektiin oli luotu, ja ohjeita oli nähdäkseni seurattu tarkkaan.

Palaute koodista

Lähinnä tartuin kommenteissani tietokannan rakenteeseen, jossa oli siis paljon hyvää, mutta en omaa arvovaltaa kommentoida miten yleismaailmallisesti järkeviä ratkaisut olivat. Seuraavassa olen siis lähinnä ottanut esille asioita, joita olisin saattanut tehdä itse toisin. Lue siis kommentit sillä silmällä, etten väitä ehdotusteni olevan parempia kuin omat ratkaisusi, vaan vain erilaisia tulkintoja asiasta.

Kieli

Toivottavasti suomen kielen käyttämisestä ei tule ongelmaa, esim. kontrollerien ja taulujen nimeämisessä. En tiedä miten tiukkoja nimeämiskonventiot ovat, mutta esimerkiksi materiaalin tyyliin "tiedosto games_controller.php, jossa luokka GameController" ei onnistu suomea käytettäessä (ainakaan näyttämättä aika hassulta). Tylsää, mutta oletko harkinnut kääntäväsi koko jutun englanniksi?

Taulujen suhteista ja sisällöistä

Järkevän oloinen jako tauluihin, paria juttua jäin miettimään:
Tässä esityksessä yhteen raporttiin liittyy näytteitä vain yhdestä näytteenottopaikasta. En tunne alan metodologiaa tarkemmin, mutta olen ymmärtänyt, että tarkoituksena on kuitenkin yleensä ottaa useampia näytteitä, ja hieman eri kohdista, jotta saadaan edustava otos. Olisiko ehkä tarkoituksenmukaisempaa, että raporttiin voisi liittyä useampi näytteenottopaikka, eli suhde olisi toiseen suuntaan? Ja ehkä näytteen kuvailu sopisi tällöin raportin sijaan itse näytteeseen, koska odotettavissa on ainakin pieniä eroja?

Näytteen voisi ehkä liittää myös näytteenottopaikkaan? Erityisesti, jos haluat muokata näytteenottopaikan ja raportin suhdetta ehdottamani kaltaiseksi? Siten esimerkiksi jonkin kohteen kaikkia näytteitä pystyisi selaamaan hieman loogisemman oloista tietokantapolkua pitkin.

Koordinaattien tarkkuutta jäin myös miettimään: miten tutkijoiden oletetaan saavan koordinaatit, millä tarkkuudella, ja millainen virhemarginaali on odotettavissa?
Tästä voisi olla apua kun mietit millä tarkkuudella sijainnit haluat: http://gis.stackexchange.com/questions/8650/measuring-accuracy-of-latitude-and-longitude

Konventioista ja koodin luettavuudesta

Tietokantataulujen id-kenttien nimeäminen voisi olla yhdenmukaisempaa. Nyt siellä on esim. Nayte-taulussa "nayte_id", mutta Kenttatutkimusraportti-taulussa "tutkimus_id" (miksei esim. raportti_id? Tai kenttatutkimusraportti_id, ettei koodin lukija ainakaan hämmentyisi nimeämisestä?).

Tiedän että kenttien nimeämisestä on monilla kiivaita mielipiteitä, mutta oletko harkinnut, että nimeäisit id-kentät yksinkertaisesti "id", kuten kurssimateriaalissa on tehty? Niihin koodissa viitatessa kuitenkin käyttänet yleensä myös taulun nimeä.

Toisaalta toisten taulujen primary key -kenttiin viittaamisessa voisi käyttää yhdenmukaista tyyliä; kohde_id, tutkija_id, jne. Nyt koodissa tulee vastaan sellaisia käsitteitä kuin Kenttatutkimusraportti(sijainti), mutta toisaalta Naytteenottopaikka(koordinaatit), joilla viitataan samaan kenttään, joka on Naytteenottopaikka-taulun primary key.

Muita asioita

Harhaudun vähän, mutta Kohde-taulusta tuli mieleen: miten käsitellään samannimiset vesistöt?
Tässä toki auttaa paikkakunnan nimeäminen, mutta paikkakunnan nimissä saa sitten olla tosi tarkkana kun Pyhäjärviä ja Vesijärviä löytyy joka pitäjästä ja joistakin kaksi, joten miten varmistetaan yksikäsitteisyys? Toki näyttenottopaikalla on koordinaatit, mutta jos vesistöt esimerkiksi lisätään bulkkina jostakin toisesta tietokannasta? Tämän ongelman manifestoituminen toki riippuu tietokannan tarkoitetusta käytöstä, ja takerrun tässä vanhana karttahaukkana lillukanvarsiin.

Nillitinilliti-osio:

• koodin sisennykset, ei mitään isoa mutta välillä heittelehtivät vähän. Shift-Alt-F ja Netbeansin editoriasetusten säätäminen auttaa :)

• dokumentaation otsikossa kirjoitusvirhe "Tutkimusaineistoin" -> "Tutkimusaineiston". Joitain muitakin typoja, esim. käyttötapauskaaviossa "Muokaus" -> "Muokkaus". Kokemukseni mukaan ihan hyvä suomen kielen oikeinkirjoituksen tarkistin löytyy täältä: https://oikofix.com/