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

Ihmisluettava nimi

Sisältö lokalisoidaan käyttötarpeen mukaan eri kielillä, yleensä suomi, englanti ja ruotsi. Eri kieliversioiden tekemisessä tulee hyödyntää tietomallissa määriteltäviä sisällön kieliä. Voit lisätä kielivaihtoehtoja tietomallin tietojen alta. Ihmisluettavissa nimissä ei saa olla kyseiseen kieleen kuulumattomia erikoismerkkejä.

Tekninen nimi

Tekninen nimi määritellään aina aakkosnumeerisesti ja ainoat sallitut merkit ovat pienet ja isot kirjaimet, numerot, sekä alaviiva ja väliviiva. Suositeltava kieli tekniselle nimelle on englanti. Älä käytä sekaisin suomea ja englantia.

Paikallinen tunnus

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. Paikallinen tunnus voi kertoa myös, millä nimellä kenttä on tallennettu tietokantaan.

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 kirjainlyhenteestä. 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

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 tunniste määritellään ns. CamelCase kirjoitusasulla:

Luokan paikallinen tunniste

Luokan paikallinen tunniste on vaihtoehtoinen tekninen tunniste, joka poikkeaa luokan tunnisteesta teknisistä syistä. Paikallisen tunnisteen nimeämisasu voi olla tietojärjestelmäkohtaisen vaatimusten mukainen. Jos luokan paikallinen tunniste on määritelty, kyseinen tunniste näkyy JSON / XML skeemoissa luokan tunnisteen sijaan.

Attribuutin nimeäminen

Soveltamisprofiileissa voi olla kahdentyyppisiä attribuutteja: Uudelleenkäytettäviä attribuutteja ja luokan attribuutteja. Uudelleenkäytettävien attribuuttien nimeämisessä ja dokumentoinnissa on tärkeää, että nimi ja kuvaus eivät liity suoraan mihinkään luokkamääritykseen.

Attribuutin ihmisluettava nimi

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). 

Luokan attribuuttia nimettäessä 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ä, esimerkiksi silloin, jos luokka on denormalisoitu kokoelma Henkilön ja Organisaation tietoja.

Attribuutin tunniste määritellään ns. CamelCase kirjoitusasulla:

  • Alkaa pienellä alkukirjaimella, esim: numberOfPages

Luokan attribuutin paikallinen tunniste

Luokan attribuuteilla voi lisäksi olla vaihtoehtoinen paikallinen tunniste, jota käytetään JSON / XML skeemoissa. Paikallisen tunnisteen nimeämisasu voi olla tietojärjestelmäkohtaisen vaatimusten mukainen.

Assosiaation nimeäminen

Soveltamisprofiileissa voi olla kahdentyyppisiä assosiaatioita: Uudelleenkäytettäviä assosiaatioita ja luokan assosiaatioita. Uudelleenkäytettävien assosiaatioiden nimeämisessä on tärkeää huomioida että assosiaation tulisi olla mahdollisimman uudelleenkäytettävä.

Assosiaation ihmisluettava nimi

Käytä assosiaation nimeämisessä pääsääntöisesti verbejä nykymuodossa (ns. sanakirjamuoto, preesens). 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, roolittava nimi tai muu luokkien välistä suhdetta kuvaava nimi
  2. Jos et keksi verbiä tai luokat ovat käsitteellisistä kokonaisuudesta poikkeavia loogisia rakenteita: Yhdistä lähtö- ja kohdeluokan nimet,
    esim. "Henkilö" - henkilön yhteystiedot ->"Yhteystiedot"
    1. Jos nimi toistuu molemmissa luokissa, käytä kohdeluokan nimeä tai yksinkertaisempaa muotoa,
      esim. "Asunto" -"perustiedot"-> "Asunnon perustiedot"
  3. Jos mallinnat soveltamisprofiilia, joka perustuu olemassaolevaan tietojärjestelmään, yritä välttää hämmennystä käyttämällä projektissa vakiintunutta termistöä

Assosiaation tunniste määritellaan CamelCase kirjoitusasulla:

  • Alkaa pienellä alkukirjaimella, esim: relatedProduct

Luokan assosiaation paikallinen tunniste

Luokan assosiaatiolla voi olla lisäksi vaihtoehtoinen paikallinen tunniste, jota käytetään JSON / XML skeemoissa. Paikallisen tunnisteen nimeämisasu voi olla tietojärjestelmäkohtaisen vaatimusten mukainen.



  • No labels