Sisällysluettelo

1. Johdanto
1.1. Määritelmiä

2. Järjestelmän yleiskuvaus
2.1. Yleiskuvaus järjestelmän toiminnasta
2.2. Käyttäjät
2.3 Toteutusvälineistä
2.4 Liittyminen ympäristöön

3. Reunaehdot
3.1. Java Serializable-rajapinta
3.2. Java Cloneable-rajapinta
3.3. Java RMI-kutsu
3.4. Järjestelmän liittyminen ympäristöön
3.4.1 File_IO-rajapinta
3.4.2 Trakla-palvelimen hakemistohierarkia
3.5 DSDL-kieli

4. Arkkitehtuurin kuvaus
4.1 Modulaarisuus
4.2 Korkean tason luokkamalli
4.2.1 GUI-luokka
4.2.2 Representation-luokat
4.2.3 Tietorakenne-luokat
4.2.4 Animaattori-luokka
4.3 Tapahtumien käsittely
4.4 Nimeämiskäytäntö

5. Rajapintahierarkia
5.1 GUI
5.2 Representation - Esitysmuoto
5.2.1 Esitysmuotojen toteuttamat rajapinnat
5.2.2 Esitysmuotojen käyttämät rajapinnat
5.3 Data Structure - Tietorakenne
5.3.1 Tietorakenteiden toteuttamat rajapinnat
5.3.2 Tietorakenteiden käyttämät rajapinnat
5.4 Animator - Animaattori
5.4.1 Animaattorin toteuttamat rajapinnat
5.4.2 Animaattorin käyttämät rajapinnat

6. Moduulien toteutuksen kuvaus
6.1 GUI
6.2 Esitysmuodot
6.3 Tietorakenteet
6.4 Animaattori

1. Johdanto

Ohjelmatyönä toteutettava järjestelmä tulee liittymään olennaisena osana TKO-laboratoriossa käynnissä olevaan LEAD-projektiin (Learning Environment for Algorithms and Data Structures), jossa tarkoituksena on rakentaa kohtuullisen kattava WWW-pohjainen tietorakenteiden ja algoritmien oppimisympäristö, johon kuuluu harjoitustehtävien lisäksi myös muuta opiskelumateriaalia. Järjestelmän on tarkoitus hyödyntää vahvasti hypermedian mahdollisuuksia ja ennenkaikkea etsiä hypermediasta uusia oppimista edesauttavia ominaisuuksia. Opiskelumateriaalin lisäksi järjestelmän on tarkoitus kattaa myös kurssin hallinnointiin liittyviä seikkoja aina ilmoittautumisesta palautteen keräämiseen saakka. Projektissa koko hanketta on lisäksi tarkoitus evaluoida pedagogisesta näkökulmasta ja pohtia millaista opetuksellista ja oppimisen kannalta keskeistä lisäarvoa se tuo mukanaan.

OLIO-TRAKLA on osa WWW-TRAKLA- konseptia; sitä tarkoitus käyttöä lähinnä kurssin Tik-76.122 Tietorakenteet ja algoritmit harjoitustehtävien automaattiseen jakeluun, vastaanottoon ja tarkastamiseen, sekä kurssin hallinnointiin. Siihen on tarkoitus liittää myös jossain määrin opintomateriaalia mm. linkkien ja viitteiden muodossa. Enin osa opintomateriaalin tarjonnassa rajautuu kuitenkin OLIO-TRAKLA:n ulkopuolelle.

Ohjelmatyönä toteutettava järjestelmä TRAKLA-EDIT on osa OLIO-TRAKLA -järjestelmää (kuva 1). Kyseessä on sen WWW-pohjainen käyttöliittymä, eli asiakaspään sovellus joka kommunikoi TRAKLA-palvelimen kanssa.
 
 

1.1 Määritelmiä

2. Järjestelmän yleiskuvaus

2.1. Yleiskuvaus järjestelmän toiminnasta

2.2. Käyttäjät

2.3 Toteutusvälineistä

2.4 Liittyminen ympäristöön

Tarkemmin aiheesta on kerrottu kohdassa 3.4.Järjestelmän liittyminen ympäristöön.

3. Reunaehdot

Opiskelijan tietorakenteelle suorittama ratkaisu tallennetaan animaattori-luokan Client-instanssiin, joka toteuttaa Java Serialization-rajapinnan. Tämä sarjallistettu instanssi tallennetaan palvelimelle, jonne indikoidaan Java RMI-kutsu. Kutsun saatuaan TRAKLA-palvelin ajaa malliratkaisun omaan animaattori-luokan Server-instanssiinsa ja suorittaa vertailun Client- ja Server-instanssien välillä. Animaattori -luokka toteutetaan TRAKLA-EDIT projektin yhteydessä, ja samaa animaattorin toteutusta (kappale 4.4.) käytetään myös TRAKLA-palvelimella.

3.1 Java Serializable-rajapinta

Animaattorin client-instanssin tallentaminen toteutetaan seuraavalla koodilohkolla [6]
:
/*
** serializa animator client instance
*/
FileOutputStream f = new FileOutputStream( "tmp" );
ObjectOutput s = new ObjectOutputStream( f );
s.writeObject( animator.getClientInstance() );
s.flush();

Animaattorin client-instanssin lukeminen toteutetaan seuraavalla koodilohkolla [6]:

