Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

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

...