Luokka

Alla on annettu yksinkertainen Python-luokka Suorakaide, jossa on luonnollisesti neljä sivua, jotka tässä ovat luokan Viiva ilmentymiä.

class Suorakaide:

   def __init(self, yla, ala, vasen, oikea):
      # koodia ...

   def laskePintaala(self):
     # koodia ....

   def asetaVari(self, vari):
     # koodia ....

Luokkadiagrammissa jokaista luokkaa kuvataan suorakaiteella, jossa on yhdestä kolmeen osiota. Aina ei luokasta tarvitse kertoa enempää kuin sen nimi, joka kirjoitetaan ylimpään osioon. Keskimmäiseen osioon (joka usein jätetään pois), voi listata luokan instanssimuuttujat. Alimpaan osioon tulevat luokan metodit.

Jos vertaat kaaviota ja koodia keskenään, huomaat toivottavasti, että luokkakaaviosta on helppo lukea samat asiat kuin ohjelmakoodista. UML:n muuttujien ja metodien esittämiseen käyttämä notaatio on iloksemme vielä hyvin samankaltainen kuin vastaava ohjelmakoodi. Muuttujien, parametrien ja paluuarvojen tyypit listataan tutulla tavalla kaksoispisteen jälkeen.

Muuttujien ja metodien eteen kirjoitetut miinus- ja plus-merkit kertovat näkyvyydestä.

..admonition:: Näkyvyys Pythonissa

Tähän selitys näkyvyyksistä Pythonin kannalta.

Assosiaatio

Luokkien välisiä suhteita kuvataan luokkakaaviossa kahden luokan välisellä viivalla, johon liitetyt erilaiset nuolenkärjet kertovat millaisesta suohteesta on kyse. Assosiaatiosuhde tarkoittaa tyypilisesti sitä että jonkin luokan instanssimuuttuja viitaa toisen luokan olioon. Tätä suhdetta kuvataan viivalla jossa joko ei ole kärkiä lainkaan, tai sillä on viereisessä kuvassa näytetyn kaltainen avoin kärki.

Viivan kumpaakin päähän voidaan listata multiplisiteetti, eli kuinka monta oliota suhteen kummallakin puolella on. Esimerkissämme suorakaiteella on neljä sivua, ja jos kaksi suorakaidetta sattuu olemaan kyljet vastakkain, voisi sama viiva kuulua kahteen suorakaiteeseen.

Viivan päihin voidaan myös kirjoittaa rooli, eli mikä on kyseisessä päässä suhdetta olevan olion merkitys juuri tässä suhteessa. Esimerkissämme Viiva:t ovat suorakaiteen reunat.

Jos suhteelle haluaisi antaa nimen, voisi keskelle viivaa kirjoittaa sille oman otsikon. Tästä ei ole materiaalissa mallikuvaa.

viimeisenä, mutta ehkä tärkeimpänä, tulee nuolenkärki. Navigability -nuolenkärki korostaa mihin suhtaan luokkien välinen suhde osoittaa. Esimerkissämme Suorakaide-luokasta viitataan Viiva-olioihin, mutta Viiva-olioista ei ole viittausta takaisin. Tällä on merkitystä, kun ruvetaan tutkimaan, mitä suunnitellulla allillame voidaan tehdä ja miten jostakin luokasta päästään käsiksi toisen luokan sisältöön.

Kompositio ja Aggregaatio (kompositio ja kooste)

Kompositio ja aggregaatio kuvaavat, että jokin koostuu pienemmistä osasista. Jos ”pääolioon” kohdistetaan operaatioita, ne kohdistuvat jollain tavoin myös sen osasiin. Tällaista suhdetta merkitään “salmiakkisymbolilla”, joka merkitään suhteen “painavampaan” päähän, eli luokkaan, jonka oliot jollain tavoin sisältävät suhteen muita olioita.

“Neliö koostuu viivoista, jos neliö poistetaan viivatkin häviävät.”

“Pari koostuu yksilöistä, jos pari purkautuu, yksilöt säilyvät silti.”

Aggregaatiolla on tarkoitus ensisijaisesti korostaa millaisesta suhteesta on kyse. Kompositio on aggregaatiota jyrkempi “kooste”, sillä se kertoo myös suhteessa olevien olioiden olemassaolosta. Ylläoleva kuva kuvateksteineen selventää suhteiden eroa. Suhteista vahvempaa, kompositiota, merkitään mustalla salmiakilla, kun heikompi aggregaatio merkitään täyttämättömällä salmiakilla.

Kompositio ja aggregaatio ovat lisäinformaatiota, joka kannattaa lisätä kun se tuo lisäarvoa, mutta joka voidaan tarvittaessa korvata tavallisella assosiaatiolla. “If in doubt - leave it out.”

Riippuvuus

Riippuvuus on suhde, jossa jokin luokka tarvitsee tai käyttää toista luokkaa jonkin toimintansa osana. Tällaisten riippuvuuksien dokumentoiminen kaavioon helpottaa ohjelman muokkaamista tulevaisuudessa, sillä jos jokin luokka muuttuu, niin kaavio näyttää siitä riippuvat luokat joiden toimintaa on syytä tarkastella.

Riippuvuutta merkitään assosiaationuolen kaltaisella merkinnällä, jossa nuolen varsi merkitään katkoviivalla.

Perintä

Perintäsuhdetta merkitään luokkakaaviossa nuolella jonka kärki on täyttämättön kolmio. Nuolet osoittavat aina yliluokkaa kohden.

Ylläolevasta kuvasta nähdään, että Nelio on kuvio, jolla on yleisestä kuviosta poiketen tarkalleen neljä reunaa. Periytymistä käsiteltiin materiaalin luvussa 6.4 ja jos vilkaiset sinne, huomaat että käytimme UML-notaatiota myös siellä.

(Kumppani)oliot

Yksittäisiä olioita voi luokkakaaviossa esittää lähes samalla notaatiolla kuin luokkiakin. Olion erottaa luokasta siitä, että sen otsikko on alleviivattu ja mahdollisesta kaksoispisteestä sen nimen edessä.

Rakenteellinen rekursio ja useampi suhde olioiden välillä

Allaolevassa kuvassa esitetään luokkakaavio sukupuusta. Yksittäisellä Ihmisellä on suhteita toiseen ihmiseen, jotka ovat joko hänen lapsiaan tai vanhempiaan. Tässä suhteet erotetaan toisistaan rooleilla “lapset” ja “vanhemmat”.

Kahden olion välillä voi olla myös samanaikaisesti useampi suhde. Tällöin vastaavien luokkien väliin piirretään useampi suhde, jotka voidaan (kuten rekursioesimerkissämme) erottaa toisistaan käyttäen joko rooleja tai nimeämällä suhde.

Ylläolevassa kaaviossa pankin asiakkaalla on omia tilejä, sekä muiden tilejä johin on annettu käyttöoikeus.

Oliko siinä kaikki?

Noh. Käytännössä kaikki oleellinen ainakin. Lisäksi löytyy vielä joukko pienempiä detaljeja joita tarvitaan harvemmin, kuten suhteiden välisiä rajotteita tai suhteisiin liittyviä luokkia jne.