/*
** deserialize a animator client instance from a file
*/
FileInputStream in = new FileInputStream( "tmp" );
ObjectInputStream s = new ObjectInputStream( in );
Animator animator = (Animator)s.readObject();
Keskeytykset, jotka sarjallistuva objekti voi aiheuttaa on listattu alla. Kaikki nämä otetaan vastaan ja käsitellään siten, että ohjelman suoritusta pystytään jatkamaan.

• InvalidClassException
• NotSerializableException
• StreamCorruptedException
• NotActiveException
• InvalibObjectException
• OptionalDataException
• WriteAbortedException

3.2. Java Cloneable-rajapinta

Keskeytykset, jotka kloonatta objekti voi aiheuttaa on listattu alla. Kaikki nämä otetaan vastaan ja käsitellään siten, että ohjelman suoritusta pystytään jatkamaan.

• CloneNotSupportedException

3.3. Java RMI-kutsu

Seuraavassa on esimerkki [7], jolla TRAKLA-EDIT pystyy herättämään TRAKLA-palvelimen tarkastusmetodin yksinkertaisella RMI-kutsulla, kun opiskelija on tallentanut sarjallistetun animaattorin TRAKLA-palvelimen levylle omaan hakemistoonsa:
 

/**************************************************************
** interface definition for server startCheckProcedure() method
**************************************************************/
public interface TRAKLA_server_interface extends java.rmi.remote
{
int startCheckProcedure() throws java.rmi.RemoteException;
}

/************************
** code for TRAKLA_server
************************/
import java.rmi.*;
import java.rmi.server.UnicastRemoteObject;

