...
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 tekninen nimitunniste määritellään ns. CamelCase kirjoitusasulla:
- Tekninen nimi alkaa aina isolla alkukirjaimella, esim. Person
- Useamman sanan yhdistelmä esim. SalesContract
- Luokan teknisestä nimestä muodostetaan yksilöivä URI-tunniste, esimerkiksi: http://uri.suomi.fi/datamodel/ns/myexample#Person
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).
Nimessä 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 tekninen nimitunniste 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".
- Yritä keksiä assosiaatiolle verbimuotoinen nimi, roolittava nimi tai muu luokkien välistä suhdetta kuvaava nimi
- 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"- Jos nimi toistuu molemmissa luokissa, käytä kohdeluokan nimeä tai yksinkertaisempaa muotoa,
esim. "Asunto" -"perustiedot"-> "Asunnon perustiedot"
- Jos nimi toistuu molemmissa luokissa, käytä kohdeluokan nimeä tai yksinkertaisempaa muotoa,
- Jos mallinnat soveltamisprofiilia, joka perustuu olemassaolevaan tietojärjestelmään, yritä välttää hämmennystä käyttämällä projektissa vakiintunutta termistöä
Assosiaation tekinen nimi 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.