Metaxa (Ohjelmistotuotantoprojekti, syksy 2005)

Ohjelmisto Dokumentaatio Projektiryhmä

1. Ohjelmisto

1.1. Esittely

MAITO (Metadatan Analyysi-, Integraatio- ja Transformaatio-Ohjelmisto) on työkalu metadatan ominaisuuksien tarkasteluun. Ohjelmistolla voi muuntaa erilaisissa formaateissa olevaa metadataa ohjelmiston omaan yhtenäiseen atomilausemuotoon ja muodostaa näin sisääntuodusta metadatasta yhdistellen resurssien ja niiden välisten yhteyksien (esimerkiksi viittausyhteydet) muodostamia verkkoja yksinkertaisilla heuristiikoilla. Tätä muodostettua tietoa voidaan viedä valikoiden eteenpäin analysoitavaksi muissa sovelluksissa. MAITO on ensisijaisesti suunnattu tieteellisten artikkelien bibliografiadatan analysointiin mutta mikään ei rajoita muunkinlaisen metadatan käyttämistä lähdeaineistona.

Ohjelmisto koostuu tekstipohjaisella käyttöliittymällä suoritettavasta tiedon sisään tuonnista (datan keruu ja transformointi) ja yhdistelystä resurssiverkoiksi (integrointi) sekä graafisella käyttöliittymällä suoritettavasta tiedon selaus- ja vientiosiosta.

Tuetut metadataformaatit nykyisessä versiossa ovat XML-muotoinen Dublin Core Simple valikoiduilla Qualified-elementeillä laajennettuna, osa Citeseer-tietokannan oai_citeseer -elementeistä ja ohjelmiston oma pikaformaatti dokumenttien ja nimilistojen kuvaamiseen. Tuetut vientiformaatit ovat Pajek .net -verkkomuoto ja CSV-muotoillut resurssi-/yhteyslistat. Ohjelmointitaitoinen voi laajentaa ohjelmistoa modulaarisesti tukemaan uusia tuonti- ja vientimuotoja.

Ohjelmisto on toteutettu Java-kielellä ja käyttää MySQL:ää tietokantarunkona. Sen pitäisi toimia millä tahansa alustalla jolle on saatavissa Java 5 Standard Edition sekä MySQL versio 5 tai uudemmat.

MAITO on julkaistu Helsingin yliopiston tietojenkäsittelytieteen laitoksen yleisen lisenssisopimuksen mukaisesti GNU General Public (GPL) -lisenssillä. Ohjelman käyttämisen lisäksi kuka tahansa saa vapaasti tutustua ohjelman lähdekoodin ja käyttää sitä tai sen osia omissa ohjelmissaan kunhan tuotokset julkaistaan myös GPL-lisenssin alaisina.

1.2. Ohjelmistojakelu

Asennus- ja käyttöohje - hae tämä erikseen, ei mukana ohjelmistopaketissa (.pdf) (openoffice 1 .sxw)
Ohjelmisto (v1.0.1 - viime tingan bugikorjaus, .zip)
Ohjelmiston lähdekoodi, JUnit-testiluokat ja JavaDoc (v1.0.1 - viime tingan bugikorjaus, .zip)

Lisäksi tarvitset MySQL-tietokantamoottorin:
Versio 5.0.16 Windows (asennusohjelma)
Versio 5.0.16 Linux (.tar.gz)
Ohjelmistoa on testattu näillä versioilla, mutta voit myös tarvittaessa hakea uudemman version tai version jollekin muulle käyttöjärjestelmälle suoraan MySQL:n kotisivuilta

2. Projektidokumentaatio

2.1. Jatkokehittäjille

MAITO ei ole valmis siloteltu tuote vaan lyhyen projektin tiukan aikataulun puitteissa aikaansaama tuotos jossa riittää runsaasti työmaata mahdollisille jatkokehittäjille. Suuresta osasta alunperin toteutettavaksi suunniteltuja vaatimuksia jouduttiin luopumaan matkan varrella joten ehdotusten lisäksi tarjolla on myös konkreettisia suunniteltujakin ominaisuuksia joita voisi alkaa toteuttamaan mikäli niille löytyy joltain taholta tarvetta.

Vaatimusdokumentti (.pdf) (openoffice 1 .sxw)
Suunnitteludokumentti (.pdf) (openoffice 1 .sxw)
Testaussuunnitelma (.pdf) (openoffice 1 .sxw)
Ehdotuksia jatkokehityksen kohteiksi (.txt)

Seuraavat dokumentit ovat projektin aikana syntyneitä suunnitelmia joita ei ole ainakaan täysin hyödynnetty lopullisessa ohjelmistossa ajanpuutteen vuoksi. Niistä voi kuitenkin olla hyötyä jatkokehittäjille.

Käyttöliittymäsuunnitelma (.pdf) (openoffice 1 .sxw)
Käyttöliittymäprototyyppi (.pdf) (openoffice 1 .sxd)

2.2. Projektin sisäinen dokumentaatio

Tämä dokumentaatio lienee hyödyllistä lähinnä tuleville OhTu-projekteille opiksi sekä kurssin johtoryhmälle arvostelussa.

Projektisuunnitelma (.pdf) (openoffice 1 .sxw)
Projektisuunnitelman liite 1: aikataulu (.pdf)
Päättöanalyysi (.pdf) (openoffice 1 .sxw)

Kaikki olennainen muihin osastoihin kuulumaton materiaali ryhmän Wikistä on tässä talletettuna HTML-muotoon:

CVS-ohje
JUnit-ohje
EMMA-ohje
Lyhyt koodin tyyliohje
Yksikkötestausesimerkki
OAI-PMH -testistubien dokumentointi
Alustava komponenttianalyysi: Jung
Alustava komponenttianalyysi: OAIHarvester2

Tuntilistat: Väinö, Reima, Antti, Kalle, Oskari, Tuomas, Juuso

2.3. Kokouspöytäkirjat

Syyskuu:
Lokakuu:
Marraskuu:
Joulukuu:
12.09.05
15.09.05
19.09.05
22.09.05
26.09.05
29.09.05
03.10.05
06.10.05
10.10.05
12.10.05 (tr)
17.10.05
17.10.05 (tr)
20.10.05
01.11.05
04.11.05
08.11.05
08.11.05 (tr)
11.11.05
22.11.05
29.11.05
07.12.05
13.12.05

3. Projektiryhmä

3.1. Yleistä

Metaxa-projektiryhmä on yksi Helsingin yliopiston tietojenkäsittelytieteen laitoksen Ohjelmistotuotantoprojekti-kurssilla syksyllä 2005 toimineista projektiryhmistä.

3.2. Ryhmän jäsenet

Ala-Härkönen, Väinö - dokumenttivastaava
Halmetoja, Reima - testausvastaava
Laitinen, Antti - koodivastaava
Pyykkönen, Kalle - projektipäällikkö
Saarekas, Oskari
Tanner, Tuomas - suunnitteluvastaava
Vanonen, Juuso - vaatimusmäärittelyvastaava

3.3. Sidosryhmät

Niinivaara, Olli - asiakas
Salmi, Joni - ohjaaja
Taina, Juha - vastuuhenkilö