Kiuru-projektin tietoja

Toni Hilpinen (hilpinen@cc.jyu.fi)
Marko Koivuniemi (koimark@cc.jyu.fi)
Jussi Mäkinen (jusmaki@cc.jyu.fi)
Miika Nurminen (minurmin@cc.jyu.fi)

Versionhallinta

Contents

1  Johdanto

2  Termejä

2.1  Aihepiirin yleisiä termejä

2.2  Teknisiä termejä

3  Toiminnot

3.1  Tilanvarausmoduli salien varausprosessin osana

3.2  Projektin tehtävät

3.3  Aikataulun salliessa toteutettavat

3.4  Jatkokehitykseen jäävät

4  Toteutustekniikat ja työkalut

4.1  JSP-tekniikka

4.1.1  JSP-sivujen käsittelylogiikka

1. JSP-sivun HTTP-parametrit asettavat Handler-pavun vastaavat ominaisuudet (tieto siitä, mitä sivulla tehdään on myös ominaisuutena). HandlerBean hakee tarvittaessa tiedot tietokannasta.
2. Sivun tiedot generoidaan Handler-pavun ominaisuuksien pohjalta.
3. Käyttäjän syöttämät Modify-lomakkeen tiedot lähetetään HTTP-muuttujina JSP-Handler sivulle.
4. HTTP-parametrit asettavat Handler-pavun vastaavat ominaisuudet. Jos syötteet ovat kelvollisia, HandlerBean päivittää tarvittaessa tietokannan tiedot.
5. HandlerBean palauttaa ominaisuuksissaan tiedon, onko päivitys onnistunut ja ovatko syötteet kelvollisia.
6. 
   a) Jos tietojen päivitys ei onnistunut, JSP-Handler ohjaa kutsun takaisin Modify-sivulle ja ilmoittaa käyttäjälle virheistä.
   b) Muuten JSP-Handler ohjaa käyttäjän uudelle sivulle, jossa käyttäjä voi jatkaa.

• JSP-sivut eivät käsittele tietokantaa suoraan. Tarvittaessa tietokannan tietoja voidaan lukea Java-papujen palauttamista RS2-tietojoukkokomponentista.
• Java-pavut eivät ota kantaa tiedon esitystapaan. Poikkeuksena HTMLBean, jonka tarkoituksena on muotoilla HTML-muotoisia merkkijonoja annetusta tietojoukosta.
• JSP-handler -sivuilla ei yleensä tulosteta tietoja, vaan ohjataan käyttäjää eri sivuille riippuen sivun saamista HTTP-parametreista.

4.2  Java-pavut (engl. JavaBeans)

4.3  Tietokanta

5  Käyttöliittymäsuunnitelma

5.1  Sivuhahmotelmat

5.1.1  Varausjärjestelmä

5.1.2  Ylläpitäjän käyttöliittymä

5.2  Havaituista muutostarpeista

6  Tietokantasuunnitelma

6.1  Toteutusratkaisuja

6.1.1  Yhtenäiset tilat ja tilaryhmät

• Saman tilakäsitteen alla voidaan esittää rakennukset, alueet, hallinnolliset tilaryhmät (varausoikeuksien jakoa varten) ja oheisvarattavien varausalueet.
• Kopioimalla tietojen päivitysten yhteydessä kaikki tiedot "alitilasta" "ylitilaan" pystytään tilaryhmiä hakemaan nopeasti.
• Henkilöiden varausoikeudet voidaan yhdistää suoraan "ylitilaan", jolloin varausoikeuksia ei tarvitse luetella erikseen omassa taulussaan.

• Tilat ja tilaryhmät voivat muuttua ja tilatauluun lisätään usein uusia rivejä kalenterimodulista. Seurauksena tilojen päivitysten yhteydessä joudutaan tekemään paljon rekursiivisia hakuja. Lisäksi "alitilojen" kopiointi "ylitilaan" tuo ylimääräisiä rivejä tauluun.
• Päivitettäessä jonkin tilaryhmän tietoja muuttuvat samalla myös vahvistusoikeudet henkilöiltä, joilla on oikeus samaan tilaryhmään. Hallinnollisia tilaryhmiä muokattaessa tämä on yleensä tarkoituskin, mutta ylläpitäjän on huomioitava tämä.
• Tila ja tilaryhmä (alueesta puhumattakaan) eivät ole käsitteellisesti samoja asioita. Tila on nykymäärittelyn mukaan fyysinen ja rajoitettu alue, johon voi liittyä kiinteästi resursseja ja jossa voi olla tapahtumia. Tämä ei päde sellaisenaan rakennuksille, alueille eikä hallinnollisille tilaryhmille etenkään tapahtumien osalta.

6.1.2  Yhtenäiset tilat, tilaryhmät ja resurssit

