Difference between revisions of "Document:Technische Ontwerp Verkoop"

From WOSI
Jump to navigation Jump to search
m (New page: {{subst:Document}} Document:Technische Ontwerp Verkoop Document:Technische Ontwerp Verkoop [[Category:Verkoop|Document:Technische On...)
 
m
Line 1: Line 1:
 
{{Infobox documentatie
 
{{Infobox documentatie
  | titel            =  
+
  | titel            = Technische Ontwerp Verkoop
  | datum            =  
+
  | datum            = 20070612
  | fase            =  
+
  | fase            = Onafhankelijk
  | versie          =  
+
  | versie          = 0.5
  | status          =  
+
  | status          = Gereed voor kwaliteitscontrole
  | auteurs          =  
+
  | auteurs          = Jeroen van Schagen, Dennis Meelker
 
  | goedgekeurd_door =  
 
  | goedgekeurd_door =  
 
  | aangepast_door  =  
 
  | aangepast_door  =  
 
}}  
 
}}  
  
== Samenvatting ==
+
= Inleiding  =
<<<Schrijf een korte samenvatting van het document>>>
 
  
== <<<Titel 1>>> ==
+
Dit document is het vervolg op het Functioneel Ontwerp voor de Wosi verkoopmodule, echter wordt er in dit document veel dieper ingegaan op de technische structuur van de applicatie.
  
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
In dit document vind je de eerste versie van de datastructuur die we in samenwerking met het database team opgesteld hebben, dit datamodel is nog niet definitief, maar de algemene structuur blijft ongewijzigd. Verder vind je in dit document ook een technische beschrijving van de architectuur binnen de applicatie, bij deze beschrijving horen ook nog een aantal UML diagrammen om de structuur verder te verduidelijken.  
  
== <<<Titel 2>>> ==
+
Ook staat er in dit document een beschrijving van het template systeem dat gebruikt is voor het centraal regelen van de algemene layout van de applicatie.
  
Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.
+
Na het lezen van dit document heeft de lezer een geheel overzicht van de applicatie en hoe deze is opgebouwd.  
  
=== <<<Titel 2.2>>> ===
+
= Sitemap  =
  
Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?
+
Deze sitemap geeft een schematische weergave van de opbouw van de verschillende pagina’s in het verkoop systeem.
  
   
+
[[Image:]]
 +
 
 +
= Datamodel =
 +
 
 +
Dit is het datamodel zoals het opgesteld is door het verkoop-module team, het opstellen is gedaan in overleg met het database team. Het model is in een aantal tabellen verre van compleet omdat we alleen de voor ons relevante velden hebben toegevoegd. De missende velden zullen later door het database team worden toegevoegd.
 +
 
 +
[[Image:|center]]
 +
 
 +
= Applicatiestructuur  =
 +
 
 +
Om het Wosi-platform zo overzichtelijk en onderhoudbaar mogelijk te maken is het project opgedeeld in vier lagen, elke laag heeft zijn eigen verantwoordelijkheid. Deze verschillende lagen worden hier beschreven.
 +
 
 +
== Dao-laag  ==
 +
 
 +
De Dao-laag bevat methodes om domein-objecten uit een databron te laden, zoeken, veranderen en verwijderen. Voor elk Dao object bestaat een interface welke alle functies beschrijft, deze interface maakt het mogelijk om de gehele Dao-laag te vervangen voor B.V. een andere ORM methode. Binnen deze laag wordt enkel data doorgespeeld naar een databron, of de servicelaag; er mag dus geen data aangepast worden. De Dao-laag mag nooit direct gebruikt worden vanuit de frontend; al het dataverkeer moet via de servicelaag gaan, zodat eventuele business-rules niet genegeerd worden.
 +
 
 +
== Servicelaag  ==
 +
 
 +
De Servicelaag ligt boven de Dao-laag, deze bevat functies die business-rules afdwingen en andere functionaliteiten mogelijk maken. Deze laag bevat in ieder geval de functies die ook in de Dao laag voorkomen, maar er kunnen ook extra functies in komen. Omdat de servicelaag boven de Dao-laag ligt kunnen er bewerkingen op de data gedaan worden voordat het via de Dao’s opgeslagen wordt in de gekoppelde databron (denk hierbij aan B.V. aanmaakdatum van objecten) Bij deze laag is hetzelfde principe toegepast als bij de Dao-laag, voor elke service is er een interface, dit maakt het mogelijk om de hele servicelaag te vervangen; en zo dus een andere set business-rules toe te passen.
 +
 
 +
== Domeinlaag  ==
 +
 
 +
De domeinlaag bevat de objectstructuur die nodig is om de data nodig voor het gehele verkoopproces op te slaan. Dit zijn de object die via de servicelaag, en dan via de Dao-laag opgeslagen en opgevraagd worden in de database. Denk hierbij bijvoorbeeld aan een klant met alle bijbehorende gegevens; de objecten in de domeinlaag bevatten dus dezelfde velden als de bijbehorende tabellen in het datamodel.
 +
 
 +
== Frontend  ==
 +
 
 +
De frontend laag bestaat uit de JSP pagina’s, Servlets, javascript bestanden etc. Die de gebruiker voorgeschoteld krijgt bij het gebruiken van de applicatie. Deze laag gebruikt de Service laag om data te verwerken.
 +
 
 +
== Diagrammen  ==
 +
 
 +
Er volgen nu een aantal diagrammen die de structuur van de applicatie schematisch weergeven. Deze diagrammen zijn puur om een beter inzicht in de structuur te geven, en bevatten daarom niet alle methodes en velden die in de echte situatie wel bestaan. Deze keuze hebben we ook gemaakt om de leesbaarheid en het overzicht te behouden.
 +
 
 +
=== De algemene structuur  ===
 +
 
 +
[[Image:|center]]
 +
 
 +
=== De domeinlaag  ===
 +
 
 +
[[Image:|center]]
 +
 
 +
=== De servicelaag  ===
 +
 
 +
[[Image:|center]]
 +
 
 +
=== De Dao-laag  ===
 +
 
 +
[[Image:|center]]
 +
 
 +
<br>
 +
 
 +
== Het Template systeem  ==
 +
 
 +
Om de algemene layout van het Wosi-platform centraal te regelen hebben we een Template-systeem ontworpen. Dit systeem maakt het mogelijk om de basis layout van een webpagina in een los bestand op te slaan. Dit bestand wordt vanuit alle pagina’s gebruikt waardoor een wijziging in het template over de gehele applicatie te zien is.
 +
 
 +
=== Een template maken  ===
 +
 
 +
Een simpel template ziet er zo uit. De twee <nowiki><template:placeholder</nowiki>&gt; tags geven aan welke plekken op de webpagina gevuld moeten worden door andere pagina’s. De tekst tussen de open- en sluittags is de standaardinhoud van een placeholder, deze wordt weergegeven als de placeholder niet gevuld is. Het aangeven van een standaardinhoud is niet verplicht.
 +
 
 +
=== Een template gebruiken  ===
 +
 
 +
Een pagina die gebruik maakt van een template ziet er als volgt uit. Je ziet hier twee content tags die aangeven wat er op de plek van de placeholders uit het template moet komen. De pagina uit het voorbeeld maakt gebruik van het standaard template bestand, maar het is ook mogelijk om een ander bestand te gebruiken, dit doe je door het template attribuut toe te voegen aan de include tag. (B.V. <nowiki><template:include template=”/WEB-INF/.jsp”>)</nowiki>
 +
 
 +
=== De standaard template pagina instellen  ===
 +
 
 +
Het instellen van de standaard template pagina gebeurt in het web.xml bestand, het desbetreffende deel van dit bestand zie je hier.
  
 
[[Category:Document|Document:Technische Ontwerp Verkoop]] [[Category:Fase_Onafhankelijk|Document:Technische Ontwerp Verkoop]] [[Category:Verkoop|Document:Technische Ontwerp Verkoop]]
 
[[Category:Document|Document:Technische Ontwerp Verkoop]] [[Category:Fase_Onafhankelijk|Document:Technische Ontwerp Verkoop]] [[Category:Verkoop|Document:Technische Ontwerp Verkoop]]

Revision as of 12:57, 10 June 2008

Technische Ontwerp Verkoop
Datum 20070612
Fase Fase Onafhankelijk
Versie 0.5
Status Gereed voor kwaliteitscontrole
Auteurs Jeroen van Schagen, Dennis Meelker
Goedgekeurd door
Aangepast door

Inleiding

Dit document is het vervolg op het Functioneel Ontwerp voor de Wosi verkoopmodule, echter wordt er in dit document veel dieper ingegaan op de technische structuur van de applicatie.

In dit document vind je de eerste versie van de datastructuur die we in samenwerking met het database team opgesteld hebben, dit datamodel is nog niet definitief, maar de algemene structuur blijft ongewijzigd. Verder vind je in dit document ook een technische beschrijving van de architectuur binnen de applicatie, bij deze beschrijving horen ook nog een aantal UML diagrammen om de structuur verder te verduidelijken.

Ook staat er in dit document een beschrijving van het template systeem dat gebruikt is voor het centraal regelen van de algemene layout van de applicatie.

Na het lezen van dit document heeft de lezer een geheel overzicht van de applicatie en hoe deze is opgebouwd.

Sitemap

Deze sitemap geeft een schematische weergave van de opbouw van de verschillende pagina’s in het verkoop systeem.

[[Image:]]

Datamodel

Dit is het datamodel zoals het opgesteld is door het verkoop-module team, het opstellen is gedaan in overleg met het database team. Het model is in een aantal tabellen verre van compleet omdat we alleen de voor ons relevante velden hebben toegevoegd. De missende velden zullen later door het database team worden toegevoegd.

[[Image:|center]]

Applicatiestructuur

Om het Wosi-platform zo overzichtelijk en onderhoudbaar mogelijk te maken is het project opgedeeld in vier lagen, elke laag heeft zijn eigen verantwoordelijkheid. Deze verschillende lagen worden hier beschreven.

Dao-laag

De Dao-laag bevat methodes om domein-objecten uit een databron te laden, zoeken, veranderen en verwijderen. Voor elk Dao object bestaat een interface welke alle functies beschrijft, deze interface maakt het mogelijk om de gehele Dao-laag te vervangen voor B.V. een andere ORM methode. Binnen deze laag wordt enkel data doorgespeeld naar een databron, of de servicelaag; er mag dus geen data aangepast worden. De Dao-laag mag nooit direct gebruikt worden vanuit de frontend; al het dataverkeer moet via de servicelaag gaan, zodat eventuele business-rules niet genegeerd worden.

Servicelaag

De Servicelaag ligt boven de Dao-laag, deze bevat functies die business-rules afdwingen en andere functionaliteiten mogelijk maken. Deze laag bevat in ieder geval de functies die ook in de Dao laag voorkomen, maar er kunnen ook extra functies in komen. Omdat de servicelaag boven de Dao-laag ligt kunnen er bewerkingen op de data gedaan worden voordat het via de Dao’s opgeslagen wordt in de gekoppelde databron (denk hierbij aan B.V. aanmaakdatum van objecten) Bij deze laag is hetzelfde principe toegepast als bij de Dao-laag, voor elke service is er een interface, dit maakt het mogelijk om de hele servicelaag te vervangen; en zo dus een andere set business-rules toe te passen.

Domeinlaag

De domeinlaag bevat de objectstructuur die nodig is om de data nodig voor het gehele verkoopproces op te slaan. Dit zijn de object die via de servicelaag, en dan via de Dao-laag opgeslagen en opgevraagd worden in de database. Denk hierbij bijvoorbeeld aan een klant met alle bijbehorende gegevens; de objecten in de domeinlaag bevatten dus dezelfde velden als de bijbehorende tabellen in het datamodel.

Frontend

De frontend laag bestaat uit de JSP pagina’s, Servlets, javascript bestanden etc. Die de gebruiker voorgeschoteld krijgt bij het gebruiken van de applicatie. Deze laag gebruikt de Service laag om data te verwerken.

Diagrammen

Er volgen nu een aantal diagrammen die de structuur van de applicatie schematisch weergeven. Deze diagrammen zijn puur om een beter inzicht in de structuur te geven, en bevatten daarom niet alle methodes en velden die in de echte situatie wel bestaan. Deze keuze hebben we ook gemaakt om de leesbaarheid en het overzicht te behouden.

De algemene structuur

[[Image:|center]]

De domeinlaag

[[Image:|center]]

De servicelaag

[[Image:|center]]

De Dao-laag

[[Image:|center]]


Het Template systeem

Om de algemene layout van het Wosi-platform centraal te regelen hebben we een Template-systeem ontworpen. Dit systeem maakt het mogelijk om de basis layout van een webpagina in een los bestand op te slaan. Dit bestand wordt vanuit alle pagina’s gebruikt waardoor een wijziging in het template over de gehele applicatie te zien is.

Een template maken

Een simpel template ziet er zo uit. De twee <template:placeholder> tags geven aan welke plekken op de webpagina gevuld moeten worden door andere pagina’s. De tekst tussen de open- en sluittags is de standaardinhoud van een placeholder, deze wordt weergegeven als de placeholder niet gevuld is. Het aangeven van een standaardinhoud is niet verplicht.

Een template gebruiken

Een pagina die gebruik maakt van een template ziet er als volgt uit. Je ziet hier twee content tags die aangeven wat er op de plek van de placeholders uit het template moet komen. De pagina uit het voorbeeld maakt gebruik van het standaard template bestand, maar het is ook mogelijk om een ander bestand te gebruiken, dit doe je door het template attribuut toe te voegen aan de include tag. (B.V. <template:include template=”/WEB-INF/.jsp”>)

De standaard template pagina instellen

Het instellen van de standaard template pagina gebeurt in het web.xml bestand, het desbetreffende deel van dit bestand zie je hier.