You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Tietosisältöjen nimeäminen tehdään selkokielisesti hyödyntäen tietoalueen vakiintunutta sanastoa. Luokat, attribuutit ja assosiaatiot nimetään kieliversioituna ihmisluettavasti sekä teknisellä nimellä.

Sisältö lokalisoidaan käyttötarpeen mukaan eri kielillä, yleensä suomi, englanti ja ruotsi. Ihmisluettavissa nimissä ei saa olla kyseiseen kieleen kuulumattomia erikoismerkkejä.

Tekninen nimi määritellään aina aakkosnumeerisesti ja ainoat sallitut merkit ovat pienet ja isot kirjaimet, numerot, sekä alaviiva ja väliviiva. Teknisen nimen lisäksi resurssille voidaan määritellä paikallinen tunnus, joka kertoo, millä nimellä resurssia kutsutaan paikallisessa toteutuksessa. Paikallisen nimen avulla voidaan myös tuottaa XML- tai JSON-skeema erilaisten teknisten nimeämiskäytäntöjen mukaisesti.

Tietomallin nimeäminen

Tietomallille määritellään ihmisluettava nimi ja etuliite. Tietomallin nimen tulee olla mahdollisimman hyvin käyttötarkoitusta kuvaava, esimerkiksi: "Tutkimusinfrastruktuurien tiedonsiirtomääritys". Lisäksi käyttötarkoitusta on hyvä täsmentää tietomallin kuvauksessa.

Etuliite on yksilöllinen lyhyt tunniste, josta muodostetaan tietomallin tekninen nimi, eli nimiavaruus. Tietomallin nimiavaruus on URI-tunnus, jonka avulla tietomallissa määriteltäviin resursseihin voidaan viitata.

Etuliitteen valinta

Etuliitteen määrittely voi tuntua vaikealta uutta tietomallia tehtäessä. Etuliite muodostetaan yleensä tietoalueella tai projektissa yleisesti käytössä olevasta kirjainlyhenne. Etuliitteen määrittelyssä kuitenkin olennaisinta on se, että se on yksilöivä merkkijono. Esimerkiksi "abc" on yhtä hyvä etuliite kuin "henkilo" tai "personinfo". Lyhyt etuliite kuitenkin helpottaa tunnisteen kirjoittamista lyhennetyssä muodossa, esim: abc:Person.  Etuliitettä voi jatkossa vaihtaa tietomallin versioinnin yhteydessä. Etuliitettä vaihdettaessa sekä uusi että vanha malli voivat jatkaa omaa elämäänsä. 

Luokan nimeäminen

Luokan nimi muodostuu yleensä automaattisesti käsitteen termin perusteella. Käsite voi kuitenkin olla luokkaa abstraktimpi, joten luokan nimeä voi tarkentaa. Käytä luokan nimessä substantiiviä ja yksikkömuotoa.

Luokan tekninen nimi määritellään ns. CamelCase kirjoitusasulla:

  • Joskus suhteen (assosiaation) nimeä voi olla vaikea keksiä, jolloin voit käyttää yhdistettä b) lähdeluokan nimi/kohdeluokan nimi. Suhdetta ei tule kuitenkaan nimetä pelkällä kohdeluokan nimellä, koska
    tämä ei lisää mitään malliin ja suhde on toisteinen luokan nimen kanssa. 
  • Voit käyttä vakiintuneet ontologiasuhteita tai suhderooleja: is-a, part-of,  ,,,

Attribuutin nimeäminen

Attribuutit nimetään yleensä yksikkömuodossa. Poikkeustapauksissa attribuutti voidaan nimetä monikossa, jos attribuuttiin tallennetaan useampi tieto, esim. etunimet. Ihmisluettavissa nimissä voi käyttää perusmuodon (nominatiivi) lisäksi genetiiviä (esim. kunnan nimi). 

Nimessä ei kannata toistaa luokan nimeä, esim. "Nimi" ennemmin kuin "Henkilön nimi". Säännöstä saa poiketa jos ei ole selvää mikä "Nimi" on kyseessä esim. jos luokka on denormalisoitu kokoelma Henkilön ja Organisaation tietoja.

Attribuutin tekninen nimi määritellään ns. CamelCase kirjoitusasulla:

  • Alkaa pienellä alkukirjaimella, esim: numberOfPages

Assosiaation nimeäminen

Käytä assosiaatioissa pääsääntöisesti verbejä nykymuodossa. Assosiaation nimi voi olla myös hyvin yleisellä tasolla, esimerkiksi "liittyy" tai "kuuluu". Verbien lisäksi voit käyttää suhderooleja kuten "toimija" ja ontologiasuhteita kuten "on osa". 

  1. Yritä keksiä assosiaatiolle verbimuotoinen nimi tai kuvaava rooli joka kuvaa luokkien välistä semantiikkaa
  2. Jos et keksi verbiä tai luokat ovat käsiteellisistä kokonaisuudesta poikkeavia loogisia rakenteita: Yhdistä Lähtö ja Kohde luokan nimet, esim. "Henkilö" -"henkilön yhteystieto / tiedot"->"Yhteystieto" yksikössä tai monikossa potentiaalisen toistuvuuden (kardinaliteetin) mukaan
  3. Jos nimi toistuu molemmissa luokissa käytä kohdeluokan nimeä tai yksinkertaisempaa muotoa sim. "Asunto" -"perustiedot"-> "Asunnon perustiedot"
  4. Jos mallinnat soveltamisprofiilia perustuen olemassaolevaan tietojärjestelmään yritä vähentää hämmennystä käyttämällä projektissa vakiintunutta nimeämistapaa

Assosiaation tekinen nimi määritellaan CamelCase kirjoitusasulla:

  • Alkaa pienellä alkukirjaimella, esim: relatedProduct
  • No labels