• Malliin pätevät sellaisenaan edellisen mallin hyvät puolet.
• Korkea abstraktiotaso, vähentää muissa ratkaisuissa olevien taulujen määrää. Esim. erillisiä tauluja tilan ja oheisvarattavan varaukseen ei tarvita
• Mahdollistaa järjestelmän käytön muuhunkin kuin tilojen varaukseen ja tapahtumien sijoitteluun tiloihin. Esim. mikroluokkien koneissa olevat ohjelmistot voisivat olla aliresursseja.

• Malliin pätevät sellaisenaan edellisen mallin huonot puolet.
• Resurssin käsite jää liiankin abstraktiksi resursseja yhdistävien ominaisuuksien osalta. Koska tilaryhmiltä, tiloilta ja resursseilta vaaditaan erilaisia kenttiä, käytännössä kaikki tieto jouduttaisiiin pakkaamaan erillisiin ominaisuus- ja ominaisuustyyppikenttiin. Tämä hidastaa hakujen tekoa ja tietojen päivitystä entisestään.
• Mallin toteuttaminen vaatisi muutoksia olemassaolevaan koodiin Space- ja Resource-taulujen käsittelyn osalta.
• Resurssien hierarkiselle järjestämiselle ei ole ilmennyt selkeää tarvetta.

6.1.3  Tilat, tilaryhmät ja resurssit erillään

• Tilat ja tilaryhmät pidetään erillään. Tilaryhmä voi esittää rakennusta, aluetta tai hallinnollista tilaryhmää ja voi sisältää tiloja tai tilaryhmiä. Tämä vastaa kalenterimodulin EventGroup- ja Event-taulujen rakennetta.
• Sekä salit että oheisvarattavat esitetään Space-taulun avulla. Jokaista oheisvarattavaa vastaa yleensä 1 to 1 -yhteys Resource-tauluun, jossa kuvataan oheisvarattavan tyyppi. Tämä laajentaa Space-taulun käsitteellisen määritelmän tila muotoon sali tai varattava resurssi. Nykyisessä koodissa ei kuitenkaan käytetä resursseja, joten tämä ei tuota muutoksia olemassaolevaan koodiin. Tiloihin liittyvät kiinteät resurssit määritellään Kotka-projektin suunnitelman mukaisesti.
• SpaceGroup- taulua voidaan käyttää apuna oheisvarattavien saatavuutta määrätessä. Tällöin esim. Space-taulun tietue Videoprojektori1/Agora voidaan sijoittaa Agoran saleja kuvaavaan ryhmään ja toisaalta kaikkien Agoran oheisvarattavien listaan. Nämä listat voisivat periaatteessa olla myös vahtimestarien käytössä.
• SpaceGroup-taulussa kuvataan myös hallinnolliset tilaryhmät. Tämä mahdollistaa helposti vahvistusoikeuksien jakamisen aluekohtaisesti useille henkilöille kerrallaan.

• Malli on konkreettinen ja se on helppo toteuttaa.
• Saman tilaryhmäkäsitteen alla voidaan esittää rakennukset, alueet ja hallinnolliset tilaryhmät (varausoikeuksien jakoa varten) sekä oheisvarattavien varausalueet.
• Tilojen ja oheisvarattavien varaus voidaan toteuttaa yhtenäisellä tavalla. Lisäksi yhtä tapahtumaa varten voi helposti sijoittaa useita varauksia.
• Yhteensopivuus nykyisen kannan ja toteutuksen kanssa.

• Mallin toteuttaminen vaatii "ylimääräisiä" tauluja: Tilalla ja tilaryhmällä on oltava omat tyyppitaulunsa
• Päivitettäessä tilaryhmän tietoja muuttuvat samalla myös vahvistusoikeudet henkilöiltä, joilla on oikeus samaan tilaryhmään. Hallinnollisia tilaryhmiä muokattaessa tämä on yleensä tarkoituskin, mutta ylläpitäjän on huomioitava tämä.
• Oheisvarattava ja tila eivät ole käsitteellisesti samoja asioita.
• Rakennusten tai rakennusten osien varaus ei onnistu. Varauskäsite on sidottu yksittäisiin tiloihin ja oheisvarattaviin.

6.2  Tietokohteisiin liittyvistä tiedoista

6.2.1  Resurssipyynnöt

• M to M -suhde EventGroup-tauluun mahdollistaa tietyn resurssipyynnön liittämisen tarvittaessa useampaan tapahtumaryhmään.
• ResurceRequestRecord-taulusta on M to M-suhteet SpaceType-, Resource- ja ResourceRequest-tauluihin. Taululla voidaan määritellä kootusti tiettyyn resurssipyyntöön liittyvät tiedot.
• RequestState-taulu määrittää varauspyynnön tilanteen (esim. pyyntö, käsittelyssä, vahvistettu tai peruttu).
• ContactPerson ilmoittaa resurssipyynnön tekijän, joka voi olla mm. luennoitsija tai amanuenssi.
• Designer on henkilö, jolle tietyn organisaation resurssipyynnöt menevät kootusti (yleensä amanuenssi). Suunnittelijakenttää ei tarvita ResourceRequest-taulussa, vaan se saadaan kurssin järjestävän organisaation kautta. Suunnittelijalla pitää olla vähintään sihteerin käyttöoikeudet.