public class Trakla_server extends UnicastRemoteObject implements TRAKLA_server_interface
{
private String name;

public Trakla_server( String userId )
{
super();
}
public void startCheckProcedure()
{
/*
** check submitted exercise
*/
}
public static void main( String args[] )
{
/*
** create and install security manager
*/
}

/*************
** TRAKLA-EDIT
*************/
import java.awt-*;
import java.rmi.*;

public class TRAKLE_EDIT extends java.applet.Applet
{
public void init()
{
try {
TRAKLA_server_interface obj = (TRAKLA_server_interface)Naming.lookup("//" + getCodeBase().getHost()+"TRAKLA_server" );
int result = obj.startCheckProcedure();
} catch (Exception e) {
System.out.println( "TRAKLA_server exception: " + e.getMessage() );
e.printStackTrace();
}
}
}

3.4. Järjestelmän liittyminen ympäristöön

3.4.1. File_IO rajapinta

• LOAD_REQUEST_TIMEOUT - Jos latausoperaationpyynnön kuittaus ei saavu palvelimelta tällä aikavälillä, tulkitaan tapahtuneeksi ATP-kommunikointi virhe.
• SAVE_REQUEST_TIMEOUT - Jos tallennusoperaatiopyynnön kuittaus ei saavu palvelimelta tällä aikavälillä, tulkitaan tapahtuneen ATP- kommunikaatio virhe.
• DIRECTORY_REQUEST_TIMEOUT - Jos hakemisto-operaatiopyynnön kuittaus ei saavu palvelimelta tällä aikavälillä, tulkitaan tapahtuneen ATP-kommunikaatio virhe.
• USER_IDENTIFICATION_TIMEOUT - Jos käyttäjän tunnistamisoperaation kuittaus ei saavu palvelimelta tällä aikavälillä, tulkitaan tapahtuneen ATP-kommunikaatio virhe.
• CONNECTION_TIMEOUT - Jos yhteys TRAKLA-EDIT:in ja palvelimen välillä on auki ja aikaväli ylittyy, katkaistaan yhteys ja käyttäjän on tunnistauduttava uudelleen jatkaessaan kommunikointia palvelimen kanssa.

INTERFACE METHODS

• Object load( String fname ) - Aktivoi yhteyden TRAKLA-palvelimelle ja palauttaa ladattavan objektin TRAKLA-palvelimelta.
• int save( Object l, String fname ) - Aktivoi yhteyden TRAKLA-palvelimelle ja tallentaa objektin l TRAKLA-palvelimelle.
• String [] dir( String path ) - Hakee hakemiston sisällön palvelimelta.
• int errorcode() - Palauttaa viimeksi tapahtuneen virheen koodin.
• void set_userid( String user, String password ) - Asettaa käyttäjätunnuksen File_IO-olioon yhteyden aktivoimista load- ja save-metodeja varten.
• String get_userid() - Palauttaa File_IO-olioon asetetun käyttäjätunnuksen.

3.4.2. TRAKLA-palvelimen hakemistohierarkia

3.5. DSDL-kieli

• Käyttöliittymän tila
• Tietorakenteet
• Animaatiosekvenssit

4. Arkkitehtuurin kuvaus

4.1. Modulaarisuus

• GUI - Graphical User Interface eli graafinen käyttöliittymä toimii käyttäjän graafisesti tekemien toimintojen tulkitsijana. GUI on vastuussa siitä, että se osaa delegoida käyttäjien pyytämät toiminnot kyseessä olevien luokkien oikeille instansseille sekä yhdistää useampaa oliota koskevat toiminnot toimintosarjaksi, josta muodostuu haluttu toiminnallisuus (esim. tehtävien tallennuksessa DSDL-sivun yhdistäminen olioden palauttamista DSDL-alisivuista). GUI:n toimintaa ohjataan valikoilla (LIITE 1: PROCESS MENU EVENT), joista on valittavissa seuraavat toiminnalliset ryhmät:

 

 

TIEDOSTO TOIMINNOT (FILE):

• New - LIITE 1: PROCEDURE FILE EVENT: NEW. Jos käyttäjä ei halua menettää editoitua informaatiota, new-proseduuri tallentaa tietorakenteet, niiden esitysmuotojen sijainnin käyttöliittymässä ja animaattorin sekvenssin DSDL-kieliseksi tiedostoksi palvelimelle. Tämän jälkeen kaikki viittaukset esitysmuotoihin vapautetaan ja animaattorin client-instanssi tyhjennetään. Proseduurin jälkeen TRAKLA-EDIT:in käyttöliittymä on alkutilasssa.
• Open - LIITE 1: PROCEDURE FILE EVENT: OPEN. Open-proseduuri lataa File_IO-olion load-metodin avulla palvelimelta DSDL-kielisen sivun, jonka kuvaamat tietorakenteet ja mahdollinen animaattori sekvenssi palautetaan tilaan, jossa se oli ennen tallennusta tietorakenteiden ja animaattorin putDSDL-metodeilla.
• Close - LIITE 1: PROCEDURE FILE EVENT: CLOSE. Close-proseduuri tallentaa tietorakenteet ja niiden esitysmuotojen sijainnin käyttöliittymässä sekä animaattorin sekvenssin DSDL kieliseksi tiedostoksi palvelimelle. Tämän jälkeen kaikki viittaukset esitysmuotoihin vapautetaan ja animaattorin client-instanssi tyhjennetään. Proseduurin jälkeen TRAKLA-EDIT:in käyttöliittymä on alkutilasssa.
• Save - LIITE 1: PROCEDURE FILE EVENT: SAVE. Tallentaa kaikki oletusesitysmuodoista viitattujen tietorakenteiden tilat DSDL kuvauksena palvelimelle File_IO-olion tarjoaman save-metodin avulla. Jos kyseessä oli esimerkki, tallennetaan myös animaattorin sekvenssi.
• Save As... - LIITE 1: PROCEDURE FILE EVENT: SAVE AS... Toimiin samoin kuin save-proseduuri edellä, mutta käyttäjä voi määritellä tallennettavat DSDL -kuvauksen nimen.
• Check - LIITE 1: PROCEDURE FILE EVENT: CHECK. Tallentaa Java Serializable-rajapinnalla sarjallistetun animaattorin palvelimelle File_IO-luokan save-metodilla. Jos tallennus onnistui virheittä, indikoidaan RMI-kutsu TRAKLA-palvelimelle, jolloin tehtävän tarkastus alkaa.
• Exit - LIITE 1: PROCEDURE FILE EVENT: EXIT exit-proseduuri tallentaa tietorakenteet ja niiden esitysmuotojen sijainnin käyttöliittymässä sekä animaattorin sekvenssin DSDL-kieliseksi tiedostoksi palvelimelle. Tämän jälkeen kaikki resurssit vapautetaan ja käyttäliittymä ikkuna suljetaan. TRAKLA-EDIT on käynnistettävä uudestaan, jos halutaan jatkaa työskentelyä.


MUOKKAUS TOIMINNOT (EDIT):

• Undo - LIITE 1: PROCEDURE EDIT EVENT: UNDO. Palauttaa muutetun objektin tilan GUI:ssa sijaitsevasta undo-puskurista.
• Redo - LIITE 1: PROCEDURE EDIT EVENT: REDO. Suorittaa vastakkaisen toiminnon edilliselle undo-toiminnolle GUI:ssa sijaitsevasta redo-puskurista.
• Cut - LIITE 1: PROCEDURE EDIT EVENT: CUT. Poistaa valitun objektin ja tallentaa sen GUI:ssa sijaitseviin edit- ja undo puskureihin.
• Copy - LIITE 1: PROCEDURE EDIT EVENT: COPY. Tallentaa valitun objektin GUI:ssa sijaitsevaan edit-puskuriin.
• Paste - LIITE 1: PROCEDURE EDIT EVENT: PASTE Siirtää GUI:ssa sijaitsevasta edit-puskurista objektin valittuun kohtaan näytöllä.
• Delete - LIITE 1: PROCEDURE EDIT EVENT: DELETE Poistaa objektin näytältä ja siirtää sen GUI:ssa sijaitsevaan undo-puskuriin.


LISÄYS TOIMINNOT (INSERT):

• Data Structure - LIITE 1: PROCEDURE INSERT EVENT: DATA STRUCTURE. FactoryForDS luo uuden tietorakenteen, joka palauttaa tietorakenteen oletusesitysmuodon. Oletusesitysmuodon paneeli liitetään GUI:n containeriin, jolloin se saadaan aktiiviseksi näytölle. Esitysmuoto tallennetaan GUI:ssa sijaitsevaan esitysmuoto-listaan, josta se voidaan poistaa ja sen ominaisuuksia (koko, sijainti) voidaan muokata.
• Representation for Data Structure - LIITE 1: PROCEDURE INSERT EVENT: REPRESENTATION. Lisää näytölle esitysmuodon. Esitysmuoto saadaan näytöllä jo olevalta esitysmuodolta, joka luo sillä olevan tietorakenneviittauksen avulla tietorakenteelle uuden esitysmuodon. Esitysmuoto tallennetaan GUI:ssa sijaitsevaan esitysmuoto-listaan, josta se voidaan poistaa ja sen ominaisuuksia (koko, sijainti) voidaan muokata.


MUOTOILU TOIMINNOT (FORMAT):

• Font - LIITE 1: PROCEDURE FORMAT EVENT: FONT. Muokkaa aktiivisen esitysmuodon kirjaisimen kokoa ja tyyppiä. Koko ja tyyppi kysytään erillisellä dialogilla.
• Size - LIITE 1: PROCEDURE FORMAT EVENT: SIZE. Antaa LayoutManager-oliolle aktiivisen paneelin parametrina, joka pystyy muokkaamaan paneelinen kokoa käyttäjän antaman syötteen mukaan.
• Position - LIITE 1: PROCEDURE FORMAT EVENT: POSITION. Antaa LayoutManager-oliolle aktiivisen paneelin parametrina, joka pystyy muokkaamaan paneelinen sijaintia käyttäjän antaman syötteen mukaan.


ANIMAATTORI TOIMINNOT (ANIMATOR):

• Begin - LIITE 1: PROCEDURE ANIMATOR EVENT: BEGIN. Siirtää animaatiosekvenssin osoittimen sekvenssin alkuun ja tallentaa tietorakenteisiin osoittimen osoittamat kloonit.
• End - LIITE 1: PROCEDURE ANIMATOR EVENT: END Siirtää animaatio sekvenssin osoittimen sekvenssin loppuun.
• Forward - LIITE 1: PROCEDURE ANIMATOR EVENT: FORWARD. Siirtää animaatiosekvenssin osoitinta yhden askeleen eteenpäin ja tallentaa tietorakenteisiin osoittimen osoittamat kloonit.
• Backward - LIITE 1: PROCEDURE ANIMATOR EVENT: BACKWARD. Siirtää animaatiosekvenssin osoitinta yhden askeleen taaksepäin ja tallentaa tietorakenteisiin osoittimen osoittamat kloonit.
• Play - LIITE 1: PROCEDURE ANIMATOR EVENT: PLAY. Näyttää animaatiosekvinssin GUI:n ikkunassa ja siirtää tietorakenteisiin osoittimen osoittamat kloonit, kunnes animaatio loppuu tai käyttäjä keskeyttää sen.
• Delete - LIITE 1: PROCEDURE ANIMATOR EVENT: DELETE. Poistaa animaatiosekvenssistä GUI:ssa "näkyvillä" olevan askeleen. Osoitin siirtyy poistettua askelta edeltäneeseen askeleeseen, ja tietorakenteisiin tallentuvat osoittimen osoittamat kloonit..
• Insert Animator Panel - LIITE 1: PROCEDURE ANIMATOR EVENT: INSERT ANIMATOR PANEL. Lisää animaattorin kontrollipaneelin GUI:n containeriin.


APU TOIMINNOT (HELP):

• Contents - LIITE 1: PROCEDURE HELP EVENT: CONTENTS. Näyttää ohje-ikkunan.
• About Trakla Edit... - LIITE 1: PROCEDURE HELP EVENT: ABOUT. Näyttää "About TRAKLA-EDIT" dialogin.
• Repr - Representation eli esitysmuoto vastaa tietorakenteen piirtämisestä kuvaruudulle. Tietokenteiden alkioiden graafinen käsittely hallitaan esitysmuodossa siten, että tietorakenteita muokataan vasta, kun koko operaatio on suoritettu loppuun. Näin vältetään tietorakenteiden joutuminen epäkonsistenssiin tilaan. Epäkonsistenssilla tarkoitetaan esimerkiksi puun jonkin haaran irtaantumista puusta omaksi puukseen siten, että siihen ei ole enään viittausta alkuperäisestä puusta. Tapahtumien käsittely ja niiden tulkitseminen TRAKLA-EDIT:ssä sekä esimerkkinä käytetyn taulukko (table) -esitysmuodon toiminnallisuus on kuvattu SDL-kaavioina (LIITE 2).
• DS - Data Structure eli tietorakenteet ovat kirjallisuudesta saatavia fyysisiä toteutuksia, jotka voivat olla tehtävänantona tai esimerkkinä. Kaikki ruudulla esitettävät tietorakenteet käyttävät niille toteutettuja oletusesitysmuotoja. Tietorakenteita ovat mm. tekstikentät (esim. tehtävänannon tekstimuotoinen kuvaus), alkutietorakenteet (esim. taulukko alkioita) ja palautettava tietorakenne (esim. jonkin algoritmin mukaan muokattu puu). Tietorakenteiden algoritmit voidaan olio-ohjelmoinnin tyyliä noudattaen toteuttaa erillisinä luokkina, jolloin niiden uudelleenkäyttöaste nousee. LIITE 3 kuvaa esimerkkinä käytettävän tietorakenteen (taulukko) toiminnallisuuden SDL kuvauksena.
• Anim - Animator eli animaattori tallentaa esitysmuodon toteutuksessa valitun semantiikan (COPY, MOVE tai SWAP, kuva 4) mukaan tietorakenteen alkioihin kohdistetut atomiset operaatiot sekvensseiksi. Semantiikoilla saavutetaan tietorakenteen muokkauksessa haluttu toiminnallisuus; kopioidaan alkio, kun se siirretään tietorakenteesta toiseen, siirretäänkö se vai onko kyseessä vaihto-operaatio, jolloin kohde- ja lähdeavain vaihtavat paikkaa. Tallenteen perusteella voidaan tietorakenne palauttaa tilaan, jossa se oli ennen siihen kohdistettua operaatiota. Koska animaattoriin tallennetaan atomiset operaatiot, pystytään ruudulla esittämään animaatio myös operaatioista, jotka koostuvat useammasta atomisesta operaatiosta (esimerkiksi rotaatio). Toteutuksessa käytetään Java-Cloneable-rajapintaa, joka mahdollistaa tietorakenteiden kuvaamisen tietyllä ajan hetkellä. Tätä toimintoa voidaan verrata perinteisten ohjelmointikielten muistilohkon kopioimistoimintoon (kuva 5).

Kuva 4 - Tietorakenne operaatioiden semantiikat
 
 
 
 
 
 

Kuva 5 - Animaattorin Java Cloneable-rajapinnan toteutus

4.2. Korkean tason luokkamalli

4.2.1. GUI-luokka

4.2.2. Representation-luokat

GUI-luokka käyttää näkee vain esitysmuodon, jonka se pystyy liittämään tai poistamaan näytöltä. Tietorakenteen lisäämisen yhteydessä FactoryForDS (kappale 5.1) palauttaa kyseiselle tietorakenteelle määritellyn oletusesitysmuodon. Viittaus tietorakenteeseen annetaan esitysmuodon muodostimessa, jolloin varmistetaan, ettei esitysmuoto yritä koskaan piirtää olematonta tietorakennetta.

Operaatiot, jotka kohdistuvat tietorakenteisiin, kuten uuden esitysmuodon liittäminen tietorakenteeseen, tapahtuu esitysmuodon kautta, jossa on viittaus tietorakenteeseen. Kappaleessa 3.1 esitetyn Java Serialization-rajapinna vuoksi on tarpeellista välttää viittauksia tietorakenteista esitysmuotoihin, koska silloin jouduttaisiin sarjallistamaan koko TRAKLA-EDIT.

Uusien tietorakenteiden ja esitymuotojen toteutuksesta TRAKLA-EDIT ympäristössä käsittelee erilleinen dokumentti Tietorakenteiden toteutus TRAKLA-EDIT ympäristössä.

4.2.3. Tietorakenne-luokat

4.2.4. Animaattori-luokka

4.3. Tapahtumien käsittely

• MenuEvents - Otetaan vastaan GUI:ssa ActionListener-rajapinnan metodeilla.
• MouseEvents - Otetaan vastaan esitysmuoto-luokan instansseissa MouseListener- ja MouseMotionListener-rajapintojen metodeilla, joihin käyttäjän operaatiot kohdistuvat.
• KeyboardEvents - Otetaan vastaan esitysmuoto-luokan instansseissa KeyboardListener-rajapinnan metodeilla, joihin käyttäjän operaatiot kohdistuvat.

4.4. Nimeämiskäytäntö

• Rajapinnat - Rajapintojen nimeämisessä käytetään kuvassa 3 esitettyjä merkintöjä. Niiden tarkoitus on kuvata rajapinnan metodien tarjoamaa toiminnallisuutta. Rajapinnat on käsitelty omasssa kappaleessaan (kappale 4).
• Representation - ei varsinaisesti ole rajapinta, vaan abstrakti luokka, josta kaikki esitysmuodot periytetään. Abstrakti luokka sisältää alustamisen RepresentationPanel-paneelille, joka voidaan liittää GUI:ssa Containeriin.
• Operational - Tietorakenteen operationaaliset metodit esitetään operational-rajapinnassa (esimerkiksi taulukolle Table_operational-rajapinnassa). Tietorakennekohtaiset rajapinnat periytyvät ylimmän tason operational-rajapinnasta.
• Layout - Tietorakenteiden piirtämiseen tarvittavat metodit esitetään layout-rajapinnassa (esimerkiksi taulukolle Table_layout-rajapinnassa). Tietorakennekohtaiset rajapinnat periytyvät ylimmän tason layout-rajapinnasta.
• AnimatorSignal - Animaattori ilmoittaa tämän rajapinnan kautta tietorakenteelle, että sitä on pyydetty siirtymään johonkin edellä tallennettuun tilaan.
• Animator - Tietorakenne tallentaa tilansa operaatioden jälkeen animaattoriin tämän rajapinnan tarjoamien metodien avulla.
• AnimatorControl - Käyttäjä voi ohjata animaattoria GUI:n avulla, joka välittää pyynnöt animaattorille tämän rajapinnan metodien välityksellä.
• Esitysmuodot - Esitysmuodot koostuvat kompositiona (kuva 8) näkymästä (view) ja toiminnallisesta osasta (logic). Näkymä-luokat nimetään _View jälkiliitteellä (esimerkiksi Table_view), jotka käyttävät tietorakenteissa toteutettua Layout rajapintaa (Table_Layout). Toiminnalliset luokat nimetään _Logic jälkiliitteellä (esimerkiksi Table_Logic), jotka käyttävät tietorakenteissa toteutettua Operational-rajapintaa (esimerkiksi Table_Operational).
• Tietorakenteet - Tietorakenteet nimetään niitä kuvaavilla nimillä ja jälkiliitteellä _DS(esimerkiksi Table_DS), lyhenteinä on suotavaa käyttää kirjallisuudesta [2] löytyviä merkintöjä.

Kuva 8 - Esitysmuoto kompositio

5. Rajapintahierarkia

5.1 GUI

5.2 Representation - Esitysmuoto

5.2.1 Esitysmuotojen toteuttamat rajapinnat

Abstrakti Representation-luokka toteuttaa seuraavat metodit:

• getDSDL() - palauttaa DSDL muotoisen alisivun, joka kuvaa GUI:n näkymän esitysmuotojen sijainnin ja koon.
• getDSDSDL() - palauttaa esitysmuodosta viitatun tietorakenteen kuvauksen DSDL muodossa.
• getSupportedRepresentations() - palauttaa esitysmuodon tietorakenteen tuntemat esitysmuodot
• getRepresentationPanel() - palauttaa esitysmuodon käyttämän paneelin, joka voidaan liittää GUI:n containeriin.
• addNewRepresentationForDS() - luo uuden esitysmuodon tietorakenteelle
• changeFont() - muokkaa esitysmuodon käyttämää kirjaisinta ja sen kokoa.

5.2.2 Esitysmuotojen käyttämät rajapinnat

5.3 Data Structure - Tietorakenne

5.3.1 Tietorakenteiden toteuttamat rajapinnat

Esimerkki Operational-rajapinnan perinnästä:

Operational-rajapinta määrittää ainakin seuraavat metodit:

• putDSDL - saa DSDL kuvauksen, jonka perusteella luo tietorakenteen.
• getDSDL - generoi tietorakenteesta DSDL kuvauksen.
• getMyReprNames - palauttaa tietorakenteen tukemien esitysmuotojen nimet.
• addNewRepr - luo tietorakenteelle uuden esitysmuodon.

Esimerkki Layout-rajapinnan perinnästä:

5.3.2 Tietorakenteiden käyttämät rajapinnat

5.4 Animator - Animaattori

5.4.1 Animaattorin toteuttamat rajapinnat

AnimatorControl-rajapinta sisältää metodit:

• getClientAnimator - palauttaa animaattorin client-instanssin.
• getServerAnimator - palauttaa animaattorin serverinstanssin.
• forward - siirtää animaattoria yhden askeleen eteenpäin.
• backward - siirtää animaattoria yhden askeleen taaksepäin.
• begin - siirtää animaattorin animaatiosekvenssin alkuun.
• end - siirtää animaattorin animaatiosekvenssin loppuun.
• play - suorittaa animaatiosekvenssin.
• Delete - poistaa "näkyvillä" olevan askeleen animaatiosekvenssistä
• getAnimatorPanel - palauttaa animaattorin ohjaukseen käytettävän paneelin.

• CloneDS() - tallentaa animaattoriin viitauksen kloonattuun tietorakenteeseen. Metodi käyttää parametrina saamansa tietorakenteen clone-metodin toteutusta kloonauksen suorittamiseen (kappale 3.2).

5.4.2 Animaattorin käyttämät rajapinnat

6. Moduulien toteutuksen kuvaus

6.1. GUI

• Representation - Esitysmuodot luovat paneelin, joka voidaan liittää GUI:n containeriin. Representation-rajapinta määrittelee metodit, joilla esitysmuotoja voidaan hallita GUI valikoiden avulla.
• getRepresentationPanel - metodilla saadaan esitysmuodon paneeli, joka voidaan liittää tai poistaa Layoutista.
• getSupportedRepresentations - palauttaa vektorin, jossa on lueteltu esitysmuodon tietorakenteen tukemat esitysmuodot. Nämä voidaan liittää dynaamisesti valikoihin, joista käyttäjä voi valita halutun esitysmuodon tietorakenteelle.
• addNewRepresentationForDS - palauttaa uuden esitysmuodon halutulle tietorakenteeelle.
• LoginDialog - LoginDialog tunnistaa käyttäjän tarkastaen salasanan oikeellisuuden TRAKLA-palvelimelta. Käyttäjän tunnistetiedot tallennetaan animaattorin client-instanssin UserInformation-olioon.
• showDialog - aktivoi käyttäjätietoja kysyvän dialogin.
• getUserId - palauttaa käyttäjän antamat ja TRAKLA-palvelimelta verifioidut tiedot.
• LayoutManager - Esitysmuodot pystytään sijoittamaan TRAKLA-EDIT ikkunassa ennalta määriteltyihin paikkoihin, ja tämä meta-informaatio tallennetaan istunnon päättyessä, jolloin näkymä on tiedossa, kun TRAKLA-EDIT -istunto aktivoidaan seuraavan kerran. LayoutManager huolehtii tilan varaamisesta ruudulta aktiivisille esitysmuodoille ja mahdollistaa esitysmuodon koon ja sijainnin määrittelemisen.
• addNewPanel - lisää esitysmuodon paneelin GUI:n containeriin layout managerin määrittelemään paikkaan.
• removePanel - poistaa aktiivisen esitysmuodon paneelin GUI:n containerista.
• resizePanel - muuttaa esitysmuodon paneelin kokoa.
• repositionPanel - muuttaa esitysmuodon paneelin sijaintia layoutissa.
• TraklaMenuHandler - Valikoista osa on staattisia eli ne ovat joko käytössä koko istunnon ajan tai eivät lainkaan riippuen valitusta käyttäjäprofiilista (opiskelija, luennoitsija). Osa valikoista puolestaan on dynaamisia, kuten valitut esitysmuodot ja tietorakenteet. Dynaamisten valikoiden ja niihin liittyvien toimintojen hallinta kuuluu TraklaMenuHandler-luokalle. Luokka toteuttaa Java MenuListener-rajapinnan, jolla voidaan kuunnella valikoihin kohdistuneita toiminteita.
• FactoryForDS - Tietorakennetehtaan tarkoitus on kohdistaa uusien tietorakenteiden lisäämisestä aiheutuvat muutokset yhteen luokkaan. Tietorakennetehdas pitää sisällään luettelon toteutetuista tietorakenteista, jonka TraklaMenuHandler voi käydä kysymässä liittäessään valikoita ikkunaan. Kun valikkotoiminto kohdistuu tietorakenteisiin, voidaan tietorakenteen nimi välittää tietorakennetehtaalle, joka osaa luoda tietorakenteesta ja esitysmuodosta uuden instanssin.
• getDSNames - palauttaa vektorin, jossa on järjestelmään toteutettujen tietorakenteiden nimet. Nämä liitetään valikkoon, josta käyttäjä voi liittää ne näyttöön.
• createNewDS - luo valikosta valitun tietorakenteen ja palauttaa sen oletusesitysmuodon. Oletusesitysmuotoa voidaan käyttää myöhemmin esitysmuotoon ja tietorakenteeseen kohdistuviin toiminteisiin.

6.2. Esitysmuodot

Kaksoisbufferointi on paras tapa yhdessä update-funktion kanssa toteuttaa värinätön animaatio. Kaksoisbufferointi tarkoittaa, sitä että on olemassa kaksi erillistä piirtopintaaa, joihin vuorotellen piirretään (p1 ja p2). Kaksoisbufferoinnin toteutus vaatii seuraavat operaatiot [1]:

• Näytetään piirtopinta 1
• Piirretään piirtopinnalle 2
• Viive
• Näytetään piirtopinta 2
• Piirretään piirtopinnalle 1
• Viive

• Representation - Abstrakti luokka, josta peritään kaikki toteutettavat esitysmuodot. Abstraktissa luokassa on toteutettu muodostin, joka luo esitysmuodolle paneelin (RepresentationPanel). Jos luokka toteuttaa oman muodostimen on sen kutsutta tätä muodostinta super-muuttujan avulla.
• action - Tämä metodi on abstrakti, eli sen totetuts on esitysmuotokohtainen. Sitä kutsutaan aina, kun paneeli vastaanottaa hiiri- tai näppäimistötapahtuman. Tapahtumatyypit on määritelty julkisina literaaleina Representation-luokassa. Esitysmuoto voi reagoida halutulla tavalla eri tyyppisiin tapahtumiin. Esimerkkinä on taulukko tyyppisen esitysmuodon SDL-kuvaus: LIITE 2: PROCEDURE TABLE REPRESENTATION ACTION.
• addNewRepresentationForDS - LIITE 2: PROCEDURE ADD NEW REPRESENTATION FOR DS. Representation -luokka sisältää toteutuksen tälle metodille, joka lisää hallussaan olevalle tietorakenteelle parametrina saamansa uuden esitysmuodon ja palauttaa tämän esitysmuodon kutsujalle.
• ChangeFont - LIITE 2: PROCEDURE CHANGE REPRESENTATION FONT. Representation-luokka sisältää toteutuksen tälle metodille, joka muuttaa tietorakenteen esitykseen käytettyä kirjaisimen koko ja tyyliä saamiensa parametrien perusteella.
• getRepresentationPanel - LIITE 2: PROCEDURE GET REPRESENTATION PANEL. Representation-luokka sisältää toteutuksen tälle metodille, joka palauttaa hallussaan olevan RepresentationPanel-instanssin.
• getSupportedRepresentations - LIITE 2: PROCEDURE GET SUPPORTED REPRESENTATIONS. Kysyy hallussaan olevalta tietorakenteelta, mitä esitysmuotoja tämä tukee. Paluuarvona on vektori, joka sisältää mahdolliset esitysmuotojen nimet.
• getDSDL - LIITE 2: PROCEDURE GET DSDL. Luo DSDL-alisivun, joka sisältää DSDL-muotoisen informaation esitysmuodon parametreista.
• getDSDSDL - LIITE 2: PROCEDURE GET DS DSDL Luo DSDL-alisivun, joka saadaan esitysmuodon hallussa olevalta tietorakenteen getDSDL-metodilta.
• RepresentationPanel - RepresentationPanel periytyy Java Panel-luokasta ja toteuttaa Java MouseListener- ja MouseMotionListener-rajapinnat. Luokka käyttää Representation-rajapinnassa määriteltyä action-metodia (LIITE 2: PROCEDURE ACTION) piirtääkseen ruudulle eventin aiheuttaman toiminnon.
• View - View-luokassa on toteutettu tietorakenteen esittämiseen vaadittava logiikka, joka huolehtii tietorakenteen esteettisyydestä ja havainnollisuudesta. Kuvassa 10 esitetyt esimerkit havainnollistavat, että view-luokan metodit ovat tietorakennekohtaisia ja vaativat tietorakenteelta vastaavan Layout-rajapinnan toteuttamista.
• Logic - Logic-luokassa suoritetaan käyttäjän tietorakenteille suorittamien muokkausten kuvaaminen tietorakenteiden operational-rajapintametodikutsuiksi. Kuvassa 13 esitetyt esimerkit esittävät taulukko- tietorakenteen muokkausten kuvauksia Table_Operational-rajapintametodien kutsuiksi.

• getXcoordinate - palauttaa x-koordinaatin johon objekti on sijoitettu.
• getYcoordinate - palauttaa y-koordinaatin johon objekti on sijoitettu.
• getKey - palauttaa objektin tietorakenne avaimen.
• drag - siirtää objektia kaksoispuskurointia käyttäen.

6.3. Tietorakenteet

Tietorakenteilta vaaditaan 3 metodia, jotka liittyvät niiden hallintaan ja niiden esitysmuotojen näyttämiseen TRAKLA-EDIT ympäristössä:

• getDSDL - palauttaa DSDL alisivun, joka kuvaa tietorakenteen tilan.
• putDSDL - alustaa tietorakenteen DSDL alisivulla, joka kuvaa tietorakenteen tilaa, jossa se oli tallennushetkellä.
• getNewRepresentation - palauttaa uuden esitysmuodon tietorakenteelle.
• getSupportedRepresentations - palauttaa tietorakenteen tukemien esitysmuotojen nimet.

Kuva 14 - Tietorakenteet OMT

LIITE 3 - SDL PICTURES FOR TABLE DATA STRUCTURE kuvaa tietorakenteen metodit SDL kuvauksina. Esimerkkinä on käytetty taulukko tietorakennetta.

6.4. Animaattori

Animaattori on toteutettu Singleton Design Pattern [3] -muunnelmalla, jossa on mahdollista luoda kaksi, client- ja server-, instanssia. Client-instanssiin tallennetaan TRAKLA-EDIT:ssä tietorakenteille tehdyt operaatiot ja Server-instanssiin TRAKLA-palvelimella tehty "oikea" vastaus, jota verrataan palautettuun Client-instanssiin.

Animaattorilla on UserInformation-luokan instanssi, jota voidaan käyttää getUserInformation- ja putUserInformation-metodien avulla. Instanssi alustetaan, kun käyttäjä tunnistautuu järjestelmään GUI:n tarjoaman LoginDialog-luokan avulla. UserInformation-luokan informaatio tarvitaan myöhemmin File_IO-metodeissa. Koska UserInformation-instanssiin on viittaus animaattorista, on se myös sarjallistuva ja näin ollen käyttäjää koskeva informaatio siirtyy sarjallistetun animaattorin mukana palvelimelle (kuva 15).

Timer-luokka toteuttaa ajastimen, jota käytetään play-proseduurin yhteydessä. Timer-luokan toteutus saadaan kirjallisuudesta [8], ja se on toteutettu TimerCallback-rajapinta tyyppisenä. Tämä rajapinta määrittelee metodin, jota kutsutaan, joka kerran, kun ajastin laukeaa.

public interface TimerCallBack
{
public void tick();
}
 

• clear - tyhjentää animaattorin sekvenssi vektorin. Tätä metodia kutsutaan kun valikosta on valittu new-, close- tai exit-toiminto.
• cloneDS - tallentaa kuvassa 5 esitetyllä tavalla tietorakenteen kloonin animaattorin vektoriin. Kloonaus tapahtuu kutsumalla parametrina saadun tietorakenteen clone-metodia.
• getDSDL - palauttaa DSDL alisivun, joka kuvaa animaattorin tilan.
• putDSDL - alustaa animaattorin parametrina saamansa DSDL-kielisen alisivun mukaan.
• begin - LIITE 4: PROCEDURE ANIMATOR: BEGIN - siirtää animaattorin sekvenssi-osoittimen osoittamaan ensimmäistä animoitua toimintoa. Tietorakennetta pyydetään AminatorSignal-rajapinnan putClone()-metodin avulla siirtymään animaattorin osoittamaan tilaan.
• end - LIITE 4: PROCEDURE ANIMATOR: END - siirtää animaattorin sekvenssi-osoittimen osoittamaan viimeistä animoitua toimintoa. Tietorakennetta pyydetään AminatorSignal-rajapinnan putClone()-metodin avulla siirtymään animaattorin osoittamaan tilaan.
• forward - LIITE 4: PROCEDURE ANIMATOR: FORWARD - siirtää animaattorin sekvenssi-osoittimen osoittamaan seuraavaa animoitua toimintoa. Tietorakennetta pyydetään AminatorSignal-rajapinnan putClone()-metodin avulla siirtymään animaattorin osoittamaan tilaan.
• backward - LIITE 4: PROCEDURE ANIMATOR: BACKWARD - siirtää animaattorin sekvenssi-osoittimen osoittamaan edellistä animoitua toimintoa. Tietorakennetta pyydetään AminatorSignal-rajapinnan putClone()-metodin avulla siirtymään animaattorin osoittamaan tilaan.
• play LIITE 4: PROCEDURE ANIMATOR: PLAY - suorittaa animaatiosekvessin animaattori-osoittimen ilmoittamasta paikasta eteenpäin. Ruudun välkymisen estämiseksi RepresentationObject-luokassa on toteutettu kaksoispuskurointi. Animaattori käynnistää ajastimen jolla se pystyy kontrolloimaan animaatiosekvinssin suoritusvauhtia.
• delete LIITE 4: PROCEDURE ANIMATOR: PLAY - poistaa animaattorin sekvenssi-osittimen osoittaman animaatioaskeleen sekvenssistä.  Osoitin siirretään poitettua askelta edeltäneeseen askeleeseen. Tietorakennetta pyydetään AminatorSignal-rajapinnan putClone()-metodin avulla siirtymään animaattorin osoittamaan tilaan.
• getAnimatorPanel - palauttaa animaattorin paneelin, joka sisältää graafiset painikkeet animaattorin ohjaukseen.
• getClientInstance - LIITE 4: PROCEDURE ANIMATOR: GET CLIENT INSTANCE - palauttaa animaattorin Client-instanssin.
• getServerInstance - LIITE 4: PROCEDURE ANIMATOR: GET SERVER INSTANCE - palauttaa animaattorin Server-instancssin.

Kirjallisuus viitteet