6.2.2  Saliryhmät

• M to M -suhde SpaceGroup-tauluun mahdollistaa saliryhmien sisällyttämisen osaksi saliryhmää. Nopeussyistä saliryhmien kokoonpanoa päivitettäessä rekursio puretaan auki siten, että kaikki aliryhmien salit sijoitetaan hierarkiassa ylemmillä tasoilla oleviin saliryhmiin.
• M to M -suhteella Space-tauluun luetellaan kaikki saliryhmään liittyvät salit tai oheisvarattavat.
• SpaceGroupType on saliryhmän tyyppi (esim. rakennus, alue, hallinnollinen saliryhmä).
• Saliryhmien käyttöoikeudet määritellään SpaceGroupPerson-taulussa, josta on M to M -suhteet SpaceGroup-, Person- ja SpaceGroupAccessRole-tauluihin. Käyttöoikeuksia ovat oikeus muokata saliryhmän sisältöä (yleensä vain ylläpitäjillä ja henkilökohtaisten saliryhmien perustajilla) sekä varauksen vahvistusoikeus saliryhmän sisältämille saleille. Vahvistusoikeuksia voidaan määritellä eri vahvistustasoilla, ks. luku 6.2.3.

6.2.3  Varaukset

• 1 to M -yhteydet Event- ja Space-tauluihin liittävät varauspyynnön kalenterissa tai opettajan käyttöliittymässä määriteltyyn tapahtumaan. Jos tapahtuma liittyy johonkin kurssiin, saadaan myös kurssitiedot liitettyä tilavaraukseen. Muuten tilavaraus liittyy vain tapahtumaryhmään (esim. kokoustilan varaus). Yhteys Space-tauluun tarvitaan, koska tapahtuma voi olla varattu useampaan saliin.
• Varsinaiset aika- ja paikkatiedot (aloitus- ja lopetusaika, pvm, toistuvuus sekä tieto siitä, onko varauksen kohteena sali vai oheisvarattava) saadaan Event-taulun kautta.
• Kaikki varaukseen liittyvät henkilöt merkitään ReservationPerson-tauluun, josta on M to M -suhteet Reservation, Person ja ReservationRole-tauluihin.
• Varauspyynnön tekijä on käyttöoikeuksiltaan vähintään opettaja, jolla ei ole vahvistusoikeutta haluamaansa saliin.
• Varauksen vahvistaja on henkilö, jolla on oikeus vahvistaa varauspyyntö johonkin saliryhmään. Varauspyyntö saliin tai oheisvarattavaan näkyy kaikkien ko. saliryhmän vahvistajien tiedoissa. Näistä kuka tahansa voi vahvistaa varauspyynnön ja vahvistaja merkitään kantaan (jolloin korkeammalla vahvistustasolla oleva vahvistaja voi vielä muuttaa varauksen tietoja). Jos varauspyynnön tekijällä on saliin vahvistusoikeus, hän voi vahvistaa varauksen suoraan.
• Varaajan yhteyshenkilö on luennoija tai muu vastuuhenkilö tapahtuman pitävältä laitokselta. Jos henkilö ei ole tiedossa, voidaan kantaan merkitä Tuntematon. Tällöin raportteja varten voidaan yhteyshenkilön tilalle merkitä varaajaorganisaation nimi.
• Maksajan yhteyshenkilö on maksajan edustaja, joka on yleensä tapahtuman järjestävästä organisaatiosta (ei pakollinen).
• Varaaja ilmoittaa varaajaorganisaatio. Timmiä käyttäessä varaajaorganisaatio on laitos tai tiedekunta (ei esim. linja).
• Maksaja ilmoittaa maksajaorganisaation, tarvittaessa opintolinjan tarkkuudella. Käyttäjä voi halutessaan merkitä vastuualuekoodin.
• Varauksen tila ilmoittaa, onko varauspyyntö käsittelemättä, vahvistettu tai peruutettu. Jos yhteen tapahtumaan liittyy useampia tiloja tai oheisvarattavia, varauksia käsitellään erillisinä.
• UpdateTime on viimeisimmän varaukseen kohdistuneen muutoksen aika.
• Description on lisätietokenttä, johon esim. varauksen vahvistaja voi merkitä syyn varauksen peruutukselle.

6.3  Varausten sitominen ulkopuoliseen varausjärjestelmään

6.4  Tuki monikielisyydelle

7  Ohjelmakoodissa käytettävät merkinnät

/******************************************************************************
*                             MODULE DESCRIPTION
*******************************************************************************
*
*	NAME: MyBean.java
*	LANGUAGE: Java 2
*	DATE: 25.11.2002
*	AUTHOR: Miika Nurminen, Jyväskylän yliopisto
*
*******************************************************************************
*             COPYRIGHT (C) KIURU-PROJEKTIRYHMÄ
*             Limited rights granted. Please refer to license
******************************************************************************/

/******************************************************************************
*                                  UPDATES
*******************************************************************************
*
* 25.11.2002 Initial release
*
******************************************************************************/

/**
 * This is a test class.
 */
public class MyClass extends ... implements ... {

// Attributes
  /**
   * myBoolean is used for...
   */
  private boolean myBoolean;

// Constructors 
  /**
   * Default constructor for MyClass
   */
  public MyClass() {
  }

// Access methods
  public boolean getMyBoolean() {
    return myBoolean;
  }
  public void setMyBoolean(boolean myBoolean) {
     this.myBoolean=myBoolean;
  }

// Methods
  /**
   * function description
   */
  void executeFunc(...) {
    ...
    // Specific line comment
  }
}

/******************************************************************************
*                  COPYRIGHT (C) KIURU-PROJEKTIRYHMÄ
*             Limited rights granted. Please refer to license
******************************************************************************/

<%@ include file="../shared/header.inc" %>
<%@ page language="Java" import="kotkabeans.*, kolibribeans.*, java.sql.*, 
     kiurubeans.*" session="true" autoFlush="true" isThreadSafe="true"   
     isErrorPage="false" errorPage="../shared/showError.jsp" %>
<jsp:useBean id="error" scope="session" class="kotkabeans.Error" />

<%
/******************************************************************************
*                             MODULE DESCRIPTION
*******************************************************************************
*
*	NAME: template.jsp
*	LANGUAGE: JSP 1.1
*	DATE: 25.11.2002
*	AUTHOR: Jussi Mäkinen, Jyväskylän yliopisto
*
*******************************************************************************
*             COPYRIGHT (C) KIURU-PROJEKTIRYHMÄ
*             Limited rights granted. Please refer to license
******************************************************************************/

/******************************************************************************
*                                  UPDATES
*******************************************************************************
*
* 25.11.2002 Initial release
*
******************************************************************************/
pageContext.setAttribute("checkMethod", "SIMPLE"); 
%>
<%@ include file="../shared/userCheck.inc" %>
<%@ include file="../shared/menus.inc" %>

<h3>Otsikko</h3>
<p>
Tervetuloa, <%=User.getName()%>.
</p>

<table>
<% 
for (int i=0; i<10; i++) {
%>
  <tr><td><%= ... %></td></tr>
<%
}
%>
</table>

<%@ include file="../shared/footer.inc" %>
/******************************************************************************
*                  COPYRIGHT (C) KIURU-PROJEKTIRYHMÄ
*             Limited rights granted. Please refer to license
******************************************************************************/

Lähteet

[1]

Hillebrand Minna, Silván Markus, Vanhanen Antti ja Ylitalo Marko, "Koppelo-projektin projektikansio", Jyväskylän yliopisto, tietotekniikan laitos, 2002.

[2]

Hilpinen Toni, Koivuniemi Marko, Mäkinen Jussi ja Nurminen Miika, "Kiuru-projektin haastatteluraportti", Jyväskylän yliopisto, tietotekniikan laitos, 2002.

[3]

Hilpinen Toni, Koivuniemi Marko, Mäkinen Jussi ja Nurminen Miika, "Kiuru-projektin vaatimusmäärittely", Jyväskylän yliopisto, tietotekniikan laitos, 2002.

[4]

Jaakkola Mia, Juutinen Sanna, Lupari Matti ja Nieminen Mikko, "Kolibri-projektin projektikansio", Jyväskylän yliopisto, tietotekniikan laitos, 2001.

[5]

Lesonen Minna, Pekkanen Hannu, Tawast Tuukka ja Uuksulainen Heikki, "Korppi-projektin projektikansio", Jyväskylän yliopisto, tietotekniikan laitos, 2001.

[6]

Horppu Ismo, Mielityinen Markku ja Vire Markku, "Kotka-projektin projektikansio", Jyväskylän yliopisto, tietotekniikan laitos, 2000.

[7]

Santanen Jukka-Pekka, "tietotekniikan Sovellusprojektien ohje", Jyväskylän yliopisto, tietotekniikan laitos, 2002.

[8]

Santanen Jukka-Pekka, "Opinnäytteiden kirjoittaminen, lyhyt oppimäärä", Jyväskylän yliopisto, tietotekniikan laitos, 2000.